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