Class CtlComboBox

Introduction

Class for working with combo box controls in a dialog.

EventArgsCallbackT

All EventArgsCallbackT callbacks include control_src as a keyword argument.

A callback can be in the format of:

def on_some_event(
    src: Any, event: EventArgs, control_src: CtlComboBox, *args, **kwargs
) -> None:
    pass

or

def on_some_event(src: Any, event: EventArgs, *args, **kwargs) -> None:
    # can get control from kwargs
    ctl = cast(CtlComboBox, kwargs['control_src'])

Class

class ooodev.dialog.dl_control.CtlComboBox(ctl)[source]

Bases: DialogControlBase, UnoControlComboBoxModelPartial, ActionEvents, ItemEvents, TextEvents

Class for ComboBox Control

__init__(ctl)[source]

Constructor

Parameters:: ctl (UnoControlComboBox) – Button Control
Return type:: None

add_event_action_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_action_performed(cb)

Adds a listener for an event.

Event is invoked when an action is performed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.ActionEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_gained(cb)

Adds a listener for an event.

Event is invoked when a window gains the keyboard focus.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.FocusEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_lost(cb)

Adds a listener for an event.

Event is invoked when a window loses the keyboard focus.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.FocusEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_item_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_item_state_changed(cb)

Adds a listener for an event.

Event is invoked when an item changes its state.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.ItemEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_pressed(cb)

Adds a listener for an event.

Event is invoked when a key has been pressed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.KeyEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_released(cb)

Adds a listener for an event.

Event is invoked when a key has been released.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.KeyEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_listener(listener)

Adds an event listener to the component.

Parameters:: listener (XEventListener) – The event listener to be added.
Return type:: None

add_event_mouse_dragged(cb)

Adds a listener for an event.

Event is invoked when a mouse button is pressed on a window and then dragged.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_entered(cb)

Adds a listener for an event.

Event is invoked when the mouse enters a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_exited(cb)

Adds a listener for an event.

Event is invoked when the mouse exits a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_motion_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_moved(cb)

Adds a listener for an event.

Event Is invoked when the mouse pointer has been moved on a window (with no buttons down).

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_pressed(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_released(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been released on a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

add_event_paint_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_properties_change(names, cb)

Add properties to listen for changes.

Parameters:

names (Iterable[str]) – One or more property names to listen for changes.
cb (EventArgsCallbackT) – Callback that is invoked when an event is triggered.

Raises:

ValueError – If names is empty.

Return type:

None

Note

The callback EventArgs.event_data will contain a tuple of com.sun.star.beans.PropertyChangeEvent objects.

Each time this method is called, the previous names are removed and the new names are added.

add_event_property_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_property_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_text_changed(cb)

Adds a listener for an event.

Event is invoked when the text has changed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.TextEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_text_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_vetoable_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_window_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_hidden(cb)

Adds a listener for an event.

Event is invoked when the window has been hidden.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_moved(cb)

Adds a listener for an event.

Event is invoked when the window has been moved.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_paint(cb)

Adds a listener for an event.

Event Is invoked when a region of the window became invalid, e.g. when another window has been moved away.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.PaintEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_resized(cb)

Adds a listener for an event.

Event is invoked when the window has been resized.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_shown(cb)

Adds a listener for an event.

Event is invoked when the window has been shown.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

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

apply_styles(*styles)

Applies styles to control

Parameters:: *styles (StyleT) – Styles to apply
Return type:: None

static create(win, **kwargs)[source]

Creates a new instance of the control.

Keyword arguments are optional. Extra Keyword args are passed to the control as property values.

Parameters:

win (XWindowPeer) – Parent Window
kwargs (Any) –

Keyword Arguments:

x (int, UnitT, optional) – X Position in Pixels or UnitT.
y (int, UnitT, optional) – Y Position in Pixels or UnitT.
width (int, UnitT, optional) – Width in Pixels or UnitT.
height (int, UnitT, optional) – Height in Pixels or UnitT.

Returns:

New instance of the control.

Return type:

CtlComboBox

Note

The UnoControlDialogElement interface is not included when creating the control with a window peer.

create_clone()

Creates a clone of the object.

Returns:: The clone.
Return type:: XCloneable

dispose()

Disposes the component.

Return type:: None

fire_event_properties_change(names)

Fires a sequence of PropertyChangeEvents

Parameters:: names (Iterable[str]) – Sequence of property names to fire event for.
Return type:: None

getImplementationId()

getTypes()

get_control_kind()[source]

Gets the control kind. Returns DialogControlKind.COMBOBOX

Return type:: DialogControlKind

get_control_named_kind()[source]

Gets the control named kind. Returns DialogControlNamedKind.COMBOBOX

Return type:: DialogControlNamedKind

get_control_props()

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

get_property_set()

Gets the property set for this control

Return type:: XPropertySet

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

get_uno_srv_name()[source]

Returns com.sun.star.awt.UnoControlComboBox

Return type:: str

get_view()

Return type:: XControl

get_view_ctl()[source]

Return type:: UnoControlComboBox

remove_event_action_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_action_performed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_gained(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_lost(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_item_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_item_state_changed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_pressed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_released(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (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_event_mouse_dragged(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_entered(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_exited(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_motion_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_moved(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_pressed(cb)

Removes a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_released(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_observer(observer)

Removes an observer

Parameters:: observer (EventObserver) – One or more observers to add.
Returns:: True if observer has been removed; Otherwise, False.
Return type:: bool

remove_event_paint_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_properties_listener()

Remove Properties Listener

Return type:: None

remove_event_property_change(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_property_change_events_disposing(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_text_changed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_text_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_vetoable_change(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_vetoable_change_events_disposing(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_window_events_disposing(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_hidden(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_moved(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_paint(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_resized(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_shown(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

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_list_data(data)[source]

Sets the list data

Parameters:: data (Iterable[str]) – List box entries
Return type:: None

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

subscribe_event(event_name, callback)

Add an event listener to current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

Return type:

None

trigger_event(event_name, event_args)

Trigger an event on current instance.

Parameters:

event_name (str) – Event Name.
event_args (EventArgsT) – Event Args.

Return type:

None

unsubscribe_event(event_name, callback)

Remove an event listener from current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

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

Get/Sets whether automatic completion of text is enabled.

Return type:: bool

property background_color: Color

Gets/Set the background color of the control.

Returns:: Color
Return type:: Color

property border: BorderKind

Gets/Sets the border style.

Note

Value can be set with BorderKind or int.

Hint

BorderKind can be imported from ooodev.utils.kind.border_kind

Return type:: BorderKind

property border_color: Color | None

Gets/Sets the color of the border, if present

Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the border_color setting.

optional

Returns:: Color or None if not set.
Return type:: Color | None

property drop_down: bool

Gets/Sets if the control has a drop down button.

Return type:: bool

property enabled: bool

Gets/Sets whether the control is enabled or disabled.

Return type:: bool

property event_observer: EventObserver

Gets/Sets The Event Observer for this instance.

Return type:: EventObserver

property events_listener_action: ActionListener

Returns listener

Return type:: ActionListener

property events_listener_focus: FocusListener

Returns listener

Return type:: FocusListener

property events_listener_item: ItemListener

Returns listener

Return type:: ItemListener

property events_listener_key: KeyListener

Returns listener

Return type:: KeyListener

property events_listener_mouse: MouseListener

Returns listener

Return type:: MouseListener

property events_listener_mouse_motion: MouseMotionListener

Returns listener

Return type:: MouseMotionListener

property events_listener_paint: PaintListener

Returns listener

Return type:: PaintListener

property events_listener_properties_change_implement: PropertiesChangeListener

Returns listener

Return type:: PropertiesChangeListener

property events_listener_text: TextListener

Returns listener

Return type:: TextListener

property events_listener_window: WindowListener

Returns listener

Return type:: WindowListener

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 help_text: str

Gets/Sets the tip text

Return type:: str

property help_url: str

Gets/Sets the help URL of the control.

Return type:: str

property hide_inactive_selection: bool | None

Gets/Sets whether the selection in the control should be hidden when the control is not active (focused).

optional

Return type:: bool | None

property line_count: int

Gets/Sets the maximum line count displayed in the drop down box.

Return type:: int

property list_count: int

Gets the number of items in the combo box

Return type:: int

property list_index: int

Gets which item index is selected

Return type:: int
Returns:: Index of the first selected item or -1 if no items are selected.

property lo_inst: LoInst

Lo Instance

Return type:: LoInst

property max_text_len: int

Gets/Sets the maximum character count.

There’s no limitation, if set to 0.

Return type:: int

property model: com.sun.star.awt.UnoControlComboBoxModel

Uno Control Model

Return type:: UnoControlComboBoxModel

property model_ex: ModelComboBox

Gets the Model for the control.

This is a wrapped instance for the model property. It add some additional properties and methods to the model.

Return type:: ModelComboBox

property mouse_wheel_behavior: MouseWheelBehaviorEnum | None

Gets/Sets how the mouse wheel can be used to scroll through the control’s content.

Usually, the mouse wheel scroll through the control’s entry list. Using this property,you can control under which circumstances this is possible.

optional

Note

Value can be set with MouseWheelBehaviorEnum or int.

Hint

MouseWheelBehaviorEnum can be imported from ooo.dyn.awt.mouse_wheel_behavior

Return type:: MouseWheelBehaviorEnum | None

property printable: bool

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

Return type:: bool

property read_only: bool

Gets/Sets that the content of the control cannot be modified by the user.

Return type:: bool

property row_source: Tuple[str, ...]

Gets/Sets the row source.

When setting the row source, the combobox will be cleared and the new items will be added.

The value passed in can be any iterable string such as a list or tuple of strings.

Return type:: Tuple[str, ...]

property tabstop: bool

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

Return type:: bool

property text: str

Gets/Sets the text displayed in the control.

Return type:: str

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 tip_text: str

Gets/Sets the tip text

Return type:: str

property view: com.sun.star.awt.UnoControlComboBox

Uno Control

Return type:: UnoControlComboBox

property view_ex: ViewComboBox

Gets the View for the control.

This is a wrapped instance for the view property. It add some additional properties and methods to the view.

Return type:: ViewComboBox

property visible: bool

Gets/Sets the visible state for the control

Return type:: bool

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