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