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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com { module sun { module star { module text {
  23
  24 /** These constants define how the reference position is displayed in
  25     reference text fields.
  26
  27 */
  28 published constants ReferenceFieldPart
  29 {
  30     /** The page number is displayed using Arabic numbers.
  31     */
  32     const short PAGE = 0;
  33
  34     /** The number of the chapter is displayed.
  35     */
  36     const short CHAPTER = 1;
  37
  38     /** The reference text is displayed.
  39      <p>If the source of the reference is a sequence field, then the complete text
  40          of the paragraph is displayed. This is useful to reference to captions. </p>
  41     */
  42     const short TEXT = 2;
  43
  44     /** The reference is displayed as one of the (localized) words, "above" or "below".
  45     */
  46     const short UP_DOWN = 3;
  47
  48     /** The page number is displayed using the numbering type defined in
  49         the page style of the reference position.
  50     */
  51     const short PAGE_DESC = 4;
  52     /** The category and the number of a caption is displayed.
  53      <p>This option is only valid if the source of the reference is a sequence field.</p>
  54     */
  55     const short CATEGORY_AND_NUMBER = 5;
  56     /** The caption text of a caption is displayed.
  57      <p>This option is only valid if the source of the reference is a sequence field.</p>
  58     */
  59     const short ONLY_CAPTION = 6;
  60     /** The number of a sequence field is displayed.
  61      <p>This option is only valid if the source of the reference is a sequence field.</p>
  62     */
  63     const short ONLY_SEQUENCE_NUMBER = 7;
  64         /** The numbering label and depending of the reference field context numbering labels of
  65             superior list levels of the reference are displayed.
  66
  67             <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
  68             <p>The contents of the list label of the paragraph, at which the bookmark respectively the
  69             set reference starts - named "referenced item" in the following - is displayed. To unambiguous
  70             identify the referenced item at the document position of the reference text field, the content
  71             of all needed superior levels are added in front. The needed superior levels of the referenced
  72             item are the ones, which differ from the superior levels of the document position of the reference
  73             text field.
  74             Additional condition, which suppresses the addition of a superior level's list label content:
  75             The list label of the referenced item can already contain numbers of a superior levels. Assume X
  76             be the level of the most superior level, then no list label content of superior levels greater or
  77             equal than X are added.
  78             If the referenced item isn't numbered, nothing is displayed.</p>
  79
  80             @since OOo 3.0
  81         */
  82         const short NUMBER = 8;
  83         /** The numbering label of the reference is displayed.
  84
  85             <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
  86             <p>The contents of the list label of the paragraph, at which the bookmark respectively the
  87             set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p>
  88
  89             @since OOo 3.0
  90         */
  91         const short NUMBER_NO_CONTEXT = 9;
  92         /** The numbering label and numbering labels of superior list levels of the reference are displayed.
  93
  94             <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p>
  95             <p>The contents of the list label of the paragraph, at which the bookmark respectively the
  96             set reference starts - named "referenced item" in the following - is displayed and the contents
  97             of all list labels of superior levels are added in front of it.
  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 is numbered nothing is displayed.</p>
 103
 104             @since OOo 3.0
 105         */
 106         const short NUMBER_FULL_CONTEXT = 10;
 107 };
 108
 109
 110 }; }; }; };
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */