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

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