ooodev.adapter.awt.uno_control_button_model_partial module

class ooodev.adapter.awt.uno_control_button_model_partial.UnoControlButtonModelPartial(component)[source]

Bases: UnoControlModelPartial

Partial class for UnoControlButtonModel.

Parameters:: component (UnoControlButtonModel) –

__init__(component)[source]

Constructor

Parameters:: component (Any) – Component that implements com.sun.star.awt.UnoControlButtonModel service.
Return type:: None

set_font_descriptor(font_descriptor)[source]

Sets the font descriptor of the control.

Parameters:: font_descriptor (FontDescriptor, FontDescriptorStructComp) – UNO Struct - Font descriptor to set.
Return type:: None

Note

The font_descriptor property can also be used to set the font descriptor.

Hint

FontDescriptor can be imported from ooo.dyn.awt.font_descriptor.

Return type:: None
Parameters:: font_descriptor (FontDescriptor | FontDescriptorStructComp) –

property align: AlignKind | None

Get/Sets the horizontal alignment of the text in the control.

optional

Hint

AlignKind can be imported from ooodev.utils.kind.align_kind.

Return type:: AlignKind | None

property background_color: Color

Gets/Set the background color of the control.

Returns:: Color
Return type:: Color

property default_button: bool

Gets/Sets that the button is the default button on the document.

Return type:: bool

property enabled: bool

Gets/Sets whether the control is enabled or disabled.

Return type:: bool

property focus_on_click: bool

Gets/Sets 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.

Return type:: bool

property font_descriptor: FontDescriptorStructComp

Gets/Sets the Font Descriptor.

Setting value can be done with a FontDescriptor or FontDescriptorStructComp object.

Returns:: Font Descriptor
Return type:: FontDescriptorStructComp

Hint

FontDescriptor can be imported from ooo.dyn.awt.font_descriptor.

property font_emphasis_mark: FontEmphasisEnum

Gets/Sets the FontEmphasis value of the text in the control.

Note

Value can be set with FontEmphasisEnum or int.

Hint

FontEmphasisEnum can be imported from ooo.dyn.text.font_emphasis.

Return type:: FontEmphasisEnum

property font_relief: FontReliefEnum

Gets/Sets FontRelief value of the text in the control.

Note

Value can be set with FontReliefEnum or int.

Hint

FontReliefEnum can be imported from ooo.dyn.text.font_relief.

Return type:: FontReliefEnum

property graphic: com.sun.star.graphic.XGraphic

specifies a graphic to be displayed at the button

If this property is present, it interacts with the image_url in the following way:

If image_url is set, graphic will be reset to an object as loaded from the given image URL, or None if image_url does not point to a valid image file.
If graphic is set, image_url will be reset to an empty string.

Return type:: XGraphic

property help_text: str

Get/Sets the help text of the control.

Return type:: str

property help_url: str

Gets/Sets the help URL of the control.

Return type:: str

property image_align: ImageAlignEnum

Gets/Sets the alignment of the image inside the button as image_align value.

Note

Value can be set with ImageAlignEnum or int.

Hint

ImageAlignEnum can be imported from ooo.dyn.awt.image_align

Return type:: ImageAlignEnum

property image_position: ImagePositionEnum | None

Gets/Sets the position of the image, if any, relative to the text, if any

Valid values of this property are specified with image_position.

If this property is present, it supersedes the ImageAlign property - setting one of both properties sets the other one to the best possible match.

optional

Note

Value can be set with ImagePositionEnum or int.

Hint

ImagePositionEnum can be imported from ooo.dyn.awt.image_position

Return type:: ImagePositionEnum | None

property image_url: str

Gets/Sets a URL to an image to use for the button.

Return type:: str

property label: str

Gets/Sets the label of the control.

Return type:: str

property multi_line: bool | None

Gets/Sets that the text may be displayed on more than one line.

optional

Return type:: bool | None

property printable: bool

Gets/Sets that the control will be printed with the document.

Return type:: bool

property push_button_type: PushButtonType

Gets/Sets the default action of the button as push_button_type value.

Note

Value can be set with PushButtonType or int.

Hint

PushButtonType can be imported from ooo.dyn.awt.push_button_type

Return type:: PushButtonType

property repeat: bool | None

Gets/Sets whether the mouse should show repeating behavior, i.e. repeatedly trigger an action when keeping pressed.

optional

Return type:: bool | None

property repeat_delay: int | None

Gets/Sets the mouse repeat delay, in milliseconds.

When the user presses a mouse in a control area where this triggers an action (such as spinning the value), 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.

optional

Return type:: int | None

property state: ButtonStateKind

Gets/Sets the state of the control.

If Toggle property is set to True, the pressed state is enabled and its pressed state can be obtained with this property.

Note

Value can be set with ButtonStateKind or int.

Hint

ButtonStateKind can be imported from ooodev.utils.kind.button_state_kind.

Return type:: ButtonStateKind

property tabstop: bool

Gets/Sets that the control can be reached with the TAB key.

Return type:: bool

property text_color: Color

Gets/Sets the text color of the control.

Returns:: Color
Return type:: Color

property text_line_color: Color

Gets/Sets the text line color of the control.

Returns:: Color
Return type:: Color

property toggle: bool | None

Gets/Sets 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.

optional

Return type:: bool | None

property vertical_align: VerticalAlignment | None

Gets/Sets the vertical alignment of the text in the control.

optional

Hint

VerticalAlignment can be imported from ooo.dyn.style.vertical_alignment

Return type:: VerticalAlignment | None