ooodev.adapter.awt.uno_control_list_box_model_partial module

class ooodev.adapter.awt.uno_control_list_box_model_partial.UnoControlListBoxModelPartial(component)[source]

Bases: UnoControlModelPartial

Partial class for UnoControlListBoxModel.

Parameters:: component (UnoControlListBoxModel) –

__init__(component)[source]

Constructor

Parameters:: component (Any) – Component that implements com.sun.star.awt.UnoControlListBoxModel 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 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/Set 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 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

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 item_separator_pos: int | None

specifies where an item separator - a horizontal line - is drawn.

If this is not NULL, then a horizontal line will be drawn between the item at the given position, and the following item.

optional

Maybe None

Return type:: int | None

property line_count: int

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

Return type:: int

property mouse_wheel_behavior: MouseWheelBehaviorEnum

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.

Note

Value can be set with MouseWheelBehaviorEnum or int.

Hint

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

Return type:: MouseWheelBehaviorEnum

property multi_selection: bool

Gets/Sets if more than one entry can be selected.

Return type:: bool

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 selected_items: Tuple[int, ...]

Gets specifies the sequence of selected items, identified by the position.

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

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

specifies the list of items.

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

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 typed_item_list: Tuple[Any, ...]

Gets/Sets the list of raw typed (not stringized) items.

This list corresponds with the StringItemList and if given has to be of the same length, the elements’ positions matching those of their string representation in string_item_list.

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

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