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_report_XReportControlFormat_idl__
24#define __com_sun_star_report_XReportControlFormat_idl__
25
26#include <com/sun/star/awt/FontDescriptor.idl>
27#include <com/sun/star/awt/FontSlant.idl>
28#include <com/sun/star/beans/XPropertySet.idl>
29#include <com/sun/star/lang/IllegalArgumentException.idl>
30#include <com/sun/star/lang/Locale.idl>
31#include <com/sun/star/style/ParagraphAdjust.idl>
32#include <com/sun/star/style/VerticalAlignment.idl>
33#include <com/sun/star/util/Color.idl>
34//=============================================================================
35
36 module com {  module sun {  module star {  module report {
37
38//=============================================================================
39/** specifies a format condition for a control.
40*/
41published interface XReportControlFormat
42{
43    /** specifies the background color (RGB) of the control.
44     */
45    [attribute,bound] com::sun::star::util::Color ControlBackground
46    {
47        set raises ( com::sun::star::beans::UnknownPropertyException );
48        get raises ( com::sun::star::beans::UnknownPropertyException );
49    };
50
51    /** determines if the back ground color is set to transparent.
52     */
53    [attribute,bound] boolean ControlBackgroundTransparent
54    {
55        set raises ( com::sun::star::beans::UnknownPropertyException );
56        get raises ( com::sun::star::beans::UnknownPropertyException );
57    };
58
59    /** specifies the horizontal alignment of the text.
60        @see ::com::sun::star::style::ParagraphAdjust
61     */
62    [attribute,bound] short ParaAdjust
63    {
64        set raises ( com::sun::star::beans::UnknownPropertyException );
65        get raises ( com::sun::star::beans::UnknownPropertyException );
66    };
67
68    //-------------------------------------------------------------------------
69
70    /** specifies the font attributes of the text in the control.
71     */
72    [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptor
73    {
74        set raises ( com::sun::star::beans::UnknownPropertyException );
75        get raises ( com::sun::star::beans::UnknownPropertyException );
76    };
77
78    /** specifies the font attributes of the text in the control.
79     */
80    [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptorAsian
81    {
82        set raises ( com::sun::star::beans::UnknownPropertyException );
83        get raises ( com::sun::star::beans::UnknownPropertyException );
84    };
85
86    /** specifies the font attributes of the text in the control.
87     */
88    [attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptorComplex
89    {
90        set raises ( com::sun::star::beans::UnknownPropertyException );
91        get raises ( com::sun::star::beans::UnknownPropertyException );
92    };
93
94    //-------------------------------------------------------------------------
95
96    /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
97        value of the text in the control.
98     */
99    [attribute,bound] short ControlTextEmphasis
100    {
101        set raises ( com::sun::star::beans::UnknownPropertyException );
102        get raises ( com::sun::star::beans::UnknownPropertyException );
103    };
104
105    /** contains the font emphasis value as <type scope="com::sun::star::text">FontEmphasis</type>.
106     */
107    [attribute,bound] short CharEmphasis
108    {
109        set raises ( com::sun::star::beans::UnknownPropertyException );
110        get raises ( com::sun::star::beans::UnknownPropertyException );
111    };
112
113    /** determins whether text is formatted in two lines.
114     <p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p>
115     */
116    [attribute,bound] boolean CharCombineIsOn
117    {
118        set raises ( com::sun::star::beans::UnknownPropertyException );
119        get raises ( com::sun::star::beans::UnknownPropertyException );
120    };
121    //-------------------------------------------------------------------------
122    /** contains the prefix (usually parenthesis) before text that is formatted in two lines.
123     <p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p>
124     */
125    [attribute,bound] string CharCombinePrefix
126    {
127        set raises ( com::sun::star::beans::UnknownPropertyException );
128        get raises ( com::sun::star::beans::UnknownPropertyException );
129    };
130    //-------------------------------------------------------------------------
131    /** contains the suffix (usually parenthesis) after text that is formatted in two lines.
132     <p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p>
133     */
134    [attribute,bound] string CharCombineSuffix
135    {
136        set raises ( com::sun::star::beans::UnknownPropertyException );
137        get raises ( com::sun::star::beans::UnknownPropertyException );
138    };
139
140    /** If this optional property is <TRUE/>, then the characters are invisible.
141
142        @since OpenOffice 2.0
143     */
144    [attribute,bound] boolean CharHidden
145    {
146        set raises ( com::sun::star::beans::UnknownPropertyException );
147        get raises ( com::sun::star::beans::UnknownPropertyException );
148    };
149
150    //-------------------------------------------------------------------------
151    /** specifies if the characters are formatted and
152        displayed with a shadow effect.
153     */
154    [attribute,bound] boolean CharShadowed
155    {
156        set raises ( com::sun::star::beans::UnknownPropertyException );
157        get raises ( com::sun::star::beans::UnknownPropertyException );
158    };
159
160    /** specifies if the characters are formatted and
161        displayed with a contour effect.
162     */
163    [attribute,bound] boolean CharContoured
164    {
165        set raises ( com::sun::star::beans::UnknownPropertyException );
166        get raises ( com::sun::star::beans::UnknownPropertyException );
167    };
168
169    /** optional property which contains the value of the case-mapping of the
170        text for formatting and displaying.
171
172        @see CaseMap
173     */
174    [attribute,bound] short CharCaseMap
175    {
176        set raises ( com::sun::star::beans::UnknownPropertyException );
177        get raises ( com::sun::star::beans::UnknownPropertyException );
178    };
179
180    /** contains the value of the locale.
181     */
182    [attribute,bound] com::sun::star::lang::Locale CharLocale
183    {
184        set raises ( com::sun::star::beans::UnknownPropertyException );
185        get raises ( com::sun::star::beans::UnknownPropertyException );
186    };
187
188    /** specifies the percentage of raisement/lowerment of superscript/subscript
189        characters.
190
191        <p>Negative values denote subscripts and positive values superscripts.</p>
192     */
193    [attribute,bound] short CharEscapement
194    {
195        set raises ( com::sun::star::beans::UnknownPropertyException );
196        get raises ( com::sun::star::beans::UnknownPropertyException );
197    };
198
199    /** This is the additional height used for subscript or superscript
200        characters in units of percent.
201        For subscript characters the value is negative and for
202        superscript characters positive.
203     */
204    [attribute,bound] byte CharEscapementHeight
205    {
206        set raises ( com::sun::star::beans::UnknownPropertyException );
207        get raises ( com::sun::star::beans::UnknownPropertyException );
208    };
209
210    /** optional property to determine whether the kerning tables from the current font are used.
211        <p>Automatic <em>kerning</em> applies a spacing in between certain
212        pairs of characters to make the text look better.</p>
213     */
214    [attribute,bound] boolean CharAutoKerning
215    {
216        set raises ( com::sun::star::beans::UnknownPropertyException );
217        get raises ( com::sun::star::beans::UnknownPropertyException );
218    };
219
220    /** optional property which contains the value of the kerning of the characters.
221     */
222    [attribute,bound] short CharKerning
223    {
224        set raises ( com::sun::star::beans::UnknownPropertyException );
225        get raises ( com::sun::star::beans::UnknownPropertyException );
226    };
227
228    /** If this optional property is <TRUE/>, then the characters are flashing.
229     */
230    [attribute,bound] boolean CharFlash
231    {
232        set raises ( com::sun::star::beans::UnknownPropertyException );
233        get raises ( com::sun::star::beans::UnknownPropertyException );
234    };
235
236    /** specifies the <type scope="com::sun::star::text">FontRelief</type>
237        value of the text in the control.
238     */
239    [attribute,bound] short CharRelief
240    {
241        set raises ( com::sun::star::beans::UnknownPropertyException );
242        get raises ( com::sun::star::beans::UnknownPropertyException );
243    };
244
245    /** This attribute specifies the name of the font style.
246
247
248
249        <p>It may contain more than one name separated by comma.</p>
250     */
251    [attribute,bound] string CharFontName
252    {
253        set raises ( com::sun::star::beans::UnknownPropertyException );
254        get raises ( com::sun::star::beans::UnknownPropertyException );
255    };
256    //-------------------------------------------------------------------------
257
258    /** This attribute contains the name of the font style.
259
260        <p>This attribute may be empty.</p>
261     */
262    [attribute,bound] string CharFontStyleName
263    {
264        set raises ( com::sun::star::beans::UnknownPropertyException );
265        get raises ( com::sun::star::beans::UnknownPropertyException );
266    };
267    //-------------------------------------------------------------------------
268
269    /** This attribute contains font family as specified in
270        com.sun.star.awt.FontFamily .
271     */
272    [attribute,bound] short CharFontFamily
273    {
274        set raises ( com::sun::star::beans::UnknownPropertyException );
275        get raises ( com::sun::star::beans::UnknownPropertyException );
276    };
277    //-------------------------------------------------------------------------
278
279    /** This attribute contains the text encoding of the font as specified in
280        com.sun.star.awt.CharSet.
281     */
282    [attribute,bound] short CharFontCharSet
283    {
284        set raises ( com::sun::star::beans::UnknownPropertyException );
285        get raises ( com::sun::star::beans::UnknownPropertyException );
286    };
287    //-------------------------------------------------------------------------
288
289    /** This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch.
290     */
291    [attribute,bound] short CharFontPitch
292    {
293        set raises ( com::sun::star::beans::UnknownPropertyException );
294        get raises ( com::sun::star::beans::UnknownPropertyException );
295    };
296
297    /** specifies the text color (RGB) of the control.
298     */
299    [attribute,bound] com::sun::star::util::Color CharColor
300    {
301        set raises ( com::sun::star::beans::UnknownPropertyException );
302        get raises ( com::sun::star::beans::UnknownPropertyException );
303    };
304
305    //-------------------------------------------------------------------------
306
307    /** specifies the text line color (RGB) of the control.
308     */
309    [attribute,bound] com::sun::star::util::Color CharUnderlineColor
310    {
311        set raises ( com::sun::star::beans::UnknownPropertyException );
312        get raises ( com::sun::star::beans::UnknownPropertyException );
313    };
314
315    /** This value contains the height of the characters in point.
316     */
317    [attribute,bound] float CharHeight
318    {
319        set raises ( com::sun::star::beans::UnknownPropertyException );
320        get raises ( com::sun::star::beans::UnknownPropertyException );
321    };
322
323    //-------------------------------------------------------------------------
324
325    /** This attribute contains the value for the character underline.@see com::sun::star::awt::FontUnderline
326     */
327    [attribute,bound] short CharUnderline
328    {
329        set raises ( com::sun::star::beans::UnknownPropertyException );
330        get raises ( com::sun::star::beans::UnknownPropertyException );
331    };
332
333    //-------------------------------------------------------------------------
334
335    /** This attribute contains the value of the font weight.@see com::sun::star::awt::FontWeight
336     */
337    [attribute,bound] float CharWeight
338    {
339        set raises ( com::sun::star::beans::UnknownPropertyException );
340        get raises ( com::sun::star::beans::UnknownPropertyException );
341    };
342
343    //-------------------------------------------------------------------------
344
345    /** This attribute contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
346     */
347    [attribute,bound] com::sun::star::awt::FontSlant CharPosture
348    {
349        set raises ( com::sun::star::beans::UnknownPropertyException );
350        get raises ( com::sun::star::beans::UnknownPropertyException );
351    };
352
353    //-------------------------------------------------------------------------
354    /**	determins the type of the strike out of the character.
355        @see com.sun.star.awt.FontStrikeout
356    */
357    [attribute,bound] short CharStrikeout
358    {
359        set raises ( com::sun::star::beans::UnknownPropertyException );
360        get raises ( com::sun::star::beans::UnknownPropertyException );
361    };
362
363    /**	If this attribute is <TRUE/>, the underline and strike-through
364        properties are not applied to white spaces.
365     */
366    [attribute,bound] boolean CharWordMode
367    {
368        set raises ( com::sun::star::beans::UnknownPropertyException );
369        get raises ( com::sun::star::beans::UnknownPropertyException );
370    };
371
372    /** determins the rotation of a character in degree.
373        <p>Depending on the implementation only certain values may be allowed.
374        </p>
375     */
376    [attribute,bound] short CharRotation
377    {
378        set raises ( com::sun::star::beans::UnknownPropertyException );
379        get raises ( com::sun::star::beans::UnknownPropertyException );
380    };
381    //-------------------------------------------------------------------------
382
383    /** determins the percentage value for scaling the width of characters.
384
385        <p>The value refers to the original width which is denoted by 100,
386        and it has to be greater than 0.</p>
387
388     */
389    [attribute,bound] short CharScaleWidth
390    {
391        set raises ( com::sun::star::beans::UnknownPropertyException );
392        get raises ( com::sun::star::beans::UnknownPropertyException );
393    };
394
395    /** specifies the vertical alignment of the text in the control.
396        @see com::sun::star::style::VerticalAlignment
397     */
398    [attribute,bound] com::sun::star::style::VerticalAlignment VerticalAlign
399    {
400        set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
401        get raises ( com::sun::star::beans::UnknownPropertyException );
402    };
403
404    //-------------------------------------------------------------------------
405    /** contains the URL of a hyperlink (if set).
406     */
407    [attribute,bound] string HyperLinkURL
408    {
409        set raises ( com::sun::star::beans::UnknownPropertyException );
410        get raises ( com::sun::star::beans::UnknownPropertyException );
411    };
412
413    //-------------------------------------------------------------------------
414    /** contains the name of the target for a hyperlink (if set).
415     */
416    [attribute,bound] string HyperLinkTarget
417    {
418        set raises ( com::sun::star::beans::UnknownPropertyException );
419        get raises ( com::sun::star::beans::UnknownPropertyException );
420    };
421
422    //-------------------------------------------------------------------------
423    /** contains the name of the hyperlink (if set).
424     */
425    [attribute,bound] string HyperLinkName
426    {
427        set raises ( com::sun::star::beans::UnknownPropertyException );
428        get raises ( com::sun::star::beans::UnknownPropertyException );
429    };
430
431    //--------------------------------------------------------------------
432    /** contains the character style name for visited hyperlinks.
433     */
434    [attribute,bound] string VisitedCharStyleName
435    {
436        set raises ( com::sun::star::beans::UnknownPropertyException );
437        get raises ( com::sun::star::beans::UnknownPropertyException );
438    };
439
440    //--------------------------------------------------------------------
441    /** contains the character style name for unvisited hyperlinks.
442     */
443    [attribute,bound] string UnvisitedCharStyleName
444    {
445        set raises ( com::sun::star::beans::UnknownPropertyException );
446        get raises ( com::sun::star::beans::UnknownPropertyException );
447    };
448    /** This value contains the height of the characters in point.
449     */
450    [attribute,bound] float CharHeightAsian
451    {
452        set raises ( com::sun::star::beans::UnknownPropertyException );
453        get raises ( com::sun::star::beans::UnknownPropertyException );
454    };
455    //-------------------------------------------------------------------------
456    /** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight
457     */
458    [attribute,bound] float CharWeightAsian
459    {
460        set raises ( com::sun::star::beans::UnknownPropertyException );
461        get raises ( com::sun::star::beans::UnknownPropertyException );
462    };
463    //-------------------------------------------------------------------------
464    /** This property specifies the name of the font style.
465        <p>It may contain more than one name separated by comma.</p>
466     */
467    [attribute,bound] string CharFontNameAsian
468    {
469        set raises ( com::sun::star::beans::UnknownPropertyException );
470        get raises ( com::sun::star::beans::UnknownPropertyException );
471    };
472    //-------------------------------------------------------------------------
473    /** This property contains the name of the font style.
474        <p>This property may be empty.</p>
475     */
476    [attribute,bound] string CharFontStyleNameAsian
477    {
478        set raises ( com::sun::star::beans::UnknownPropertyException );
479        get raises ( com::sun::star::beans::UnknownPropertyException );
480    };
481    //-------------------------------------------------------------------------
482    /** This property contains font family as specified in
483        com.sun.star.awt.FontFamily .
484     */
485    [attribute,bound] short CharFontFamilyAsian
486    {
487        set raises ( com::sun::star::beans::UnknownPropertyException );
488        get raises ( com::sun::star::beans::UnknownPropertyException );
489    };
490    //-------------------------------------------------------------------------
491    /** This property contains the text encoding of the font as specified in
492        com.sun.star.awt.CharSet.
493     */
494    [attribute,bound] short CharFontCharSetAsian
495    {
496        set raises ( com::sun::star::beans::UnknownPropertyException );
497        get raises ( com::sun::star::beans::UnknownPropertyException );
498    };
499    //-------------------------------------------------------------------------
500    /** This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
501     */
502    [attribute,bound] short CharFontPitchAsian
503    {
504        set raises ( com::sun::star::beans::UnknownPropertyException );
505        get raises ( com::sun::star::beans::UnknownPropertyException );
506    };
507    //-------------------------------------------------------------------------
508    /** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
509     */
510    [attribute,bound] com::sun::star::awt::FontSlant CharPostureAsian
511    {
512        set raises ( com::sun::star::beans::UnknownPropertyException );
513        get raises ( com::sun::star::beans::UnknownPropertyException );
514    };
515
516    //-------------------------------------------------------------------------
517    /** contains the value of the locale.
518     */
519    [attribute,bound] com::sun::star::lang::Locale CharLocaleAsian
520    {
521        set raises ( com::sun::star::beans::UnknownPropertyException );
522        get raises ( com::sun::star::beans::UnknownPropertyException );
523    };
524
525    //-------------------------------------------------------------------------
526    /** This value contains the height of the characters in point.
527     */
528    [attribute,bound] float CharHeightComplex
529    {
530        set raises ( com::sun::star::beans::UnknownPropertyException );
531        get raises ( com::sun::star::beans::UnknownPropertyException );
532    };
533    //-------------------------------------------------------------------------
534    /** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight
535     */
536    [attribute,bound] float CharWeightComplex
537    {
538        set raises ( com::sun::star::beans::UnknownPropertyException );
539        get raises ( com::sun::star::beans::UnknownPropertyException );
540    };
541    //-------------------------------------------------------------------------
542    /** This property specifies the name of the font style.
543        <p>It may contain more than one name separated by comma.</p>
544     */
545    [attribute,bound] string CharFontNameComplex
546    {
547        set raises ( com::sun::star::beans::UnknownPropertyException );
548        get raises ( com::sun::star::beans::UnknownPropertyException );
549    };
550    //-------------------------------------------------------------------------
551    /** This property contains the name of the font style.
552        <p>This property may be empty.</p>
553     */
554    [attribute,bound] string CharFontStyleNameComplex
555
556    {
557        set raises ( com::sun::star::beans::UnknownPropertyException );
558        get raises ( com::sun::star::beans::UnknownPropertyException );
559    };
560    //-------------------------------------------------------------------------
561    /** This property contains font family as specified in
562        com.sun.star.awt.FontFamily .
563     */
564    [attribute,bound] short CharFontFamilyComplex
565    {
566        set raises ( com::sun::star::beans::UnknownPropertyException );
567        get raises ( com::sun::star::beans::UnknownPropertyException );
568    };
569    //-------------------------------------------------------------------------
570    /** This property contains the text encoding of the font as specified in
571        com.sun.star.awt.CharSet.
572     */
573    [attribute,bound] short CharFontCharSetComplex
574    {
575        set raises ( com::sun::star::beans::UnknownPropertyException );
576        get raises ( com::sun::star::beans::UnknownPropertyException );
577    };
578    //-------------------------------------------------------------------------
579    /** This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
580     */
581    [attribute,bound] short CharFontPitchComplex
582    {
583        set raises ( com::sun::star::beans::UnknownPropertyException );
584        get raises ( com::sun::star::beans::UnknownPropertyException );
585    };
586    //-------------------------------------------------------------------------
587    /** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
588     */
589    [attribute,bound] com::sun::star::awt::FontSlant CharPostureComplex
590    {
591        set raises ( com::sun::star::beans::UnknownPropertyException );
592        get raises ( com::sun::star::beans::UnknownPropertyException );
593    };
594
595    //-------------------------------------------------------------------------
596    /** contains the value of the locale.
597     */
598    [attribute,bound] com::sun::star::lang::Locale CharLocaleComplex
599    {
600        set raises ( com::sun::star::beans::UnknownPropertyException );
601        get raises ( com::sun::star::beans::UnknownPropertyException );
602    };
603};
604
605service ReportControlFormat : XReportControlFormat;
606//=============================================================================
607
608}; }; }; };
609#endif
610