1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
22 module com
{ module sun
{ module star
{ module style
{
25 /** This service specifies a single style sheet.
27 published service Style
29 /** contains user defined attributes.
31 @see com::sun::star::xml::UserDefinedAttributesSupplier
33 [optional] service com
::sun
::star
::xml
::UserDefinedAttributesSupplier
;
36 interface com
::sun
::star
::style
::XStyle
;
38 interface com
::sun
::star
::beans
::XPropertySet
;
40 [optional] interface com
::sun
::star
::beans
::XMultiPropertySet
;
42 /* This optional interface is available as an optimization, allowing users
43 to use "setAllPropertiesToDefault", for example. */
45 [optional] interface com
::sun
::star
::beans
::XMultiPropertyStates
;
48 /** determines if a style is physically created.
50 <p> Built in styles may not be created until they are needed.
51 To prevent standard style properties from being exported, it may be
52 useful to check if the style is created first.
55 [optional, readonly, property
] boolean IsPhysical
;
57 /** contains the name of the style that is applied to the next paragraph.
59 <p> This property is usually available at paragraph styles only. </p>
61 [optional, property
] string FollowStyle
;
63 /** contains the name of the style as it is displayed in the user interface.
65 <p> The names of the styles at the API are language independent. The user interface
66 names are localized.</p>
68 [optional, readonly, property
] string DisplayName
;
70 /** determines if a style is automatically updated, if the properties of an object
71 that the style is applied to are changed.
73 <p> For example, if the style is applied to a paragraph and the properties of the paragraph
74 are changed then the style will be updated accordingly.</p>
76 [optional, property
] string IsAutoUpdate
;
78 /** defines the context and styles for conditional paragraphs.
80 <p>This property is only available if the style is a conditional
83 <p>The sequence consists of pairs where the name part of the pair
84 defines the context where it should be applied and the value part
85 is a string naming the style to be used in that context.</p>
87 <p>Assigning an empty string to the style name will disable
88 the conditional style for that context.</p>
90 <p>The allowed strings (contexts) for the name part of an entry
91 of the sequence are:</p>
102 <li>OutlineLevel1</li>
103 <li>OutlineLevel2</li>
104 <li>OutlineLevel3</li>
105 <li>OutlineLevel4</li>
106 <li>OutlineLevel5</li>
107 <li>OutlineLevel6</li>
108 <li>OutlineLevel7</li>
109 <li>OutlineLevel8</li>
110 <li>OutlineLevel9</li>
111 <li>OutlineLevel10</li>
112 <li>NumberingLevel1</li>
113 <li>NumberingLevel2</li>
114 <li>NumberingLevel3</li>
115 <li>NumberingLevel4</li>
116 <li>NumberingLevel5</li>
117 <li>NumberingLevel6</li>
118 <li>NumberingLevel7</li>
119 <li>NumberingLevel8</li>
120 <li>NumberingLevel9</li>
121 <li>NumberingLevel10</li>
127 [optional, property
] sequence
< com
::sun
::star
::beans
::NamedValue
> ParaStyleConditions
;
129 /** Flag indicating whether to hide the style in the UI.
130 @since LibreOffice 4.0
132 [optional, property
] boolean Hidden;
134 /** Grab bag of style properties, used as a string-any map for interim interop purposes.
136 @since LibreOffice 4.2
138 <p>This property is intentionally not handled by the ODF filter. Any
139 member that should be handled there should be first moved out from this grab
140 bag to a separate property.</p>
142 [optional, property
] sequence
<com
::sun
::star
::beans
::PropertyValue
> StyleInteropGrabBag
;
148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */