xref: /aoo4110/main/offapi/com/sun/star/text/ReferenceFieldPart.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_ReferenceFieldPart_idl__
#define __com_sun_star_text_ReferenceFieldPart_idl__


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

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

//=============================================================================
/** These constants define how the reference position is displayed in
	reference text fields.

*/
published constants ReferenceFieldPart
{
	//-------------------------------------------------------------------------
	/** The page number is displayed using arabic numbers.
	*/
	const short PAGE = 0;

	//-------------------------------------------------------------------------
	/** The number of the chapter is displayed.
	*/
	const short CHAPTER = 1;

	//-------------------------------------------------------------------------
	/** The reference text is displayed.
	 <p>If the source of the reference is a sequence field, then the complete text
	 	of the paragraph is displayed. This is useful to reference to captions. </p>
	*/
	const short TEXT = 2;

	//-------------------------------------------------------------------------
	/** The reference is displayed as one of the (localized) words, "above" or "below".
	*/
	const short UP_DOWN = 3;

	//-------------------------------------------------------------------------
	/** The page number is displayed using the numbering type defined in
		the page style of the reference position.
	*/
	const short PAGE_DESC = 4;
	//-------------------------------------------------------------------------
	/** The category and the number of a caption is displayed.
	 <p>This option is only valid if the source of the reference is a sequence field.</p>
	*/
	const short CATEGORY_AND_NUMBER = 5;
	//-------------------------------------------------------------------------
	/** The caption text of a caption is displayed.
	 <p>This option is only valid if the source of the reference is a sequence field.</p>
	*/
	const short ONLY_CAPTION = 6;
	//-------------------------------------------------------------------------
	/** The number of a sequence field is displayed.
	 <p>This option is only valid if the source of the reference is a sequence field.</p>
	*/
	const short ONLY_SEQUENCE_NUMBER = 7;
        //-------------------------------------------------------------------------
        /** The numbering label and depending of the reference field context numbering lables of
            superior list levels of the reference are displayed.

            <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
            <p>The contents of the list label of the paragraph, at which the bookmark respectively the
            set reference starts - named "referenced item" in the following - is displayed. To unambiguous
            identify the referenced item at the document position of the reference text field, the content
            of all needed superior levels are added in front. The needed superior levels of the referenced
            item are the ones, which differ from the superior levels of the document position of the reference
            text field.
            Additional condition, which suppresses the addition of a superior level's list label content:
            The list label of the referenced item can already contain numbers of a superior levels. Assume X
            be the level of the most superior level, then no list label content of superior levels greater or
            equal than X are added.
            If the referenced item isn't numbered, nothing is displayed.</p>

            @since OpenOffice 3.0
        */
        const short NUMBER = 8;
        //-------------------------------------------------------------------------
        /** The numbering label of the reference is displayed.

            <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
            <p>The contents of the list label of the paragraph, at which the bookmark respectively the
            set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p>

            @since OpenOffice 3.0
        */
        const short NUMBER_NO_CONTEXT = 9;
        //-------------------------------------------------------------------------
        /** The numbering label and numbering lables of superior list levels of the reference are displayed.

            <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
            <p>The contents of the list label of the paragraph, at which the bookmark respectively the
            set reference starts - named "referenced item" in the following - is displayed and the contents
            of all list labels of superior levels are added in front of it.
            Additional condition, which suppresses the addition of a superior level's list label content:
            The list label of the referenced item can already contain numbers of a superior levels. Assume X
            be the level of the most superior level, then no list label content of superior levels greater or
            equal than X are added.
            If the referenced item is numbered nothing is displayed.</p>

            @since OpenOffice 3.0
        */
        const short NUMBER_FULL_CONTEXT = 10;
};

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

}; }; }; };

#endif