module ctl_base

class ooodev.dialog.dl_control.ctl_base.CtlBase(ctl)[source]

Bases: Base, LoInstPropsPartial, ViewPropPartial, ModelPropPartial, EventsPartial

Control Base Class

Parameters:

ctl (Any) –

__init__(ctl)[source]

Constructor.

Parameters:

  • lo_inst (LoInst, optional) – Lo instance.

  • ctl (Any) –

Return type:

None

get_control_props()[source]

Gets property set for a control model

Parameters:

control_model (Any) – control model

Returns:

Property set

Return type:

XPropertySet | None

get_model()[source]

Gets the Model for the control

Return type:

XControlModel

get_uno_srv_name()[source]

Get Uno service name

Return type:

str

get_view()[source]
Return type:

XControl

get_view_ctl()
Return type:

XControl

property visible: bool

Gets/Sets the visible state for the control

Return type:

bool

class ooodev.dialog.dl_control.ctl_base.CtlListenerBase(ctl)[source]

Bases: CtlBase, FocusEvents, KeyEvents, MouseEvents, MouseMotionEvents, PaintEvents, WindowEvents, PropertyChangeImplement, PropertiesChangeImplement, VetoableChangeImplement

Class for managing table ConfigurationProvider Component.

Note

This is a Dynamic class that is created at runtime. This means that the class is created at runtime and not defined in the source code. In addition, the class may be created with additional classes implemented.

The Type hints for this class at design time may not be accurate. To check if a class implements a specific interface, use the isinstance function or is_supported_interface() methods which is always available in this class.

__init__(ctl)[source]

Constructor.

Parameters:

  • lo_inst (LoInst, optional) – Lo instance.

  • ctl (Any) –

Return type:

None

get_property_set()[source]

Gets the property set for this control

Return type:

XPropertySet

get_uno_srv_name()[source]

Get Uno service name

Return type:

str

class ooodev.dialog.dl_control.ctl_base.DialogControlBase(ctl)[source]

Bases: CtlListenerBase

Dialog Control Base Class. Only for Controls that have a model that can be added to a dialog

__init__(ctl)[source]

Constructor.

Parameters:

  • lo_inst (LoInst, optional) – Lo instance.

  • ctl (Any) –

Return type:

None

apply_styles(*styles)[source]

Applies styles to control

Parameters:

*styles (StyleT) – Styles to apply

Return type:

None

get_control_kind()[source]

Gets the control kind

Return type:

DialogControlKind

get_control_named_kind()[source]

Gets the control named kind

Return type:

DialogControlNamedKind

get_uno_srv_name()[source]

Get Uno service name

Return type:

str

property help_text: str

Gets/Sets the tip text

Return type:

str

property tip_text: str

Gets/Sets the tip text

Return type:

str