ooodev.adapter.awt.uno_control_check_box_model_partial module

class ooodev.adapter.awt.uno_control_check_box_model_partial.UnoControlCheckBoxModelPartial(component)[source]

Bases: UnoControlModelPartial

Partial class for UnoControlCheckBoxModel.

Parameters:: component (UnoControlCheckBoxModel) –

__init__(component)[source]

Constructor

Parameters:: component (Any) – Component that implements com.sun.star.awt.UnoControlCheckBoxModel service.

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 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 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 state: TriStateKind

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

Hint

TriStateKind is an enum and can be imported from ooodev.utils.kind.tri_state_kind

Return type:: TriStateKind

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 tri_state: bool

Gets/Sets that the control may have the state don't know.

Return type:: bool

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