xref: /aoo4110/main/offapi/com/sun/star/text/NumberingRules.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_text_NumberingRules_idl__
#define __com_sun_star_text_NumberingRules_idl__

#ifndef __com_sun_star_container_XIndexReplace_idl__
#include <com/sun/star/container/XIndexReplace.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif


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

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

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

/** provides access to the numbering rules.
	<p> Numbering rules may be set at a <type>Paragraph</type> object.  The numbering rules are
	levels of property values. Each level contains equal properties.

	</p>
 */
published service NumberingRules
{
	/** provides access to the levels of the numbering rule.

				<p>The numbering rules are levels of property values. Each
				level contains equal properties.</p>
				@see NumberingLevel;@see NumberingLevel;
	 */
        interface com::sun::star::container::XIndexReplace;

	[optional] interface com::sun::star::beans::XPropertySet;
	//-------------------------------------------------------------------------

	/** determins if the margins are absolute or relative
		to the preceeding numbering level.
	 */
	[optional, property] boolean  IsAbsoluteMargins;
	//-------------------------------------------------------------------------

	/** determins if the numbering rules are automatically created
		as opposed to numbering rules that are part of a numbering style.
	 */
	[optional, property] boolean IsAutomatic;
	//-------------------------------------------------------------------------

	/** determins if the numbering levels are counted coninuously  or if
        each numbering level is counted separately.
	 */
	[optional, property] boolean IsContinuousNumbering;
	//-------------------------------------------------------------------------

	/** contains the name of the numbering rules. It is used to identify a certain
		numbering rules property
	 */
	[optional, readonly, property] string Name;
        //-------------------------------------------------------------------------

        /** This numbering is used in the outline of the document (e.g. headings).
         */
        [optional, property] boolean    NumberingIsOutline;
        //-------------------------------------------------------------------------

        /** the type of numbering (arabic, characters, roman numbers, etc.).
         */
        [optional, property] short    NumberingType;
        //-------------------------------------------------------------------------

        /** id of default list for the numbering rules instance
         */
        [optional, readonly, property] string DefaultListId;
        //-------------------------------------------------------------------------
};

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

}; }; }; };

#endif