offapi/com/sun/star/style/Style.idl

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