Source code for ooodev.adapter.awt.uno_control_list_box_model_partial

from __future__ import annotations
import contextlib
from typing import Any, cast, TYPE_CHECKING, Tuple
from ooo.dyn.text.font_emphasis import FontEmphasisEnum
from ooo.dyn.text.font_relief import FontReliefEnum
from ooo.dyn.awt.mouse_wheel_behavior import MouseWheelBehaviorEnum
from ooodev.utils import info as mInfo
from import Events
from ooodev.utils.kind.align_kind import AlignKind
from ooodev.utils.kind.border_kind import BorderKind
from ooodev.utils.color import Color
from ooodev.adapter.awt.uno_control_model_partial import UnoControlModelPartial
from ooodev.adapter.awt.font_descriptor_struct_comp import FontDescriptorStructComp

    from import UnoControlListBoxModel  # Service
    from import FontDescriptor  # struct
    from import KeyValArgs

[docs]class UnoControlListBoxModelPartial(UnoControlModelPartial): """Partial class for UnoControlListBoxModel."""
[docs] def __init__(self, component: UnoControlListBoxModel): """ Constructor Args: component (Any): Component that implements ```` service. """ # pylint: disable=unused-argument self.__component = component UnoControlModelPartial.__init__(self, component=component) self.__event_provider = Events(self) self.__props = {} def on_comp_struct_changed(src: Any, event_args: KeyValArgs) -> None: prop_name = str(event_args.event_data["prop_name"]) if hasattr(self.__component, prop_name): setattr(self.__component, prop_name, event_args.source.component) self.__fn_on_comp_struct_changed = on_comp_struct_changed self.__event_provider.subscribe_event( "com_sun_star_awt_FontDescriptor_changed", self.__fn_on_comp_struct_changed )
[docs] def set_font_descriptor(self, font_descriptor: FontDescriptor | FontDescriptorStructComp) -> None: """ Sets the font descriptor of the control. Args: font_descriptor (FontDescriptor, FontDescriptorStructComp): UNO Struct - Font descriptor to set. 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``. """ self.font_descriptor = font_descriptor
# region Properties @property def font_descriptor(self) -> FontDescriptorStructComp: """ Gets/Sets the Font Descriptor. Setting value can be done with a ``FontDescriptor`` or ``FontDescriptorStructComp`` object. Returns: ~ooodev.adapter.awt.font_descriptor_struct_comp.FontDescriptorStructComp: Font Descriptor Hint: - ``FontDescriptor`` can be imported from ``ooo.dyn.awt.font_descriptor``. """ key = "FontDescriptor" prop = self.__props.get(key, None) if prop is None: prop = FontDescriptorStructComp(self.__component.FontDescriptor, key, self.__event_provider) self.__props[key] = prop return cast(FontDescriptorStructComp, prop) @font_descriptor.setter def font_descriptor(self, value: FontDescriptor | FontDescriptorStructComp) -> None: key = "FontDescriptor" if mInfo.Info.is_instance(value, FontDescriptorStructComp): self.__component.FontDescriptor = value.copy() else: self.__component.FontDescriptor = cast("FontDescriptor", value) if key in self.__props: del self.__props[key] @property def selected_items(self) -> Tuple[int, ...]: """Gets specifies the sequence of selected items, identified by the position.""" # SelectedItems is a miss reported type in current typings. # It reports as ``uno.ByteSequence`` but it is actually a ``Tuple[int, ...]``. return cast(Tuple[int, ...], self.__component.SelectedItems) @selected_items.setter def selected_items(self, value: Tuple[int, ...]) -> None: self.__component.SelectedItems = value # type: ignore @property def string_item_list(self) -> Tuple[str, ...]: """ specifies the list of items. """ return self.__component.StringItemList @string_item_list.setter def string_item_list(self, value: Tuple[str, ...]) -> None: self.__component.StringItemList = value @property def typed_item_list(self) -> 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 self.__component.TypedItemList @typed_item_list.setter def typed_item_list(self, value: Tuple[Any, ...]) -> None: self.__component.TypedItemList = value @property def align(self) -> 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``. """ with contextlib.suppress(AttributeError): return AlignKind(self.__component.Align) return None @align.setter def align(self, value: AlignKind | int) -> None: kind = AlignKind(int(value)) with contextlib.suppress(AttributeError): self.__component.Align = kind.value @property def background_color(self) -> Color: """ Gets/Set the background color of the control. Returns: ~ooodev.utils.color.Color: Color """ return Color(self.__component.BackgroundColor) @background_color.setter def background_color(self, value: Color) -> None: self.__component.BackgroundColor = value # type: ignore @property def border(self) -> 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 BorderKind(self.__component.Border) @border.setter def border(self, value: int | BorderKind) -> None: self.__component.Border = int(value) @property def border_color(self) -> 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: ~ooodev.utils.color.Color | None: Color or None if not set. """ with contextlib.suppress(AttributeError): return Color(self.__component.BorderColor) return None @border_color.setter def border_color(self, value: Color) -> None: with contextlib.suppress(AttributeError): self.__component.BorderColor = value # type: ignore @property def drop_down(self) -> bool: """ Gets/Sets if the control has a drop down button. """ return self.__component.Dropdown @drop_down.setter def drop_down(self, value: bool) -> None: self.__component.Dropdown = value @property def enabled(self) -> bool: """ Gets/Sets whether the control is enabled or disabled. """ return self.__component.Enabled @enabled.setter def enabled(self, value: bool) -> None: self.__component.Enabled = value @property def font_emphasis_mark(self) -> 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 FontEmphasisEnum(self.__component.FontEmphasisMark) @font_emphasis_mark.setter def font_emphasis_mark(self, value: int | FontEmphasisEnum) -> None: self.__component.FontEmphasisMark = int(value) @property def font_relief(self) -> 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 FontReliefEnum(self.__component.FontRelief) @font_relief.setter def font_relief(self, value: int | FontReliefEnum) -> None: self.__component.FontRelief = int(value) @property def help_text(self) -> str: """ Get/Sets the help text of the control. """ return self.__component.HelpText @help_text.setter def help_text(self, value: str) -> None: self.__component.HelpText = value @property def help_url(self) -> str: """ Gets/Sets the help URL of the control. """ return self.__component.HelpURL @help_url.setter def help_url(self, value: str) -> None: self.__component.HelpURL = value @property def item_separator_pos(self) -> 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 self.__component.ItemSeparatorPos @item_separator_pos.setter def item_separator_pos(self, value: int) -> None: self.__component.ItemSeparatorPos = value @property def line_count(self) -> int: """ Gets/Sets the maximum line count displayed in the drop down box. """ return self.__component.LineCount @line_count.setter def line_count(self, value: int) -> None: self.__component.LineCount = value @property def mouse_wheel_behavior(self) -> 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 MouseWheelBehaviorEnum(self.__component.MouseWheelBehavior) @mouse_wheel_behavior.setter def mouse_wheel_behavior(self, value: int | MouseWheelBehaviorEnum) -> None: self.__component.MouseWheelBehavior = int(value) @property def multi_selection(self) -> bool: """ Gets/Sets if more than one entry can be selected. """ return self.__component.MultiSelection @multi_selection.setter def multi_selection(self, value: bool) -> None: self.__component.MultiSelection = value @property def printable(self) -> bool: """ Gets/Sets that the control will be printed with the document. """ return self.__component.Printable @printable.setter def printable(self, value: bool) -> None: self.__component.Printable = value @property def read_only(self) -> bool: """ Gets/Sets that the content of the control cannot be modified by the user. """ return self.__component.ReadOnly @read_only.setter def read_only(self, value: bool) -> None: self.__component.ReadOnly = value @property def tabstop(self) -> bool: """ Gets/Sets that the control can be reached with the TAB key. """ return self.__component.Tabstop @tabstop.setter def tabstop(self, value: bool) -> None: self.__component.Tabstop = value @property def text_color(self) -> Color: """ Gets/Sets the text color of the control. Returns: ~ooodev.utils.color.Color: Color """ return Color(self.__component.TextColor) @text_color.setter def text_color(self, value: Color) -> None: self.__component.TextColor = value # type: ignore @property def text_line_color(self) -> Color: """ Gets/Sets the text line color of the control. Returns: ~ooodev.utils.color.Color: Color """ return Color(self.__component.TextLineColor) @text_line_color.setter def text_line_color(self, value: Color) -> None: self.__component.TextLineColor = value # type: ignore @property def writing_mode(self) -> int | None: """ Denotes the writing mode used in the control, as specified in the ```` constants group. Only LR_TB (``0``) and RL_TB (``1``) are supported at the moment. **optional** """ with contextlib.suppress(AttributeError): return self.__component.WritingMode return None @writing_mode.setter def writing_mode(self, value: int) -> None: with contextlib.suppress(AttributeError): self.__component.WritingMode = value
# endregion Properties