offapi/com/sun/star/text/NumberingLevel.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  module com {  module sun {  module star {  module text {
  22
  23
  24 /** provides access to a numbering level as part of the Numbering Rules.
  25  */
  26 published service NumberingLevel
  27 {
  28
  29     /** adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)
  30
  31         <p>
  32         </p>
  33      */
  34     [property] short Adjust;
  35
  36
  37     /** number of upper levels that are included in the current numbering symbol.
  38      */
  39     [optional, property] short ParentNumbering;
  40
  41
  42     /** the prefix of the numbering symbol.
  43      */
  44     [property] string Prefix;
  45
  46
  47     /** the suffix of the numbering symbol.
  48      */
  49     [property] string Suffix;
  50
  51
  52     /** Name of the character style that is used for the numbering symbol.
  53      */
  54     [optional, property] string CharStyleName;
  55
  56
  57     /** the ID of the symbol in the given font. This is only valid if the
  58         numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL.
  59           @deprecated
  60      */
  61     [optional, property] short BulletId;
  62
  63     /** contains the symbol in the given font. This is only valid if the
  64         numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL.
  65      */
  66     [property] string BulletChar;
  67
  68     /** the name of the font for the symbol. This is only valid if the
  69         numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL.
  70      */
  71     [property] string BulletFontName;
  72
  73
  74     /** the font used to paint the bullet.
  75      */
  76     [optional, property] com::sun::star::awt::FontDescriptor BulletFont;
  77
  78
  79     /** the URL of the graphic file that is used as the numbering symbol.
  80
  81         <p> This is only valid if the numbering type is
  82         com::sun::star::style::NumberingType::BITMAP.</p>
  83
  84         @deprecated as of LibreOffice 6.1, use GraphicBitmap
  85
  86         Note the new behaviour since it this was deprecated:
  87         This property can only be set and only external URLs are
  88         supported (no more vnd.sun.star.GraphicObject scheme). When an
  89         URL is set, then it will load the bitmap and set the GraphicBitmap
  90         property.
  91      */
  92     [property] string GraphicURL;
  93
  94
  95     /** the graphic file that is used as the numbering symbol.
  96
  97         <p> This is only valid if the numbering type is
  98         com::sun::star::style::NumberingType::BITMAP.</p>
  99      */
 100     [optional, property] com::sun::star::awt::XBitmap GraphicBitmap;
 101
 102
 103     /** size of the graphic that is used as bullet.
 104      */
 105     [optional, property] com::sun::star::awt::Size    GraphicSize;
 106
 107
 108     /** contains the vertical orientation of a graphic.
 109
 110         <p> It is set using com::sun::star::text::VertOrientation.</p>
 111      */
 112     [optional, property] short VertOrient;
 113
 114     /** specifies the start value for the numbering.
 115
 116         <p>This property is only valid if the numbering type is not
 117         com::sun::star::style::NumberingType::BITMAP or
 118         com::sun::star::style::NumberingType::CHAR_SPECIAL.</p>
 119      */
 120     [optional, property] short StartWith;
 121
 122
 123     /** specifies the left margin of the numbering
 124      */
 125     [property] long LeftMargin;
 126
 127
 128     /** specifies the distance between the numbering symbol and the text of
 129         the paragraph.
 130      */
 131     [optional, property] long SymbolTextDistance;
 132
 133
 134     /** specifies the offset between the beginning of the first line and
 135         the beginning of the following lines of the paragraph.
 136      */
 137     [property] long FirstLineOffset;
 138
 139
 140     /** specifies the type of numbering. @see com::sun::star::style::NumberingType
 141      */
 142     [property] short NumberingType;
 143
 144
 145     /** contains the name of the paragraph style that is interpreted as the
 146         header of this level. It is only contained in the levels of
 147         chapter numbering rules.
 148      */
 149     [property] string HeadingStyleName;
 150
 151     /** contains the name of the paragraph style that should use this numbering.
 152         This is ignored for chapter numbering rules, use HeadingStyleName.
 153
 154         @since LibreOffice 3.6
 155      */
 156     [optional, property] string ParagraphStyleName;
 157
 158     /** contains the color for the symbol. This is only valid if the
 159         numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL.
 160     */
 161     [optional, property] com::sun::star::util::Color BulletColor;
 162
 163     /** contains the size of the symbol relative to the high of the paragraph. This is only valid if the
 164         numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL.
 165     */
 166     [optional, property] short BulletRelSize;
 167
 168         /** position and space mode
 169
 170                 <p>
 171                 Specifies the position and space mode of the numbering level.
 172                 For valid values see com::sun::star::text::PositionAndSpaceMode.
 173                 If it equals LABEL_WIDTH_AND_POSITION, properties Adjust,
 174                 LeftMargin, SymbolTextDistance and FirstLineOffset are used.
 175                 If it equals LABEL_ALIGNMENT, properties Adjust, LabelFollowedBy,
 176                 ListtabStopPosition, FirstLineIndent, IndentAt are used.
 177                 </p>
 178
 179                 @since OOo 3.0
 180         */
 181         [optional, property] short PositionAndSpaceMode;
 182
 183         /** character following the list label
 184
 185                 <p>
 186                 Specifies the character following the list label.
 187                 For valid values see com::sun::star::text::LabelFollow.
 188                 Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
 189                 </p>
 190
 191                 @since OOo 3.0
 192         */
 193         [optional, property] short LabelFollowedBy;
 194
 195         /** list tab position
 196
 197                 <p>
 198                 Specifies the position of the list tab stop - only non-negative
 199                 values are allowed.
 200                 Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT
 201                 and LabelFollowedBy equal LABELFOLLOW_LISTTAB
 202                 </p>
 203
 204                 @since OOo 3.0
 205         */
 206         [optional, property] long ListtabStopPosition;
 207
 208         /** additional line indent for the first text line
 209
 210                 <p>
 211                 Specifies the first line indent.
 212                 Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
 213                 </p>
 214
 215                 @since OOo 3.0
 216         */
 217         [optional, property] long FirstLineIndent;
 218
 219         /** indentation of the text lines
 220
 221                 <p>
 222                 Specifies the indent of the text lines
 223                 Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT.
 224                 </p>
 225
 226                 @since OOo 3.0
 227         */
 228         [optional, property] long IndentAt;
 229 };
 230
 231
 232 }; }; }; };
 233
 234 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */