offapi/com/sun/star/style/ParagraphStyle.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: ParagraphStyle.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_ParagraphStyle_idl__
  31 #define __com_sun_star_style_ParagraphStyle_idl__
  32
  33 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  34 #include <com/sun/star/style/ParagraphProperties.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_style_Style_idl__
  38 #include <com/sun/star/style/Style.idl>
  39 #endif
  40
  41 #ifndef _com_sun_star_xml_ParaUserDefinedAttributesSupplier_idl_
  42 #include <com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module style {
  48
  49 //=============================================================================
  50
  51 /** specifies a stylesheet for paragraphs within a
  52     <type scope="com::sun::star::text">Text</type>.
  53  */
  54 published service ParagraphStyle
  55 {
  56     //-------------------------------------------------------------------------
  57     /// specifies administrative properties.
  58     service Style;
  59
  60     //-------------------------------------------------------------------------
  61     /** contains user defined attributes for paragraphs.
  62
  63         @see    <type scope="com::sun::star::xml">ParaUserDefinedAttributesSupplier</type>
  64      */
  65     [optional] service com::sun::star::xml::ParaUserDefinedAttributesSupplier;
  66
  67     //-------------------------------------------------------------------------
  68     /// specifies the style properties.
  69     service ParagraphProperties;
  70
  71     /** determines the left margin of the paragraph relative to the ParaLeftMargin
  72         of the parent style.
  73
  74         <p> If the value of ParaLeftMarginRelative is 100 the current
  75         ParaLeftMargin value is used. </p>
  76      */
  77     [property] long ParaLeftMarginRelative;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** determines the right margin of the paragraph relative to the ParaRightMargin
  82         of the parent style.
  83
  84         <p> If the value of ParaRightMarginRelative is 100 the current
  85         ParaRightMargin value is used. </p>
  86      */
  87     [property] long ParaRightMarginRelative;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** determines the top margin of the paragraph relative to the ParaTopMargin
  92         of the parent style.
  93
  94         <p> If the value of ParaTopMarginRelative is 100 the current
  95         ParaTopMargin value is used. </p>
  96      */
  97     [property] long ParaTopMarginRelative;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** determines the Bottom margin of the paragraph relative to the ParaBottomMargin
 102         of the parent style.
 103
 104         <p> If the value of ParaBottomMarginRelative is 100 the current
 105         ParaBottomMargin value is used. </p>
 106      */
 107     [property] long ParaBottomMarginRelative;
 108     //-------------------------------------------------------------------------
 109
 110     /** determines the category of a paragraph style.@see com.sun.star.style.ParagraphStyleCategory
 111      */
 112     [property] short Category;
 113     //-------------------------------------------------------------------------
 114
 115     [property] float CharDiffHeight;
 116     //-------------------------------------------------------------------------
 117
 118     /** This value contains the character height as percentage value relative to the height of
 119      the character in the parent style.
 120      */
 121     [property] short CharPropHeight;
 122     //-------------------------------------------------------------------------
 123
 124     /** This value contains the character height as difference in point to the height of
 125      the character in the parent style in Asian text.
 126      */
 127     [property] float CharDiffHeightAsian;
 128     //-------------------------------------------------------------------------
 129
 130     /** This value contains the character height as percentage value relative to the height of
 131      the character in the parent style in Asian text.
 132      */
 133     [property] short CharPropHeightAsian;
 134     //-------------------------------------------------------------------------
 135
 136     /** This value contains the character height as difference in point to the height of
 137      the character in the parent style in complex text.
 138      */
 139     [property] float CharDiffHeightComplex;
 140     //-------------------------------------------------------------------------
 141
 142     /** This value contains the character height as percentage value relative to the height of
 143      the character in the parent style in complex text.
 144      */
 145     [property] short CharPropHeightComplex;
 146     //-------------------------------------------------------------------------
 147
 148     /** returns the name of the page style in use
 149
 150         <P>For setting the page style you have to use the
 151         <member scope="com::sun::star::text">PageDescName</member>
 152         properties.
 153         </P>
 154     */
 155     [optional, readonly, property] string PageStyleName;
 156 };
 157
 158 //=============================================================================
 159
 160 }; }; }; };
 161
 162 /*=============================================================================
 163
 164 =============================================================================*/
 165 #endif
 166