office-gobmx/offapi/com/sun/star/report/XReportControlFormat.idl
Michael Stahl 928b8640c0 *api: convert <TRUE/> <FALSE/> <VOID/> <NULL/>
sed -i 's,<\(TRUE\|FALSE\|VOID\|NULL\)/>,`\1`,g'

Change-Id: Ia4df97ca809b00993530d67203bbe4ba7a072201
2013-06-04 12:01:05 +02:00

566 lines
21 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_report_XReportControlFormat_idl__
#define __com_sun_star_report_XReportControlFormat_idl__
#include <com/sun/star/awt/FontDescriptor.idl>
#include <com/sun/star/awt/FontSlant.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/style/ParagraphAdjust.idl>
#include <com/sun/star/style/VerticalAlignment.idl>
#include <com/sun/star/util/Color.idl>
module com { module sun { module star { module report {
/** specifies a format condition for a control.
*/
interface XReportControlFormat
{
/** specifies the background color (RGB) of the control.
*/
[attribute,bound] com::sun::star::util::Color ControlBackground
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** determines if the back ground color is set to transparent.
*/
[attribute,bound] boolean ControlBackgroundTransparent
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the horizontal alignment of the text.
@see ::com::sun::star::style::ParagraphAdjust
*/
[attribute,bound] short ParaAdjust
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the font attributes of the text in the control.
*/
[attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptor
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the font attributes of the text in the control.
*/
[attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptorAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the font attributes of the text in the control.
*/
[attribute,bound] com::sun::star::awt::FontDescriptor FontDescriptorComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the com::sun::star::text::FontEmphasis
value of the text in the control.
*/
[attribute,bound] short ControlTextEmphasis
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the font emphasis value as com::sun::star::text::FontEmphasis.
*/
[attribute,bound] short CharEmphasis
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** determines whether text is formatted in two lines.
<p>It is linked to the properties CharCombinePrefix and CharCombineSuffix.</p>
*/
[attribute,bound] boolean CharCombineIsOn
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the prefix (usually parenthesis) before text that is formatted in two lines.
<p>It is linked to the properties CharCombineIsOn and CharCombineSuffix.</p>
*/
[attribute,bound] string CharCombinePrefix
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the suffix (usually parenthesis) after text that is formatted in two lines.
<p>It is linked to the properties CharCombineIsOn and CharCombinePrefix.</p>
*/
[attribute,bound] string CharCombineSuffix
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** If this optional property is `TRUE`, then the characters are invisible.
@since OOo 2.0
*/
[attribute,bound] boolean CharHidden
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies if the characters are formatted and
displayed with a shadow effect.
*/
[attribute,bound] boolean CharShadowed
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies if the characters are formatted and
displayed with a contour effect.
*/
[attribute,bound] boolean CharContoured
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** optional property which contains the value of the case-mapping of the
text for formatting and displaying.
@see CaseMap
*/
[attribute,bound] short CharCaseMap
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the value of the locale.
*/
[attribute,bound] com::sun::star::lang::Locale CharLocale
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the percentage by which to raise/lower superscript/subscript
characters.
<p>Negative values denote subscripts and positive values superscripts.</p>
*/
[attribute,bound] short CharEscapement
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This is the additional height used for subscript or superscript
characters in units of percent.
For subscript characters the value is negative and for
superscript characters positive.
*/
[attribute,bound] byte CharEscapementHeight
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** optional property to determine whether the kerning tables from the current font are used.
<p>Automatic <em>kerning</em> applies a spacing in between certain
pairs of characters to make the text look better.</p>
*/
[attribute,bound] boolean CharAutoKerning
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** optional property which contains the value of the kerning of the characters.
*/
[attribute,bound] short CharKerning
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** If this optional property is `TRUE`, then the characters are flashing.
*/
[attribute,bound] boolean CharFlash
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the com::sun::star::text::FontRelief
value of the text in the control.
*/
[attribute,bound] short CharRelief
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute specifies the name of the font style.
<p>It may contain more than one name separated by comma.</p>
*/
[attribute,bound] string CharFontName
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains the name of the font style.
<p>This attribute may be empty.</p>
*/
[attribute,bound] string CharFontStyleName
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains font family as specified in
com.sun.star.awt.FontFamily .
*/
[attribute,bound] short CharFontFamily
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains the text encoding of the font as specified in
com.sun.star.awt.CharSet.
*/
[attribute,bound] short CharFontCharSet
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains the font pitch as specified in com.sun.star.awt.FontPitch.
*/
[attribute,bound] short CharFontPitch
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the text color (RGB) of the control.
*/
[attribute,bound] com::sun::star::util::Color CharColor
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the text line color (RGB) of the control.
*/
[attribute,bound] com::sun::star::util::Color CharUnderlineColor
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This value contains the height of the characters in point.
*/
[attribute,bound] float CharHeight
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains the value for the character underline.@see com::sun::star::awt::FontUnderline
*/
[attribute,bound] short CharUnderline
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains the value of the font weight.@see com::sun::star::awt::FontWeight
*/
[attribute,bound] float CharWeight
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This attribute contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
*/
[attribute,bound] com::sun::star::awt::FontSlant CharPosture
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** determines the type of the strike out of the character.
@see com.sun.star.awt.FontStrikeout
*/
[attribute,bound] short CharStrikeout
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** If this attribute is `TRUE`, the underline and strike-through
properties are not applied to white spaces.
*/
[attribute,bound] boolean CharWordMode
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** determines the rotation of a character in degree.
<p>Depending on the implementation only certain values may be allowed.
</p>
*/
[attribute,bound] short CharRotation
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** determines the percentage value for scaling the width of characters.
<p>The value refers to the original width which is denoted by 100,
and it has to be greater than 0.</p>
*/
[attribute,bound] short CharScaleWidth
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** specifies the vertical alignment of the text in the control.
@see com::sun::star::style::VerticalAlignment
*/
[attribute,bound] com::sun::star::style::VerticalAlignment VerticalAlign
{
set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the URL of a hyperlink (if set).
*/
[attribute,bound] string HyperLinkURL
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the name of the target for a hyperlink (if set).
*/
[attribute,bound] string HyperLinkTarget
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the name of the hyperlink (if set).
*/
[attribute,bound] string HyperLinkName
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the character style name for visited hyperlinks.
*/
[attribute,bound] string VisitedCharStyleName
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the character style name for unvisited hyperlinks.
*/
[attribute,bound] string UnvisitedCharStyleName
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This value contains the height of the characters in point.
*/
[attribute,bound] float CharHeightAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight
*/
[attribute,bound] float CharWeightAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property specifies the name of the font style.
<p>It may contain more than one name separated by comma.</p>
*/
[attribute,bound] string CharFontNameAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the name of the font style.
<p>This property may be empty.</p>
*/
[attribute,bound] string CharFontStyleNameAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains font family as specified in
com.sun.star.awt.FontFamily .
*/
[attribute,bound] short CharFontFamilyAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the text encoding of the font as specified in
com.sun.star.awt.CharSet.
*/
[attribute,bound] short CharFontCharSetAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
*/
[attribute,bound] short CharFontPitchAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
*/
[attribute,bound] com::sun::star::awt::FontSlant CharPostureAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the value of the locale.
*/
[attribute,bound] com::sun::star::lang::Locale CharLocaleAsian
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This value contains the height of the characters in point.
*/
[attribute,bound] float CharHeightComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the value of the font weight.@see com::sun::star::awt::FontWeight
*/
[attribute,bound] float CharWeightComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property specifies the name of the font style.
<p>It may contain more than one name separated by comma.</p>
*/
[attribute,bound] string CharFontNameComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the name of the font style.
<p>This property may be empty.</p>
*/
[attribute,bound] string CharFontStyleNameComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains font family as specified in
com.sun.star.awt.FontFamily .
*/
[attribute,bound] short CharFontFamilyComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the text encoding of the font as specified in
com.sun.star.awt.CharSet.
*/
[attribute,bound] short CharFontCharSetComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the font pitch as specified in com.sun.star.awt.FontPitch.
*/
[attribute,bound] short CharFontPitchComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** This property contains the value of the posture of the document.@see com::sun::star::awt::FontSlant
*/
[attribute,bound] com::sun::star::awt::FontSlant CharPostureComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
/** contains the value of the locale.
*/
[attribute,bound] com::sun::star::lang::Locale CharLocaleComplex
{
set raises ( com::sun::star::beans::UnknownPropertyException );
get raises ( com::sun::star::beans::UnknownPropertyException );
};
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */