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

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