xref: /AOO41X/main/offapi/com/sun/star/style/ParagraphStyle.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_style_ParagraphStyle_idl__
24#define __com_sun_star_style_ParagraphStyle_idl__
25
26#ifndef __com_sun_star_style_ParagraphProperties_idl__
27#include <com/sun/star/style/ParagraphProperties.idl>
28#endif
29
30#ifndef __com_sun_star_style_Style_idl__
31#include <com/sun/star/style/Style.idl>
32#endif
33
34#ifndef _com_sun_star_xml_ParaUserDefinedAttributesSupplier_idl_
35#include <com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module style {
41
42//=============================================================================
43
44/** specifies a stylesheet for paragraphs within a
45    <type scope="com::sun::star::text">Text</type>.
46 */
47published service ParagraphStyle
48{
49    //-------------------------------------------------------------------------
50    /// specifies administrative properties.
51    service Style;
52
53    //-------------------------------------------------------------------------
54    /** contains user defined attributes for paragraphs.
55
56        @see    <type scope="com::sun::star::xml">ParaUserDefinedAttributesSupplier</type>
57     */
58    [optional] service com::sun::star::xml::ParaUserDefinedAttributesSupplier;
59
60    //-------------------------------------------------------------------------
61    /// specifies the style properties.
62    service ParagraphProperties;
63
64    /** determines the left margin of the paragraph relative to the ParaLeftMargin
65        of the parent style.
66
67        <p> If the value of ParaLeftMarginRelative is 100 the current
68        ParaLeftMargin value is used. </p>
69     */
70    [property] long ParaLeftMarginRelative;
71
72    //-------------------------------------------------------------------------
73
74    /** determines the right margin of the paragraph relative to the ParaRightMargin
75        of the parent style.
76
77        <p> If the value of ParaRightMarginRelative is 100 the current
78        ParaRightMargin value is used. </p>
79     */
80    [property] long ParaRightMarginRelative;
81
82    //-------------------------------------------------------------------------
83
84    /** determines the top margin of the paragraph relative to the ParaTopMargin
85        of the parent style.
86
87        <p> If the value of ParaTopMarginRelative is 100 the current
88        ParaTopMargin value is used. </p>
89     */
90    [property] long ParaTopMarginRelative;
91
92    //-------------------------------------------------------------------------
93
94    /** determines the Bottom margin of the paragraph relative to the ParaBottomMargin
95        of the parent style.
96
97        <p> If the value of ParaBottomMarginRelative is 100 the current
98        ParaBottomMargin value is used. </p>
99     */
100    [property] long ParaBottomMarginRelative;
101    //-------------------------------------------------------------------------
102
103    /** determines the category of a paragraph style.@see com.sun.star.style.ParagraphStyleCategory
104     */
105    [property] short Category;
106    //-------------------------------------------------------------------------
107
108    [property] float CharDiffHeight;
109    //-------------------------------------------------------------------------
110
111    /** This value contains the character height as percentage value relative to the height of
112     the character in the parent style.
113     */
114    [property] short CharPropHeight;
115    //-------------------------------------------------------------------------
116
117    /** This value contains the character height as difference in point to the height of
118     the character in the parent style in Asian text.
119     */
120    [property] float CharDiffHeightAsian;
121    //-------------------------------------------------------------------------
122
123    /** This value contains the character height as percentage value relative to the height of
124     the character in the parent style in Asian text.
125     */
126    [property] short CharPropHeightAsian;
127    //-------------------------------------------------------------------------
128
129    /** This value contains the character height as difference in point to the height of
130     the character in the parent style in complex text.
131     */
132    [property] float CharDiffHeightComplex;
133    //-------------------------------------------------------------------------
134
135    /** This value contains the character height as percentage value relative to the height of
136     the character in the parent style in complex text.
137     */
138    [property] short CharPropHeightComplex;
139    //-------------------------------------------------------------------------
140
141    /** returns the name of the page style in use
142
143        <P>For setting the page style you have to use the
144        <member scope="com::sun::star::text">PageDescName</member>
145        properties.
146        </P>
147    */
148    [optional, readonly, property] string PageStyleName;
149};
150
151//=============================================================================
152
153}; }; }; };
154
155/*=============================================================================
156
157=============================================================================*/
158#endif
159
160