from __future__ import annotations
from typing import Any, TYPE_CHECKING
from com.sun.star.form import XLoadable
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo
if TYPE_CHECKING:
from com.sun.star.form import XLoadListener
from ooodev.utils.type_var import UnoInterface
[docs]class LoadablePartial:
"""
Partial Class for XLoadable.
This interface does not really provide an own functionality, it is only for easier runtime identification of form components.
"""
[docs] def __init__(self, component: XLoadable, interface: UnoInterface | None = None) -> None:
"""
Constructor
Args:
component (XLoadable): UNO Component that implements ``com.sun.star.form.XLoadable``.
interface (UnoInterface, optional): The interface to be validated. Defaults to ``None``.
"""
def validate(comp: Any, obj_type: Any) -> None:
if obj_type is None:
return
if not mLo.Lo.is_uno_interfaces(comp, obj_type):
raise mEx.MissingInterfaceError(obj_type)
validate(component, interface)
self.__component = component
# region XLoadable
[docs] def add_load_listener(self, listener: XLoadListener) -> None:
"""
Adds a listener to be notified when the data is loaded.
"""
self.__component.addLoadListener(listener)
[docs] def is_loaded(self) -> bool:
"""
Returns whether the data is loaded.
"""
return self.__component.isLoaded()
[docs] def load(self) -> None:
"""
Loads the data.
"""
self.__component.load()
[docs] def reload(self) -> None:
"""
Does a smart refresh of the object.
"""
self.__component.reload()
[docs] def remove_load_listener(self, listener: XLoadListener) -> None:
"""
Removes a listener from the list of load listeners.
"""
self.__component.removeLoadListener(listener)
[docs] def unload(self) -> None:
"""
Unloads the data.
"""
self.__component.unload()
# endregion XLoadable