/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: FootnoteSettings.idl,v $
 * $Revision: 1.11 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_FootnoteSettings_idl__
#define __com_sun_star_text_FootnoteSettings_idl__


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

/** provides access to the settings of footnotes or endnotes in a
    (text) document.
 */
published service FootnoteSettings
{
    //-------------------------------------------------------------------------

    /** contains the name of the character style that is used
            for the label in front of the footnote/endnote text.
     */
    [property] string CharStyleName;

    //-------------------------------------------------------------------------

    /** contains the numbering type for the numbering of the
        footnotes/endnotes.
     */
    [property] short NumberingType;

    //-------------------------------------------------------------------------

    /** contains the page style that is used for the page that
            contains the footnote/endnote texts
     */
    [property] string PageStyleName;

    //-------------------------------------------------------------------------

    /** contains the paragraph style that is used for the
            footnote/endnote text.
     */
    [property] string ParaStyleName;

    //-------------------------------------------------------------------------

    /** contains the prefix for the footnote/endnote symbol.
     */
    [property] string Prefix;

    //-------------------------------------------------------------------------

    /** contains the first number of the automatic numbering
        of footnotes/endnotes.
     */
    [property] short StartAt;

    //-------------------------------------------------------------------------

    /** contains the suffix for the footnote/endnote symbol.
     */
    [property] string Suffix;

    //-------------------------------------------------------------------------

    /** contains the string at the restart of the footnote
        text after a break.

        <p>For footnotes only.</p>
     */
    [optional, property] string BeginNotice;

    //-------------------------------------------------------------------------

    /** contains the string at the end of a footnote part in
        front of a break.

        <p>For footnotes only.</p>
     */
    [optional, property] string EndNotice;

    //-------------------------------------------------------------------------

    /** contains the type of the counting of the footnote numbers.

        <p>For footnotes only.</p>
        @see FootnoteNumbering
     */
    [optional, property] short FootnoteCounting;

    //-------------------------------------------------------------------------

    /** If <TRUE/>, the footnote text is shown at the end of the document.

        <p>For footnotes only.</p>
     */
    [optional, property] boolean PositionEndOfDoc;

    //-------------------------------------------------------------------------

    /** contains the name of the character style that is used
        for footnote/endnote anchor in the text.

        @since OOo 2.0.0
     */
    [optional, property] string AnchorCharStyleName;

};

//=============================================================================

}; }; }; };

#endif