Source code for ooodev.dialog.dl_control.ctl_progress_bar

# region imports
from __future__ import annotations
from typing import Any, cast, TYPE_CHECKING
import uno  # pylint: disable=unused-import

from ooodev.mock import mock_g
from ooodev.adapter.awt.uno_control_progress_bar_model_partial import UnoControlProgressBarModelPartial
from ooodev.utils.kind.dialog_control_kind import DialogControlKind
from ooodev.utils.kind.dialog_control_named_kind import DialogControlNamedKind
from ooodev.dialog.dl_control.ctl_base import DialogControlBase, _create_control

if TYPE_CHECKING:
    from com.sun.star.awt import UnoControlProgressBar  # service
    from com.sun.star.awt import UnoControlProgressBarModel  # service
    from com.sun.star.awt import XWindowPeer
    from ooodev.dialog.dl_control.model.model_progress_bar import ModelProgressBar
    from ooodev.dialog.dl_control.view.view_progress_bar import ViewProgressBar
# endregion imports


[docs]class CtlProgressBar(DialogControlBase, UnoControlProgressBarModelPartial): """Class for Progress Bar Control""" # region init
[docs] def __init__(self, ctl: UnoControlProgressBar) -> None: """ Constructor Args: ctl (UnoControlProgressBar): Progress Bar Control """ # generally speaking EventArgs.event_data will contain the Event object for the UNO event raised. DialogControlBase.__init__(self, ctl) UnoControlProgressBarModelPartial.__init__(self, component=self.get_model()) self._model_ex = None self._view_ex = None
# endregion init def __repr__(self) -> str: if hasattr(self, "name"): return f"CtlProgressBar({self.name})" return "CtlProgressBar" # region Overrides
[docs] def get_view_ctl(self) -> UnoControlProgressBar: return cast("UnoControlProgressBar", super().get_view_ctl())
[docs] def get_uno_srv_name(self) -> str: """Returns ``com.sun.star.awt.UnoControlProgressBar``""" return "com.sun.star.awt.UnoControlProgressBar"
[docs] def get_model(self) -> UnoControlProgressBarModel: """Gets the Model for the control""" return cast("UnoControlProgressBarModel", self.get_view_ctl().getModel())
[docs] def get_control_kind(self) -> DialogControlKind: """Gets the control kind. Returns ``DialogControlKind.PROGRESS_BAR``""" return DialogControlKind.PROGRESS_BAR
[docs] def get_control_named_kind(self) -> DialogControlNamedKind: """Gets the control named kind. Returns ``DialogControlNamedKind.PROGRESS_BAR``""" return DialogControlNamedKind.PROGRESS_BAR
# endregion Overrides # region Static Methods
[docs] @staticmethod def create(win: XWindowPeer, **kwargs: Any) -> "CtlProgressBar": """ Creates a new instance of the control. Keyword arguments are optional. Extra Keyword args are passed to the control as property values. Args: win (XWindowPeer): Parent Window Keyword Args: 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: CtlProgressBar: New instance of the control. Note: The `UnoControlDialogElement <https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogElement.html>`__ interface is not included when creating the control with a window peer. """ ctrl = _create_control("com.sun.star.awt.UnoControlProgressBarModel", win, **kwargs) return CtlProgressBar(ctl=ctrl)
# endregion Static Methods # region Properties @property def model(self) -> UnoControlProgressBarModel: # pylint: disable=no-member return cast("UnoControlProgressBarModel", super().model) @property def model_ex(self) -> ModelProgressBar: """ Gets the extended Model for the control. This is a wrapped instance for the model property. It add some additional properties and methods to the model. """ # pylint: disable=no-member if self._model_ex is None: # pylint: disable=import-outside-toplevel # pylint: disable=redefined-outer-name from ooodev.dialog.dl_control.model.model_progress_bar import ModelProgressBar self._model_ex = ModelProgressBar(self.model) return self._model_ex @property def value(self) -> int: """Gets or sets the current value of the progress bar""" return self.view.getValue() @value.setter def value(self, value: int) -> None: self.view.setValue(value) @property def view(self) -> UnoControlProgressBar: # pylint: disable=no-member return cast("UnoControlProgressBar", super().view) @property def view_ex(self) -> ViewProgressBar: """ Gets the extended View for the control. This is a wrapped instance for the view property. It add some additional properties and methods to the view. """ # pylint: disable=no-member if self._view_ex is None: # pylint: disable=import-outside-toplevel # pylint: disable=redefined-outer-name from ooodev.dialog.dl_control.view.view_progress_bar import ViewProgressBar self._view_ex = ViewProgressBar(self.view) return self._view_ex
# endregion Properties if mock_g.FULL_IMPORT: from ooodev.dialog.dl_control.model.model_progress_bar import ModelProgressBar from ooodev.dialog.dl_control.view.view_progress_bar import ViewProgressBar