summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/style/CharacterProperties.idl
blob: 3edffcb22fc8ece26bffdd11515f11cb26f1c5c2 (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/*************************************************************************
 *
 *  $RCSfile: CharacterProperties.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:17:27 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_style_CharacterProperties_idl__
#define __com_sun_star_style_CharacterProperties_idl__

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_awt_FontSlant_idl__
#include <com/sun/star/awt/FontSlant.idl>
#endif


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

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

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

// DocMerge from xml: service com::sun::star::style::CharacterProperties
/** This is a set of properties to describe the style of characters.@see service ParagraphProperties
 */
service CharacterProperties
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFontName
    /** This property specifies the name of the font style.



        <p>It may contain more than one name separated by comma.</p>
     */
    [property] string CharFontName;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFontStyleName
    /** This property contains the name of the font style.

        <p>This property may be empty.</p>
     */
    [property] string CharFontStyleName;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFontFamily
    /** This property contains font family as specified in
        com.sun.star.awt.FontFamily .
     */
    [property] short CharFontFamily;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFontCharSet
    /** This property contains the text encoding of the font as specified in
        com.sun.star.awt.CharSet.
     */
    [property] short CharFontCharSet;
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFontPitch
    /** This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
     */
    [property] short CharFontPitch;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharColor
    /** This property contains the value of the text color.
     */
    [property] long CharColor;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharEscapement
    /** optional property which contains the relative value of the character
        height in subscription or superscription.









        @optional
     */
    [optional, property] short CharEscapement;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharHeight
    /** This value contains the height of the characters in point.
     */
    [property] float CharHeight;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharUnderline
    /** This property contains the value for the character underline.@see com::sun::star::awt::FontUnderline
     */
    [property] short CharUnderline;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharWeight
    /** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight
     */
    [property] float CharWeight;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharPosture
    /** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
     */
    [property] com::sun::star::awt::FontSlant CharPosture;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharAutoKerning
    /** optional property to determine whether the kerning tables from the current font are used.


        <p>Automatic <em>kerning</em> applies a spacing in between certain
        pairs of characters to make the text look better.</p>


        @optional
     */
    [optional, property] boolean CharAutoKerning;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharBackColor
    /** optional property which contains the text background color.

        @optional
     */
    [optional, property] long CharBackColor;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharBackTransparent
    /** determines if the text background color is set at transparent.
     */
    [optional, property] boolean CharBackTransparent;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharCaseMap
    /** optional property which contains the value of the case-mapping of the
        text for formatting and displaying.

        @optional

        @see constants CaseMap
     */
    [optional, property] short CharCaseMap;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharCrossedOut
    /** This property is <true></true> if the character(s) is(are) crossed out.

        @optional
     */
    [optional, property] boolean CharCrossedOut;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFlash
    /** If this optional property is <true></true>, then the characters are flashing.

        @optional
     */
    [optional, property] boolean CharFlash;

    //-------------------------------------------------------------------------
    /** determins the type of the strike out of the character.
        @see com.sun.star.awt.FontStrikeout
    */
    [optional, property] short CharStrikeout;

    //-------------------------------------------------------------------------
    /** If this property is <TRUE/>, the underline and strike-through
        properties are not applied to white spaces.

        @optional
     */
    [optional, property] boolean CharWordMode;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharKerning
    /** optional property which contains the value of the kerning of the characters.

        @optional
     */
    [optional, property] short CharKerning;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharLocale
    /** contains the value of the locale.
     */
    [property] com::sun::star::lang::Locale CharLocale;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharKeepTogether
    /** optional property which marks a range of characters to prevent it from being broken into two lines.

        <p> A line break is applied before the range of characters if
        the layout makes a break necessary within the range.</p>

        @optional
     */
    [optional, property] boolean CharKeepTogether;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharNoLineBreak
    /** optional property which marks a range of characters to ignore a line break in this area.

        <p> A line break is applied behind the range of characters if
        the layout makes a break necessary within the range. That means that
        the text may go through the border.</p>

        @optional
     */
    [optional, property] boolean CharNoLineBreak;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharShadowed
    /** specifies if the characters are formatted and
        displayed with a shadow effect.

        @optional
     */
    [optional, property] boolean CharShadowed;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharFontType
    /** optional property which specifies the fundamental technology of the font.

        @optional@see com::sun::star::awt::FontType
     */
    [optional, property] short CharFontType;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharStyleName
    /** specifies the name of the style of the font.
     */
    [optional, property] string CharStyleName;

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

    // DocMerge from xml: property com::sun::star::style::CharacterProperties::CharContoured
    /** specifies if the characters are formatted and
        displayed with a contour effect.

        @optional
     */
    [optional, property] boolean CharContoured;

};

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

}; }; }; };

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

    $Log: not supported by cvs2svn $
    Revision 1.2  2000/10/09 14:25:01  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)

    Revision 1.1.1.1  2000/09/18 23:35:54  hjs
    initial import

    Revision 1.10  2000/09/11 11:52:55  mi
    documentation merged from XML

    Revision 1.8  2000/08/25 08:44:15  os
    property CharStrikeout

    Revision 1.7  2000/08/17 11:41:20  bm
    some properties are optional (settings got lost by merge). I set them according to old docu

    Revision 1.6  2000/07/19 07:56:26  os
    ...Style -> ...StyleName

    Revision 1.5  2000/06/29 12:27:06  os
    TransparentBackground -> ~BackTransparent

    Revision 1.4  2000/06/28 15:41:11  os
    new properties: CharFontStyleName/Family/CharSet/Pitch

    Revision 1.3  2000/02/21 16:18:09  mi
    string documentation from stardiv...*.idl-files

    Revision 1.2  2000/01/28 16:32:18  mi
    #72210# Locale instead of Language in NumberFormatter

    Revision 1.1.1.1  1999/11/11 09:48:45  jsc
    new


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