1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_style_Style_idl__ 24#define __com_sun_star_style_Style_idl__ 25 26#ifndef __com_sun_star_style_XStyle_idl__ 27#include <com/sun/star/style/XStyle.idl> 28#endif 29 30#ifndef __com_sun_star_beans_XPropertySet_idl__ 31#include <com/sun/star/beans/XPropertySet.idl> 32#endif 33#ifndef __com_sun_star_beans_XMultiPropertySet_idl__ 34#include <com/sun/star/beans/XMultiPropertySet.idl> 35#endif 36#ifndef __com_sun_star_beans_XMultiPropertyStates_idl__ 37#include <com/sun/star/beans/XMultiPropertyStates.idl> 38#endif 39#ifndef __com_sun_star_beans_NamedValue_idl__ 40#include <com/sun/star/beans/NamedValue.idl> 41#endif 42#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_ 43#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> 44#endif 45 46 47//============================================================================= 48 49 module com { module sun { module star { module style { 50 51//============================================================================= 52 53/** This service specifies a single style sheet. 54 */ 55published service Style 56{ 57 //------------------------------------------------------------------------- 58 /** contains user defined attributes. 59 60 @see <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type> 61 */ 62 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; 63 64 //------------------------------------------------------------------------- 65 66 interface com::sun::star::style::XStyle; 67 68 interface com::sun::star::beans::XPropertySet; 69 70 [optional] interface com::sun::star::beans::XMultiPropertySet; 71 72 /* This optional interface is available as an optimisation, allowing users 73 to use 'setAllPropertiesToDefault', for example. */ 74 //------------------------------------------------------------------------- 75 76 [optional] interface com::sun::star::beans::XMultiPropertyStates; 77 78 //------------------------------------------------------------------------- 79 80 /** determines if a style is physically created. 81 82 <p> Built in styles may not be created until they are needed. 83 To prevent standard style properties from being exported, it may be 84 useful to check if the style is created first. 85 </p> 86 */ 87 [optional, readonly, property] boolean IsPhysical; 88 //------------------------------------------------------------------------- 89 90 /** contains the name of the style that is applied to the next paragraph. 91 92 <p> This property is usually available at paragraph styles only. </p> 93 */ 94 [optional, property] string FollowStyle; 95 //------------------------------------------------------------------------- 96 97 /** contains the name of the style as it is displayed in the user interface. 98 99 <p> The names of the styles at the API are language independent. The user interface 100 names are localised.</p> 101 */ 102 [optional, readonly, property] string DisplayName; 103 //------------------------------------------------------------------------- 104 105 /** determines if a style is automatically updated, if the properties of an object 106 that the style is applied to are changed. 107 108 <p> For example, if the style is applied to a paragraph and the properties of the paragraph 109 are changed then the style will be updated accordingly.</p> 110 */ 111 [optional, property] string IsAutoUpdate; 112 //------------------------------------------------------------------------- 113 114 /** defines the context and styles for conditional paragraphs. 115 116 <p>This property is only available if the style is a conditional 117 paragraph style.</p> 118 119 <p>The sequence consists of pairs where the name part of the pair 120 defines the context where it should be applied and the value part 121 is a string naming the style to be used in that context.</p> 122 123 <p>Assigning an empty string to the style name will disable 124 the conditional style for that context.</p> 125 126 <p>The alowed strings (contexts) for the name part of an entry 127 of the sequence are:</p> 128 129 <ul> 130 <li>TableHeader</li> 131 <li>Table</li> 132 <li>Frame</li> 133 <li>Section</li> 134 <li>Footnote</li> 135 <li>Endnote</li> 136 <li>Header</li> 137 <li>Footer</li> 138 <li>OutlineLevel1</li> 139 <li>OutlineLevel2</li> 140 <li>OutlineLevel3</li> 141 <li>OutlineLevel4</li> 142 <li>OutlineLevel5</li> 143 <li>OutlineLevel6</li> 144 <li>OutlineLevel7</li> 145 <li>OutlineLevel8</li> 146 <li>OutlineLevel9</li> 147 <li>OutlineLevel10</li> 148 <li>NumberingLevel1</li> 149 <li>NumberingLevel2</li> 150 <li>NumberingLevel3</li> 151 <li>NumberingLevel4</li> 152 <li>NumberingLevel5</li> 153 <li>NumberingLevel6</li> 154 <li>NumberingLevel7</li> 155 <li>NumberingLevel8</li> 156 <li>NumberingLevel9</li> 157 <li>NumberingLevel10</li> 158 </ul> 159 160 161 @since OpenOffice 2.0.1 162 */ 163 [optional, property] sequence< com::sun::star::beans::NamedValue > ParaStyleConditions; 164 165}; 166 167//============================================================================= 168 169}; }; }; }; 170#endif 171