offapi/com/sun/star/style/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  module com {  module sun {  module star {  module style {
  21
  22 /** These properties describe the numbering of a paragraph.
  23
  24     <p>NumberType determines the type of the numbering symbol.
  25     Depending on this setting, some of the following values will be
  26     ignored.</p>
  27  */
  28 published service NumberingLevel
  29 {
  30     /** specifies the type of numbering.@see NumberingType
  31      */
  32     [property] short NumberingType;
  33
  34     /** specifies the number of higher numbering levels that
  35         are included in the representation of the current number.
  36      */
  37     [property] short ParentNumbering;
  38
  39     /** This prefix is inserted in front of the numbering symbol(s).
  40
  41         @deprecated as of LibreOffice 7.2, use ListFormat instead
  42      */
  43     [property] string Prefix;
  44
  45     /** This suffix is inserted after the numbering symbol(s).
  46
  47         @deprecated as of LibreOffice 7.2, use ListFormat instead
  48      */
  49     [property] string Suffix;
  50
  51     /** This is the name of the character style that is used for the symbol(s).
  52      */
  53     [property] string CharStyleName;
  54
  55     /** The bullet symbol with this code in the assigned font is used.
  56      */
  57     [property] short BulletId;
  58
  59     /** This is the name of the font that is used for the bullet.
  60      */
  61     [property] string BulletFontName;
  62
  63     /** This is the URL of a graphic file to use as a symbol.
  64
  65         @deprecated as of LibreOffice 6.1, use Graphic instead
  66
  67         Note the new behaviour since it this was deprecated:
  68         This property can only be set and only external URLs are
  69         supported (no more vnd.sun.star.GraphicObject scheme). When an
  70         URL is set, then it will load the graphic and set the
  71         GraphicBitmap property.
  72      */
  73     [property] string GraphicURL;
  74
  75     /** This specifies the start value for the numbering.
  76      */
  77     [property] short StartWith;
  78
  79     /** This is the graphic bitmap to use as a symbol.
  80
  81         @since LibreOffice 6.1
  82      */
  83     [optional, property] com::sun::star::awt::XBitmap GraphicBitmap;
  84
  85     /** Format string used to generate actual numbering.
  86
  87         It contains placeholders (like %1%, %2%, etc) where corresponding
  88         level numberings are inserted.
  89
  90         This is more flexible way to provide multilevel numbering with
  91         complex format string. This property is a replacement for
  92         Prefix and Suffix: if ListFormat is provided, they are not used
  93         anymore.
  94
  95         Example: ListFormat "(%1% %2%.%3%)" can be resolved to numbering
  96         in actual multilevel list like "(4 1.3)".
  97
  98         @since LibreOffice 7.2
  99      */
 100     [optional, property] string ListFormat;
 101
 102     /** Specifies if this level should use Arabic numbers for all levels
 103
 104         @since LibreOffice 24.2
 105      */
 106     [optional, property] boolean IsLegal;
 107 };
 108
 109
 110 }; }; }; };
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */