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