offapi/com/sun/star/style/Style.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: Style.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 #ifndef __com_sun_star_style_Style_idl__
  31 #define __com_sun_star_style_Style_idl__
  32
  33 #ifndef __com_sun_star_style_XStyle_idl__
  34 #include <com/sun/star/style/XStyle.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40 #ifndef __com_sun_star_beans_XMultiPropertySet_idl__
  41 #include <com/sun/star/beans/XMultiPropertySet.idl>
  42 #endif
  43 #ifndef __com_sun_star_beans_XMultiPropertyStates_idl__
  44 #include <com/sun/star/beans/XMultiPropertyStates.idl>
  45 #endif
  46 #ifndef __com_sun_star_beans_NamedValue_idl__
  47 #include <com/sun/star/beans/NamedValue.idl>
  48 #endif
  49 #ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  50 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module style {
  57
  58 //=============================================================================
  59
  60 /** This service specifies a single style sheet.
  61  */
  62 published service Style
  63 {
  64     //-------------------------------------------------------------------------
  65     /** contains user defined attributes.
  66
  67         @see    <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type>
  68      */
  69     [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
  70
  71     //-------------------------------------------------------------------------
  72
  73     interface com::sun::star::style::XStyle;
  74
  75         interface com::sun::star::beans::XPropertySet;
  76
  77         [optional] interface com::sun::star::beans::XMultiPropertySet;
  78
  79     /* This optional interface is available as an optimisation, allowing users
  80        to use 'setAllPropertiesToDefault', for example. */
  81     //-------------------------------------------------------------------------
  82
  83     [optional] interface com::sun::star::beans::XMultiPropertyStates;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** determines if a style is physically created.
  88
  89         <p> Built in styles may not be created until they are needed.
  90         To prevent standard style properties from being exported, it may be
  91         useful to check if the style is created first.
  92         </p>
  93      */
  94     [optional, readonly, property] boolean IsPhysical;
  95     //-------------------------------------------------------------------------
  96
  97     /** contains the name of the style that is applied to the next paragraph.
  98
  99         <p> This property is usually available at paragraph styles only. </p>
 100      */
 101     [optional, property] string FollowStyle;
 102     //-------------------------------------------------------------------------
 103
 104     /** contains the name of the style as it is displayed in the user interface.
 105
 106         <p> The names of the styles at the API are language independent. The user interface
 107         names are localised.</p>
 108      */
 109     [optional, readonly, property] string DisplayName;
 110     //-------------------------------------------------------------------------
 111
 112     /** determines if a style is automatically updated, if the properties of an object
 113         that the style is applied to are changed.
 114
 115         <p> For example, if the style is applied to a paragraph and the properties of the paragraph
 116         are changed then the style will be updated accordingly.</p>
 117      */
 118     [optional, property] string IsAutoUpdate;
 119     //-------------------------------------------------------------------------
 120
 121     /** defines the context and styles for conditional paragraphs.
 122
 123         <p>This property is only available if the style is a conditional
 124         paragraph style.</p>
 125
 126         <p>The sequence consists of pairs where the name part of the pair
 127         defines the context where it should be applied and the value part
 128         is a string naming the style to be used in that context.</p>
 129
 130         <p>Assigning an empty string to the style name will disable
 131         the conditional style for that context.</p>
 132
 133         <p>The alowed strings (contexts) for the name part of an entry
 134         of the sequence are:</p>
 135
 136         <ul>
 137             <li>TableHeader</li>
 138             <li>Table</li>
 139             <li>Frame</li>
 140             <li>Section</li>
 141             <li>Footnote</li>
 142             <li>Endnote</li>
 143             <li>Header</li>
 144             <li>Footer</li>
 145             <li>OutlineLevel1</li>
 146             <li>OutlineLevel2</li>
 147             <li>OutlineLevel3</li>
 148             <li>OutlineLevel4</li>
 149             <li>OutlineLevel5</li>
 150             <li>OutlineLevel6</li>
 151             <li>OutlineLevel7</li>
 152             <li>OutlineLevel8</li>
 153             <li>OutlineLevel9</li>
 154             <li>OutlineLevel10</li>
 155             <li>NumberingLevel1</li>
 156             <li>NumberingLevel2</li>
 157             <li>NumberingLevel3</li>
 158             <li>NumberingLevel4</li>
 159             <li>NumberingLevel5</li>
 160             <li>NumberingLevel6</li>
 161             <li>NumberingLevel7</li>
 162             <li>NumberingLevel8</li>
 163             <li>NumberingLevel9</li>
 164             <li>NumberingLevel10</li>
 165         </ul>
 166
 167
 168         @since  OOo 2.0.1
 169      */
 170     [optional, property] sequence< com::sun::star::beans::NamedValue > ParaStyleConditions;
 171
 172 };
 173
 174 //=============================================================================
 175
 176 }; }; }; };
 177 #endif