LibreOffice
LibreOffice 5.0 SDK API Reference
|
specifies the standard model of an UnoControlEdit. More...
import "UnoControlEditModel.idl";
Included Services | |
service | com::sun::star::awt::UnoControlModel |
![]() | |
service | com::sun::star::awt::UnoControlDialogElement |
This service is present when the control model is embedded in an UnoControlDialogModel. More... | |
Public Attributes | |
short | Align |
specifies the horizontal alignment of the text in the control. More... | |
boolean | AutoHScroll |
If set to true an horizontal scrollbar will be added automatically when needed. More... | |
boolean | AutoVScroll |
If set to true an vertical scrollbar will be added automatically when needed. More... | |
com::sun::star::util::Color | BackgroundColor |
specifies the background color (RGB) of the control. More... | |
short | Border |
specifies the border style of the control. More... | |
long | BorderColor |
specifies the color of the border, if present More... | |
short | EchoChar |
specifies the echo character for a password edit field. More... | |
boolean | Enabled |
determines whether the control is enabled or disabled. More... | |
com::sun::star::awt::FontDescriptor | FontDescriptor |
specifies the font attributes of the text in the control. More... | |
short | FontEmphasisMark |
specifies the com::sun::star::text::FontEmphasis value of the text in the control. More... | |
short | FontRelief |
specifies the com::sun::star::text::FontRelief value of the text in the control. More... | |
boolean | HardLineBreaks |
specifies if hard line breaks will be returned in the XTextComponent::getText() method. More... | |
string | HelpText |
specifies the help text of the control. More... | |
string | HelpURL |
specifies the help URL of the control. More... | |
boolean | HideInactiveSelection |
specifies whether the selection in the control should be hidden when the control is not active (focused). More... | |
boolean | HScroll |
specifies if the content of the control can be scrolled in the horizontal direction. More... | |
short | LineEndFormat |
specifies which line end type should be used for multi line text More... | |
short | MaxTextLen |
specifies the maximum character count. More... | |
boolean | MultiLine |
specifies that the control may have more than one line. More... | |
boolean | PaintTransparent |
specifies whether the control paints it background or not. More... | |
boolean | Printable |
specifies that the control will be printed with the document. More... | |
boolean | ReadOnly |
specifies that the content of the control cannot be modified by the user. More... | |
boolean | Tabstop |
specifies that the control can be reached with the TAB key. More... | |
string | Text |
specifies the text displayed in the control. More... | |
com::sun::star::util::Color | TextColor |
specifies the text color (RGB) of the control. More... | |
com::sun::star::util::Color | TextLineColor |
specifies the text line color (RGB) of the control. More... | |
boolean | VScroll |
specifies if the content of the control can be scrolled in the vertical direction. More... | |
short | WritingMode |
denotes the writing mode used in the control, as specified in the com::sun::star::text::WritingMode2 constants group. More... | |
com::sun::star::style::VerticalAlignment | VerticalAlign |
specifies the vertical alignment of the text in the control. More... | |
![]() | |
string | DefaultControl |
specifies the service name of the default control for this model. More... | |
Additional Inherited Members | |
![]() | |
interface | com::sun::star::awt::XControlModel |
interface | com::sun::star::lang::XComponent |
interface | com::sun::star::beans::XPropertySet |
interface | com::sun::star::beans::XMultiPropertySet |
interface | com::sun::star::io::XPersistObject |
interface | com::sun::star::util::XCloneable |
![]() | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. More... | |
void | acquire () |
increases the reference counter by one. More... | |
void | release () |
decreases the reference counter by one. More... | |
![]() | |
void | dispose () |
The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
void | addEventListener ([in] XEventListener xListener) |
adds an event listener to the object. More... | |
void | removeEventListener ([in] XEventListener aListener) |
removes an event listener from the listener list. More... | |
![]() | |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValue ([in] string aPropertyName,[in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the value of the property with the specified name. More... | |
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
void | addPropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XPropertyChangeListener to the specified property. More... | |
void | removePropertyChangeListener ([in] string aPropertyName,[in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XPropertyChangeListener from the listener list. More... | |
void | addVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
void | removeVetoableChangeListener ([in] string PropertyName,[in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XVetoableChangeListener from the listener list. More... | |
![]() | |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValues ([in] sequence< string > aPropertyNames,[in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the values to the properties with the specified names. More... | |
sequence< any > | getPropertyValues ([in] sequence< string > aPropertyNames) |
void | addPropertiesChangeListener ([in] sequence< string > aPropertyNames,[in] com::sun::star::beans::XPropertiesChangeListener xListener) |
adds an XPropertiesChangeListener to the specified property with the specified names. More... | |
void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener) |
removes an XPropertiesChangeListener from the listener list. More... | |
void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames,[in] com::sun::star::beans::XPropertiesChangeListener xListener) |
fires a sequence of PropertyChangeEvents to the specified listener. More... | |
![]() | |
string | getServiceName () |
gives the service name of the object More... | |
void | write ([in] com::sun::star::io::XObjectOutputStream OutStream) raises ( com::sun::star::io::IOException ) |
writes all the persistent data of the object to the stream. More... | |
void | read ([in] com::sun::star::io::XObjectInputStream InStream) raises ( com::sun::star::io::IOException ) |
reads all the persistent data of the object from the stream. More... | |
![]() | |
com::sun::star::util::XCloneable | createClone () |
creates a copy of the object. More... | |
![]() | |
long | Height |
specifies the height of the control. More... | |
string | Name |
specifies the name of the control. More... | |
string | PositionX |
specifies the horizontal position of the control. More... | |
string | PositionY |
specifies the vertical position of the control. More... | |
long | Step |
specifies the step of the control. More... | |
short | TabIndex |
specifies the tabindex of the control. More... | |
string | Tag |
specifies the tag of the control. More... | |
long | Width |
specifies the width of the control. More... | |
specifies the standard model of an UnoControlEdit.
|
property |
specifies the horizontal alignment of the text in the control.
0: left 1: center 2: right
|
optionalproperty |
If set to true an horizontal scrollbar will be added automatically when needed.
|
optionalproperty |
If set to true an vertical scrollbar will be added automatically when needed.
|
property |
specifies the background color (RGB) of the control.
|
property |
specifies the border style of the control.
0: No border 1: 3D border 2: simple border
|
optionalproperty |
specifies the color of the border, if present
Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the BorderColor setting.
|
optionalproperty |
specifies the echo character for a password edit field.
|
property |
determines whether the control is enabled or disabled.
specifies the font attributes of the text in the control.
|
property |
specifies the com::sun::star::text::FontEmphasis value of the text in the control.
|
property |
specifies the com::sun::star::text::FontRelief value of the text in the control.
|
property |
specifies if hard line breaks will be returned in the XTextComponent::getText() method.
|
property |
specifies the help text of the control.
|
property |
specifies the help URL of the control.
|
optionalproperty |
specifies whether the selection in the control should be hidden when the control is not active (focused).
|
property |
specifies if the content of the control can be scrolled in the horizontal direction.
|
optionalproperty |
specifies which line end type should be used for multi line text
Controls working with this model care for this setting when the user enters text. Every line break entered into the control will be treated according to this setting, so that the Text property always contains only line ends in the format specified.
Possible values are all constants from the LineEndFormat group.
Note that this setting is usually not relevant when you set new text via the API. No matter which line end format is used in this new text then, usual control implementations should recognize all line end formats and display them properly.
|
property |
specifies the maximum character count.
There's no limitation, if set to 0.
|
property |
specifies that the control may have more than one line.
|
optionalproperty |
specifies whether the control paints it background or not.
|
property |
specifies that the control will be printed with the document.
|
property |
specifies that the content of the control cannot be modified by the user.
|
property |
specifies that the control can be reached with the TAB key.
|
property |
specifies the text displayed in the control.
|
property |
specifies the text color (RGB) of the control.
|
property |
specifies the text line color (RGB) of the control.
|
optionalproperty |
specifies the vertical alignment of the text in the control.
|
property |
specifies if the content of the control can be scrolled in the vertical direction.
|
optionalproperty |
denotes the writing mode used in the control, as specified in the com::sun::star::text::WritingMode2 constants group.
Only com::sun::star::text::WritingMode2::LR_TB and com::sun::star::text::WritingMode2::RL_TB are supported at the moment.