LibreOffice
LibreOffice 5.0 SDK API Reference
|
import "XImageControl.idl";
Exported Interfaces | |
interface | XReportControlModel |
interface | com::sun::star::form::XImageProducerSupplier |
supplies the caller with an com::sun::star::awt::XImageProducer. More... | |
![]() | |
interface | XReportComponent |
allows the creation of sub reports. More... | |
interface | XReportControlFormat |
interface | com::sun::star::container::XContainer |
allows to register listeners to be notified of changes in the container. More... | |
interface | com::sun::star::container::XIndexContainer |
gives access to the com::sun::star::report::XFormatCondition elements by index. More... | |
![]() | |
interface | com::sun::star::util::XCloneable |
interface | com::sun::star::container::XChild |
identifies the component as a candidate for being part of a report. More... | |
interface | com::sun::star::lang::XComponent |
allows life-time control of report components. More... | |
interface | com::sun::star::drawing::XShape |
interface | com::sun::star::beans::XPropertySet |
gives access to the properties. More... | |
Public Attributes | |
string | ImageURL |
specifies an URL to an image to use for the control. More... | |
short | ScaleMode { set raises(com::sun::star::lang::IllegalArgumentException); } |
defines how to scale the image More... | |
boolean | PreserveIRI |
Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document. More... | |
![]() | |
string | DataField { set raises(com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
Specifies which content should be shown. More... | |
boolean | PrintWhenGroupChange { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
Specifies that the element gets printed when the group changes. More... | |
string | ConditionalPrintExpression { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
Describes the print expression of the report control model. More... | |
![]() | |
string | Name { set raises(com::sun::star::beans::PropertyVetoException); } |
the name of the component. More... | |
long | Height { set raises(com::sun::star::beans::PropertyVetoException); } |
specifies the height of the control. More... | |
long | PositionX |
specifies the horizontal position of the control. More... | |
long | PositionY |
specifies the vertical position of the control. More... | |
long | Width { set raises(com::sun::star::beans::PropertyVetoException); } |
specifies the width of the control. More... | |
short | ControlBorder { set raises(com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the border style of the control. More... | |
long | ControlBorderColor { set raises(com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the color of the border, if present More... | |
boolean | PrintRepeatedValues { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
Specifies that recurring values are printed. More... | |
sequence< string > | MasterFields { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
is used for subreports and contains the names of columns of the parent report. More... | |
sequence< string > | DetailFields { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
is used for subreports and contains the names of the columns of the subreport which are related to the master fields of the parent report. More... | |
com::sun::star::report::XSection | Section |
Specifies the section where the control belongs to. More... | |
![]() | |
com::sun::star::util::Color | ControlBackground { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the background color (RGB) of the control. More... | |
boolean | ControlBackgroundTransparent { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
determines if the back ground color is set to transparent. More... | |
short | ParaAdjust { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the horizontal alignment of the text. More... | |
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. More... | |
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. More... | |
com::sun::star::awt::FontDescriptor | FontDescriptorComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the font attributes of the text in the control. More... | |
short | ControlTextEmphasis { 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. More... | |
short | CharEmphasis { 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. More... | |
boolean | CharCombineIsOn { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
determines whether text is formatted in two lines. More... | |
string | CharCombinePrefix { 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. More... | |
string | CharCombineSuffix { 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. More... | |
boolean | CharHidden { 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. More... | |
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 shadow effect. More... | |
boolean | CharContoured { 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. More... | |
short | CharCaseMap { 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. More... | |
com::sun::star::lang::Locale | CharLocale { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the value of the locale. More... | |
short | CharEscapement { 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. More... | |
byte | CharEscapementHeight { 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. More... | |
boolean | CharAutoKerning { 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. More... | |
short | CharKerning { 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. More... | |
boolean | CharFlash { 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. More... | |
short | CharRelief { 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. More... | |
string | CharFontName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This attribute specifies the name of the font style. More... | |
string | CharFontStyleName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This attribute contains the name of the font style. More... | |
short | CharFontFamily { 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 . More... | |
short | CharFontCharSet { 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. More... | |
short | CharFontPitch { 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. More... | |
com::sun::star::util::Color | CharColor { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the text color (RGB) of the control. More... | |
com::sun::star::util::Color | CharUnderlineColor { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
specifies the text line color (RGB) of the control. More... | |
float | CharHeight { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This value contains the height of the characters in point. More... | |
short | CharUnderline { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This attribute contains the value for the character underline. More... | |
float | CharWeight { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This attribute contains the value of the font weight. More... | |
com::sun::star::awt::FontSlant | CharPosture { 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. More... | |
short | CharStrikeout { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
determines the type of the strike out of the character. More... | |
boolean | CharWordMode { 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. More... | |
short | CharRotation { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
determines the rotation of a character in degree. More... | |
short | CharScaleWidth { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
determines the percentage value for scaling the width of characters. More... | |
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); } |
specifies the vertical alignment of the text in the control. More... | |
string | HyperLinkURL { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the URL of a hyperlink (if set). More... | |
string | HyperLinkTarget { 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). More... | |
string | HyperLinkName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the name of the hyperlink (if set). More... | |
string | VisitedCharStyleName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the character style name for visited hyperlinks. More... | |
string | UnvisitedCharStyleName { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the character style name for unvisited hyperlinks. More... | |
float | CharHeightAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This value contains the height of the characters in point. More... | |
float | CharWeightAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This property contains the value of the font weight. More... | |
string | CharFontNameAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This property specifies the name of the font style. More... | |
string | CharFontStyleNameAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This property contains the name of the font style. More... | |
short | CharFontFamilyAsian { 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 . More... | |
short | CharFontCharSetAsian { 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. More... | |
short | CharFontPitchAsian { 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. More... | |
com::sun::star::awt::FontSlant | CharPostureAsian { 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. More... | |
com::sun::star::lang::Locale | CharLocaleAsian { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the value of the locale. More... | |
float | CharHeightComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This value contains the height of the characters in point. More... | |
float | CharWeightComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This property contains the value of the font weight. More... | |
string | CharFontNameComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This property specifies the name of the font style. More... | |
string | CharFontStyleNameComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
This property contains the name of the font style. More... | |
short | CharFontFamilyComplex { 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 . More... | |
short | CharFontCharSetComplex { 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. More... | |
short | CharFontPitchComplex { 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. More... | |
com::sun::star::awt::FontSlant | CharPostureComplex { 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. More... | |
com::sun::star::lang::Locale | CharLocaleComplex { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); } |
contains the value of the locale. More... | |
Additional Inherited Members | |
![]() | |
XFormatCondition | createFormatCondition () raises ( com::sun::star::uno::Exception ) |
Creates a format condition. More... | |
![]() | |
com::sun::star::awt::XImageProducer | getImageProducer () |
accesses the image producer. More... | |
supplies the caller with an com::sun::star::awt::XImageProducer.
Other components can register as com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.
Whenever the com::sun::star::awt::UnoControlImageControlModel::ImageURL property is changed, the model loads the specified image, and sets it as image source at its com::sun::star::awt::XImageProducer. Then, all com::sun::star::awt::XImageConsumers are notified and supplied with the binary data of the image.
Usually, controls acting for an ImageControl model are consumers, and use the data stream to display the image
interface XReportControlModel |
|
attributebound |
specifies an URL to an image to use for the control.
|
attributebound |
Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document.
If the data field contains something different as string then this attribute will be ignored.
|
attributebound |
defines how to scale the image
If this property is present, it supersedes the ScaleImage property.
The value of this property is one of the com::sun::star::awt::ImageScaleMode constants.