1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_style_Style_idl__ 28#define __com_sun_star_style_Style_idl__ 29 30#ifndef __com_sun_star_style_XStyle_idl__ 31#include <com/sun/star/style/XStyle.idl> 32#endif 33 34#ifndef __com_sun_star_beans_XPropertySet_idl__ 35#include <com/sun/star/beans/XPropertySet.idl> 36#endif 37#ifndef __com_sun_star_beans_XMultiPropertySet_idl__ 38#include <com/sun/star/beans/XMultiPropertySet.idl> 39#endif 40#ifndef __com_sun_star_beans_XMultiPropertyStates_idl__ 41#include <com/sun/star/beans/XMultiPropertyStates.idl> 42#endif 43#ifndef __com_sun_star_beans_NamedValue_idl__ 44#include <com/sun/star/beans/NamedValue.idl> 45#endif 46#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_ 47#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> 48#endif 49 50 51//============================================================================= 52 53 module com { module sun { module star { module style { 54 55//============================================================================= 56 57/** This service specifies a single style sheet. 58 */ 59published service Style 60{ 61 //------------------------------------------------------------------------- 62 /** contains user defined attributes. 63 64 @see <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type> 65 */ 66 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; 67 68 //------------------------------------------------------------------------- 69 70 interface com::sun::star::style::XStyle; 71 72 interface com::sun::star::beans::XPropertySet; 73 74 [optional] interface com::sun::star::beans::XMultiPropertySet; 75 76 /* This optional interface is available as an optimisation, allowing users 77 to use 'setAllPropertiesToDefault', for example. */ 78 //------------------------------------------------------------------------- 79 80 [optional] interface com::sun::star::beans::XMultiPropertyStates; 81 82 //------------------------------------------------------------------------- 83 84 /** determines if a style is physically created. 85 86 <p> Built in styles may not be created until they are needed. 87 To prevent standard style properties from being exported, it may be 88 useful to check if the style is created first. 89 </p> 90 */ 91 [optional, readonly, property] boolean IsPhysical; 92 //------------------------------------------------------------------------- 93 94 /** contains the name of the style that is applied to the next paragraph. 95 96 <p> This property is usually available at paragraph styles only. </p> 97 */ 98 [optional, property] string FollowStyle; 99 //------------------------------------------------------------------------- 100 101 /** contains the name of the style as it is displayed in the user interface. 102 103 <p> The names of the styles at the API are language independent. The user interface 104 names are localised.</p> 105 */ 106 [optional, readonly, property] string DisplayName; 107 //------------------------------------------------------------------------- 108 109 /** determines if a style is automatically updated, if the properties of an object 110 that the style is applied to are changed. 111 112 <p> For example, if the style is applied to a paragraph and the properties of the paragraph 113 are changed then the style will be updated accordingly.</p> 114 */ 115 [optional, property] string IsAutoUpdate; 116 //------------------------------------------------------------------------- 117 118 /** defines the context and styles for conditional paragraphs. 119 120 <p>This property is only available if the style is a conditional 121 paragraph style.</p> 122 123 <p>The sequence consists of pairs where the name part of the pair 124 defines the context where it should be applied and the value part 125 is a string naming the style to be used in that context.</p> 126 127 <p>Assigning an empty string to the style name will disable 128 the conditional style for that context.</p> 129 130 <p>The alowed strings (contexts) for the name part of an entry 131 of the sequence are:</p> 132 133 <ul> 134 <li>TableHeader</li> 135 <li>Table</li> 136 <li>Frame</li> 137 <li>Section</li> 138 <li>Footnote</li> 139 <li>Endnote</li> 140 <li>Header</li> 141 <li>Footer</li> 142 <li>OutlineLevel1</li> 143 <li>OutlineLevel2</li> 144 <li>OutlineLevel3</li> 145 <li>OutlineLevel4</li> 146 <li>OutlineLevel5</li> 147 <li>OutlineLevel6</li> 148 <li>OutlineLevel7</li> 149 <li>OutlineLevel8</li> 150 <li>OutlineLevel9</li> 151 <li>OutlineLevel10</li> 152 <li>NumberingLevel1</li> 153 <li>NumberingLevel2</li> 154 <li>NumberingLevel3</li> 155 <li>NumberingLevel4</li> 156 <li>NumberingLevel5</li> 157 <li>NumberingLevel6</li> 158 <li>NumberingLevel7</li> 159 <li>NumberingLevel8</li> 160 <li>NumberingLevel9</li> 161 <li>NumberingLevel10</li> 162 </ul> 163 164 165 @since OOo 2.0.1 166 */ 167 [optional, property] sequence< com::sun::star::beans::NamedValue > ParaStyleConditions; 168 169}; 170 171//============================================================================= 172 173}; }; }; }; 174#endif 175