Class ModelRadioButton

class ooodev.dialog.dl_control.model.model_radio_button.ModelRadioButton(model)

Bases: ModelPropPartial, UnoControlRadioButtonModelPartial, ModelDialogElementPartial

__init__(model)

Constructor

Parameters:

• component (UnoControlModel) – UNO Component that implements com.sun.star.awt.UnoControlModel service.

• model (com.sun.star.awt.UnoControlModel) –

Return type:

None

add_event_listener(listener)

Adds an event listener to the component.

Parameters:

listener (XEventListener) – The event listener to be added.

Return type:

None

add_property_change_listener(name, listener)

Adds a listener for property changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be added.

Return type:

None

add_vetoable_change_listener(name, listener)

Adds a listener for vetoable changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be added.

Return type:

None

create_clone()

Creates a clone of the object.

Returns:

The clone.

Return type:

XCloneable

dispose()

Disposes the component.

Return type:

None

get_property_set_info()

Returns the property set info.

Returns:

The property set info.

Return type:

XPropertySetInfo

get_property_value(name)

Returns the value of a property.

Parameters:

name (str) – The name of the property.

Returns:

The value of the property.

Return type:

Any

remove_event_listener(listener)

Removes an event listener from the component.

Parameters:

listener (XEventListener) – The event listener to be removed.

Return type:

None

remove_property_change_listener(name, listener)

Removes a listener for property changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be removed.

Return type:

None

remove_vetoable_change_listener(name, listener)

Removes a listener for vetoable changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be removed.

Return type:

None

set_font_descriptor(font_descriptor)

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) –

set_property_value(name, value)

Sets the value of a property.

Parameters:

• name (str) – The name of the property.

• value (Any) – The value of the property.

Return type:

None

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 | None

Gets/Set the background color of the control.

optional

Returns:

Color or None if not set.

Return type:

Color | None

property context_writing_mode: int

Get or set the context_writing_mode property.

Return type:

int

property enable_visible: bool

Get or set the enable_visible property.

Return type:

bool

property enabled: bool

Gets/Sets whether the control is enabled or disabled.

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: XGraphic | None

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.

optional

Return type:

XGraphic | None

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_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 | None

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

optional

Return type:

str | None

property label: str

Gets/Sets the label of the control.

Return type:

str

property model: com.sun.star.awt.UnoControlModel

Uno Control Model

Return type:

UnoControlModel

property multi_line: bool | None

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

optional

Return type:

bool | None

property picture: str

Gets/Sets the picture for the control

When setting the value it can be a string or a Path object. If a string is passed it can be a URL or a path to a file. Value such as file:///path/to/image.png and /path/to/image.png are valid. Relative paths are supported.

Returns:

The picture URL in the format of file:///path/to/image.png or empty string if no picture is set.

Return type:

str

property printable: bool

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

Return type:

bool

property state: StateKind

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 StateKind or int.

Hint

• StateKind can be imported from ooodev.utils.kind.state_kind

Return type:

StateKind

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 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

property visual_effect: VisualEffectEnum | None

specifies a visual effect to apply to the check box control

Possible values for this property are VisualEffect.FLAT and VisualEffect.LOOK3D.

optional

Note

Value can be set with VisualEffectEnum or int.

Hint

• VisualEffectEnum can be imported from ooo.dyn.awt.visual_effect

Return type:

VisualEffectEnum | None

property writing_mode: int | None

Denotes the writing mode used in the control, as specified in the com.sun.star.text.WritingMode2 constants group.

Only LR_TB (0) and RL_TB (1) are supported at the moment.

optional

Return type:

int | None