offapi/com/sun/star/text/ReferenceFieldPart.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ReferenceFieldPart.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_ReferenceFieldPart_idl__
  31 #define __com_sun_star_text_ReferenceFieldPart_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module text {
  37
  38 //=============================================================================
  39 /** These constants define how the reference position is displayed in
  40     reference text fields.
  41
  42 */
  43 published constants ReferenceFieldPart
  44 {
  45     //-------------------------------------------------------------------------
  46     /** The page number is displayed using arabic numbers.
  47     */
  48     const short PAGE = 0;
  49
  50     //-------------------------------------------------------------------------
  51     /** The number of the chapter is displayed.
  52     */
  53     const short CHAPTER = 1;
  54
  55     //-------------------------------------------------------------------------
  56     /** The reference text is displayed.
  57      <p>If the source of the reference is a sequence field, then the complete text
  58          of the paragraph is displayed. This is useful to reference to captions. </p>
  59     */
  60     const short TEXT = 2;
  61
  62     //-------------------------------------------------------------------------
  63     /** The reference is displayed as one of the (localized) words, "above" or "below".
  64     */
  65     const short UP_DOWN = 3;
  66
  67     //-------------------------------------------------------------------------
  68     /** The page number is displayed using the numbering type defined in
  69         the page style of the reference position.
  70     */
  71     const short PAGE_DESC = 4;
  72     //-------------------------------------------------------------------------
  73     /** The category and the number of a caption is displayed.
  74      <p>This option is only valid if the source of the reference is a sequence field.</p>
  75     */
  76     const short CATEGORY_AND_NUMBER = 5;
  77     //-------------------------------------------------------------------------
  78     /** The caption text of a caption is displayed.
  79      <p>This option is only valid if the source of the reference is a sequence field.</p>
  80     */
  81     const short ONLY_CAPTION = 6;
  82     //-------------------------------------------------------------------------
  83     /** The number of a sequence field is displayed.
  84      <p>This option is only valid if the source of the reference is a sequence field.</p>
  85     */
  86     const short ONLY_SEQUENCE_NUMBER = 7;
  87         //-------------------------------------------------------------------------
  88         /** The numbering label and depending of the reference field context numbering lables of
  89             superior list levels of the reference are displayed.
  90
  91             <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
  92             <p>The contents of the list label of the paragraph, at which the bookmark respectively the
  93             set reference starts - named "referenced item" in the following - is displayed. To unambiguous
  94             identify the referenced item at the document position of the reference text field, the content
  95             of all needed superior levels are added in front. The needed superior levels of the referenced
  96             item are the ones, which differ from the superior levels of the document position of the reference
  97             text field.
  98             Additional condition, which suppresses the addition of a superior level's list label content:
  99             The list label of the referenced item can already contain numbers of a superior levels. Assume X
 100             be the level of the most superior level, then no list label content of superior levels greater or
 101             equal than X are added.
 102             If the referenced item isn't numbered, nothing is displayed.</p>
 103
 104             @since OOo 3.0
 105         */
 106         const short NUMBER = 8;
 107         //-------------------------------------------------------------------------
 108         /** The numbering label of the reference is displayed.
 109
 110             <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
 111             <p>The contents of the list label of the paragraph, at which the bookmark respectively the
 112             set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p>
 113
 114             @since OOo 3.0
 115         */
 116         const short NUMBER_NO_CONTEXT = 9;
 117         //-------------------------------------------------------------------------
 118         /** The numbering label and numbering lables of superior list levels of the reference are displayed.
 119
 120             <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
 121             <p>The contents of the list label of the paragraph, at which the bookmark respectively the
 122             set reference starts - named "referenced item" in the following - is displayed and the contents
 123             of all list labels of superior levels are added in front of it.
 124             Additional condition, which suppresses the addition of a superior level's list label content:
 125             The list label of the referenced item can already contain numbers of a superior levels. Assume X
 126             be the level of the most superior level, then no list label content of superior levels greater or
 127             equal than X are added.
 128             If the referenced item is numbered nothing is displayed.</p>
 129
 130             @since OOo 3.0
 131         */
 132         const short NUMBER_FULL_CONTEXT = 10;
 133 };
 134
 135 //=============================================================================
 136
 137 }; }; }; };
 138
 139 #endif