/*************************************************************************
 *
 *  $RCSfile: FootnoteSettings.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: mi $ $Date: 2000/12/14 12:53:44 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_text_FootnoteSettings_idl__
#define __com_sun_star_text_FootnoteSettings_idl__


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

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

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

// DocMerge from xml: service com::sun::star::text::FootnoteSettings
/** provides access to the settings of footnotes or endnotes in a
	(text) document.
 */
service FootnoteSettings
{
	//-------------------------------------------------------------------------

	// DocMerge from idl: property com::sun::star::text::FootnoteSettings::CharStyleName
	/** contains the name of the character style that is used
			for the label in front of the footnote/endnote text.
	 */
	[property] string CharStyleName;

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::NumberingType
	/** contains the numbering type for the numbering of the
		footnotes/endnotes.
	 */
	[property] short NumberingType;

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

	// DocMerge from idl: property com::sun::star::text::FootnoteSettings::PageStyleName
	/** contains the page style that is used for the page that
			contains the footnote/endnote texts
	 */
	[property] string PageStyleName;

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

	// DocMerge from idl: property com::sun::star::text::FootnoteSettings::ParaStyleName
	/** contains the paragraph style that is used for the
			footnote/endnote text.
	 */
	[property] string ParaStyleName;

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::Prefix
	/** contains the prefix for the footnote/endnote symbol.
	 */
	[property] string Prefix;

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::StartAt
	/** contains the first number of the automatic numbering
		of footnotes/endnotes.
	 */
	[property] short StartAt;

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::Suffix
	/** contains the suffix for the footnote/endnote symbol.
	 */
	[property] string Suffix;

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::BeginNotice
	/** contains the string at the restart of the footnote
		text after a break.



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

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::EndNotice
	/** contains the string at the end of a footnote part in
		front of a break.



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

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::FootnoteCounting
	/** contains the type of the counting of the footnote numbers.



		<p>For footnotes only.

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

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

	// DocMerge from xml: property com::sun::star::text::FootnoteSettings::PositionEndOfDoc
	/** If <TRUE/>, the footnote text is shown at the end of the document.



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

};

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

}; }; }; };

/*=============================================================================

	$Log: FootnoteSettings.idl,v $
	Revision 1.4  2000/12/14 12:53:44  mi
	<true></true> -> <TRUE/> and same with FALSE
	
	Revision 1.3  2000/11/08 12:44:26  mi
	moved from api
	
	Revision 1.2  2000/09/22 07:33:05  os
	#77644# ParagraphStyleName->ParaStyleName
	
	Revision 1.1.1.1  2000/09/18 23:36:01  hjs
	initial import

	Revision 1.6  2000/09/11 11:52:59  mi
	documentation merged from XML

	Revision 1.4  2000/08/15 15:32:45  os
	#77644# optional parameters and names corrected

	Revision 1.3  2000/02/21 16:18:14  mi
	string documentation from stardiv...*.idl-files

	Revision 1.2  2000/02/07 11:25:01  mi
	zu #70728# missing documentation marked

	Revision 1.1.1.1  1999/11/11 09:48:46  jsc
	new


=============================================================================*/
#endif
