summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/style/ParagraphStyle.idl
blob: 2989a8167c7bfa15a20cc05434a41117df2a5c0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_style_ParagraphStyle_idl__
#define __com_sun_star_style_ParagraphStyle_idl__

#ifndef __com_sun_star_style_ParagraphProperties_idl__
#include <com/sun/star/style/ParagraphProperties.idl>
#endif

#ifndef __com_sun_star_style_Style_idl__
#include <com/sun/star/style/Style.idl>
#endif

#ifndef _com_sun_star_xml_ParaUserDefinedAttributesSupplier_idl_
#include <com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module style {

//=============================================================================

/** specifies a stylesheet for paragraphs within a
    <type scope="com::sun::star::text">Text</type>.
 */
published service ParagraphStyle
{
    //-------------------------------------------------------------------------
    /// specifies administrative properties.
    service Style;

    //-------------------------------------------------------------------------
    /** contains user defined attributes for paragraphs.

        @see    <type scope="com::sun::star::xml">ParaUserDefinedAttributesSupplier</type>
     */
    [optional] service com::sun::star::xml::ParaUserDefinedAttributesSupplier;
    
    //-------------------------------------------------------------------------
    /// specifies the style properties.
    service ParagraphProperties;

    /** determines the left margin of the paragraph relative to the ParaLeftMargin
        of the parent style.

        <p> If the value of ParaLeftMarginRelative is 100 the current
        ParaLeftMargin value is used. </p>
     */
    [property] long ParaLeftMarginRelative;

    //-------------------------------------------------------------------------

    /** determines the right margin of the paragraph relative to the ParaRightMargin
        of the parent style.

        <p> If the value of ParaRightMarginRelative is 100 the current
        ParaRightMargin value is used. </p>
     */
    [property] long ParaRightMarginRelative;

    //-------------------------------------------------------------------------

    /** determines the top margin of the paragraph relative to the ParaTopMargin
        of the parent style.

        <p> If the value of ParaTopMarginRelative is 100 the current
        ParaTopMargin value is used. </p>
     */
    [property] long ParaTopMarginRelative;

    //-------------------------------------------------------------------------

    /** determines the Bottom margin of the paragraph relative to the ParaBottomMargin
        of the parent style.

        <p> If the value of ParaBottomMarginRelative is 100 the current
        ParaBottomMargin value is used. </p>
     */
    [property] long ParaBottomMarginRelative;
    //-------------------------------------------------------------------------

    /** determines the category of a paragraph style.@see com.sun.star.style.ParagraphStyleCategory
     */
    [property] short Category;
    //-------------------------------------------------------------------------

    [property] float CharDiffHeight;
    //-------------------------------------------------------------------------

    /** This value contains the character height as percentage value relative to the height of
     the character in the parent style.
     */
    [property] short CharPropHeight;
    //-------------------------------------------------------------------------

    /** This value contains the character height as difference in point to the height of
     the character in the parent style in Asian text.
     */
    [property] float CharDiffHeightAsian;
    //-------------------------------------------------------------------------

    /** This value contains the character height as percentage value relative to the height of
     the character in the parent style in Asian text.
     */
    [property] short CharPropHeightAsian;
    //-------------------------------------------------------------------------

    /** This value contains the character height as difference in point to the height of
     the character in the parent style in complex text.
     */
    [property] float CharDiffHeightComplex;
    //-------------------------------------------------------------------------

    /** This value contains the character height as percentage value relative to the height of
     the character in the parent style in complex text.
     */
    [property] short CharPropHeightComplex;
    //-------------------------------------------------------------------------

    /** returns the name of the page style in use

        <P>For setting the page style you have to use the 
        <member scope="com::sun::star::text">PageDescName</member> 
        properties.
        </P>
    */
    [optional, readonly, property] string PageStyleName;
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif