1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_text_ReferenceFieldPart_idl__ 24cdf0e10cSrcweir#define __com_sun_star_text_ReferenceFieldPart_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir 27cdf0e10cSrcweir//============================================================================= 28cdf0e10cSrcweir 29cdf0e10cSrcweirmodule com { module sun { module star { module text { 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir/** These constants define how the reference position is displayed in 33cdf0e10cSrcweir reference text fields. 34cdf0e10cSrcweir 35cdf0e10cSrcweir*/ 36cdf0e10cSrcweirpublished constants ReferenceFieldPart 37cdf0e10cSrcweir{ 38cdf0e10cSrcweir //------------------------------------------------------------------------- 39cdf0e10cSrcweir /** The page number is displayed using arabic numbers. 40cdf0e10cSrcweir */ 41cdf0e10cSrcweir const short PAGE = 0; 42cdf0e10cSrcweir 43cdf0e10cSrcweir //------------------------------------------------------------------------- 44cdf0e10cSrcweir /** The number of the chapter is displayed. 45cdf0e10cSrcweir */ 46cdf0e10cSrcweir const short CHAPTER = 1; 47cdf0e10cSrcweir 48cdf0e10cSrcweir //------------------------------------------------------------------------- 49cdf0e10cSrcweir /** The reference text is displayed. 50cdf0e10cSrcweir <p>If the source of the reference is a sequence field, then the complete text 51cdf0e10cSrcweir of the paragraph is displayed. This is useful to reference to captions. </p> 52cdf0e10cSrcweir */ 53cdf0e10cSrcweir const short TEXT = 2; 54cdf0e10cSrcweir 55cdf0e10cSrcweir //------------------------------------------------------------------------- 56cdf0e10cSrcweir /** The reference is displayed as one of the (localized) words, "above" or "below". 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir const short UP_DOWN = 3; 59cdf0e10cSrcweir 60cdf0e10cSrcweir //------------------------------------------------------------------------- 61cdf0e10cSrcweir /** The page number is displayed using the numbering type defined in 62cdf0e10cSrcweir the page style of the reference position. 63cdf0e10cSrcweir */ 64cdf0e10cSrcweir const short PAGE_DESC = 4; 65cdf0e10cSrcweir //------------------------------------------------------------------------- 66cdf0e10cSrcweir /** The category and the number of a caption is displayed. 67cdf0e10cSrcweir <p>This option is only valid if the source of the reference is a sequence field.</p> 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir const short CATEGORY_AND_NUMBER = 5; 70cdf0e10cSrcweir //------------------------------------------------------------------------- 71cdf0e10cSrcweir /** The caption text of a caption is displayed. 72cdf0e10cSrcweir <p>This option is only valid if the source of the reference is a sequence field.</p> 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir const short ONLY_CAPTION = 6; 75cdf0e10cSrcweir //------------------------------------------------------------------------- 76cdf0e10cSrcweir /** The number of a sequence field is displayed. 77cdf0e10cSrcweir <p>This option is only valid if the source of the reference is a sequence field.</p> 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir const short ONLY_SEQUENCE_NUMBER = 7; 80cdf0e10cSrcweir //------------------------------------------------------------------------- 81cdf0e10cSrcweir /** The numbering label and depending of the reference field context numbering lables of 82cdf0e10cSrcweir superior list levels of the reference are displayed. 83cdf0e10cSrcweir 84cdf0e10cSrcweir <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p> 85cdf0e10cSrcweir <p>The contents of the list label of the paragraph, at which the bookmark respectively the 86cdf0e10cSrcweir set reference starts - named "referenced item" in the following - is displayed. To unambiguous 87cdf0e10cSrcweir identify the referenced item at the document position of the reference text field, the content 88cdf0e10cSrcweir of all needed superior levels are added in front. The needed superior levels of the referenced 89cdf0e10cSrcweir item are the ones, which differ from the superior levels of the document position of the reference 90cdf0e10cSrcweir text field. 91cdf0e10cSrcweir Additional condition, which suppresses the addition of a superior level's list label content: 92cdf0e10cSrcweir The list label of the referenced item can already contain numbers of a superior levels. Assume X 93cdf0e10cSrcweir be the level of the most superior level, then no list label content of superior levels greater or 94cdf0e10cSrcweir equal than X are added. 95cdf0e10cSrcweir If the referenced item isn't numbered, nothing is displayed.</p> 96cdf0e10cSrcweir 97*2a413f17SJürgen Schmidt @since OpenOffice 3.0 98cdf0e10cSrcweir */ 99cdf0e10cSrcweir const short NUMBER = 8; 100cdf0e10cSrcweir //------------------------------------------------------------------------- 101cdf0e10cSrcweir /** The numbering label of the reference is displayed. 102cdf0e10cSrcweir 103cdf0e10cSrcweir <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p> 104cdf0e10cSrcweir <p>The contents of the list label of the paragraph, at which the bookmark respectively the 105cdf0e10cSrcweir set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p> 106cdf0e10cSrcweir 107*2a413f17SJürgen Schmidt @since OpenOffice 3.0 108cdf0e10cSrcweir */ 109cdf0e10cSrcweir const short NUMBER_NO_CONTEXT = 9; 110cdf0e10cSrcweir //------------------------------------------------------------------------- 111cdf0e10cSrcweir /** The numbering label and numbering lables of superior list levels of the reference are displayed. 112cdf0e10cSrcweir 113cdf0e10cSrcweir <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p> 114cdf0e10cSrcweir <p>The contents of the list label of the paragraph, at which the bookmark respectively the 115cdf0e10cSrcweir set reference starts - named "referenced item" in the following - is displayed and the contents 116cdf0e10cSrcweir of all list labels of superior levels are added in front of it. 117cdf0e10cSrcweir Additional condition, which suppresses the addition of a superior level's list label content: 118cdf0e10cSrcweir The list label of the referenced item can already contain numbers of a superior levels. Assume X 119cdf0e10cSrcweir be the level of the most superior level, then no list label content of superior levels greater or 120cdf0e10cSrcweir equal than X are added. 121cdf0e10cSrcweir If the referenced item is numbered nothing is displayed.</p> 122cdf0e10cSrcweir 123*2a413f17SJürgen Schmidt @since OpenOffice 3.0 124cdf0e10cSrcweir */ 125cdf0e10cSrcweir const short NUMBER_FULL_CONTEXT = 10; 126cdf0e10cSrcweir}; 127cdf0e10cSrcweir 128cdf0e10cSrcweir//============================================================================= 129cdf0e10cSrcweir 130cdf0e10cSrcweir}; }; }; }; 131cdf0e10cSrcweir 132cdf0e10cSrcweir#endif 133