ooodev.adapter.awt.check_box_partial module
- class ooodev.adapter.awt.check_box_partial.CheckBoxPartial(component, interface=com.sun.star.awt.XCheckBox)[source]
Bases:
object
Partial class for XCheckBox.
- Parameters:
component (XCheckBox) –
interface (UnoInterface | None) –
- __init__(component, interface=com.sun.star.awt.XCheckBox)[source]
Constructor
- Parameters:
component (XCheckBox) – UNO Component that implements
com.sun.star.awt.XCheckBox
interface.interface (UnoInterface, optional) – The interface to be validated. Defaults to
XCheckBox
.
- Return type:
None
- add_item_listener(listener)[source]
Registers a listener for item events.
- Return type:
None
- Parameters:
listener (com.sun.star.awt.XItemListener) –
- enable_tri_state(enable)[source]
Enables or disables the tri state mode.
- Return type:
None
- Parameters:
enable (bool) –
- get_state()[source]
Gets the state of the check box.
- Returns:
The state of the check box.
- Return type:
Hint
TriStateKind
is an enum and can be importedooodev.utils.kind.tri_state_kind
.
- remove_item_listener(listener)[source]
Un-registers a listener for item events.
- Return type:
None
- Parameters:
listener (com.sun.star.awt.XItemListener) –
- set_label(label)[source]
Sets the label of the check box.
- Return type:
None
- Parameters:
label (str) –
- set_state(state)[source]
Sets the state of the check box.
- Return type:
None
- Parameters:
state (int | TriStateKind) –