LibreOffice
LibreOffice 5.0 SDK API Reference
|
specifies the standard model of an UnoControlButton. More...
import "UnoControlButtonModel.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... | |
com::sun::star::util::Color | BackgroundColor |
specifies the background color (RGB) of the control. More... | |
boolean | DefaultButton |
specifies that the button is the default button on the document. More... | |
boolean | Enabled |
determines whether the control is enabled or disabled. More... | |
boolean | FocusOnClick |
specifies whether the button control should grab the focus when clicked. 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... | |
string | HelpText |
specifies the help text of the control. More... | |
string | HelpURL |
specifies the help URL of the control. More... | |
short | ImageAlign |
specifies the alignment of the image inside the button as ImageAlign value. More... | |
short | ImagePosition |
specifies the position of the image, if any, relative to the text, if any More... | |
string | ImageURL |
specifies an URL to an image to use for the button. More... | |
com::sun::star::graphic::XGraphic | Graphic |
specifies a graphic to be displayed at the button More... | |
string | Label |
specifies the label of the control. More... | |
boolean | MultiLine |
specifies that the text may be displayed on more than one line. More... | |
boolean | Printable |
specifies that the control will be printed with the document. More... | |
short | PushButtonType |
specifies the default action of the button as PushButtonType value. More... | |
boolean | Repeat |
specifies whether the control should show repeating behavior. More... | |
long | RepeatDelay |
specifies the mouse repeat delay, in milliseconds. More... | |
short | State |
specifies the state of the control. More... | |
boolean | Tabstop |
specifies that the control can be reached with the TAB key. 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 | Toggle |
specifies whether the button should toggle on a single operation. 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 UnoControlButton.
|
optionalproperty |
specifies the horizontal alignment of the text in the control.
0: left 1: center 2: right
|
property |
specifies the background color (RGB) of the control.
|
property |
specifies that the button is the default button on the document.
|
property |
determines whether the control is enabled or disabled.
|
optionalproperty |
specifies whether the button control should grab the focus when clicked.
If set to TRUE
(which is the default), the button control automatically grabs the focus when the user clicks onto it with the mouse.
If set to FALSE
, the focus is preserved when the user operates the button control with the mouse.
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.
|
optionalpropertytransient |
specifies a graphic to be displayed at the button
If this property is present, it interacts with the ImageURL in the following way:
NULL
if ImageURL does not point to a valid image file.
|
property |
specifies the help text of the control.
|
property |
specifies the help URL of the control.
|
property |
specifies the alignment of the image inside the button as ImageAlign value.
|
optionalproperty |
specifies the position of the image, if any, relative to the text, if any
Valid values of this property are specified with ImagePosition.
If this property is present, it supersedes the ImageAlign property - setting one of both properties sets the other one to the best possible match.
|
property |
specifies an URL to an image to use for the button.
|
property |
specifies the label of the control.
|
optionalproperty |
specifies that the text may be displayed on more than one line.
|
property |
specifies that the control will be printed with the document.
|
property |
specifies the default action of the button as PushButtonType value.
|
optionalproperty |
specifies whether the control should show repeating behavior.
Normally, when you click a button with the mouse, you need to release the mouse button, and press it again. With this property set to TRUE
, the button is repeatedly pressed while you hold down the mouse button.
|
optionalproperty |
specifies the mouse repeat delay, in milliseconds.
When the user presses a mouse in a control area where this triggers an action (such as pressing the button), then usual control implementations allow to repeatedly trigger this action, without the need to release the mouse button and to press it again. The delay between two such triggers is specified with this property.
|
property |
specifies the state of the control.
|
property |
specifies that the control can be reached with the TAB key.
|
property |
specifies the text color (RGB) of the control.
|
property |
specifies the text line color (RGB) of the control.
|
optionalproperty |
specifies whether the button should toggle on a single operation.
If this property is set to TRUE
, a single operation of the button control (pressing space while it is focused, or clicking onto it) toggles it between a pressed and a not pressed state.
The default for this property is FALSE
, which means the button behaves like a usual push button.
|
optionalproperty |
specifies the vertical alignment of the text in the control.