offapi/com/sun/star/report/XReportControlFormat.idl

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