Source code for ooodev.draw.draw_forms
from __future__ import annotations
from typing import overload, TYPE_CHECKING
try:
# python 3.12+
from typing import override # noqa # type: ignore
except ImportError:
from typing_extensions import override # noqa # type: ignore
from com.sun.star.form import XForm
from ooodev.adapter.form.forms_comp import FormsComp
from ooodev.draw.draw_form import DrawForm
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo
from ooodev.loader.inst.lo_inst import LoInst
from ooodev.office.partial.office_document_prop_partial import OfficeDocumentPropPartial
from ooodev.utils import gen_util as mGenUtil
from ooodev.utils.partial.lo_inst_props_partial import LoInstPropsPartial
from ooodev.utils.partial.qi_partial import QiPartial
from ooodev.utils.partial.service_partial import ServicePartial
from ooodev.utils.partial.the_dictionary_partial import TheDictionaryPartial
if TYPE_CHECKING:
from com.sun.star.form import XForms
from ooodev.draw.draw_page import DrawPage
[docs]class DrawForms(
LoInstPropsPartial, OfficeDocumentPropPartial, FormsComp, QiPartial, ServicePartial, TheDictionaryPartial
):
"""
Class for managing Draw Forms.
This class is Enumerable and returns ``DrawForm`` instance on iteration.
.. code-block:: python
for sheet in doc.sheets:
sheet["A1"].set_val("test")
assert sheet["A1"].get_val() == "test"
This class also as index access and returns ``CalcSheet`` instance.
.. code-block:: python
sheet = doc.sheets["Sheet1"]
# or set the value of cell A2 to TEST
doc.sheets[0]["A2"].set_val("TEST")
# get the last sheet of the document
last_sheet = doc.sheets[-1]
# get the second last sheet of the document
second_last_sheet = doc.sheets[-2]
# get the number of sheets
num_sheets = len(doc.sheets)
.. versionadded:: 0.18.3
"""
[docs] def __init__(self, owner: DrawPage, forms: XForms, lo_inst: LoInst | None = None) -> None:
"""
Constructor
Args:
owner (DrawPage): Owner Component
forms (XForms): Forms instance.
"""
if lo_inst is None:
lo_inst = mLo.Lo.current_lo
self._owner = owner
LoInstPropsPartial.__init__(self, lo_inst=lo_inst)
OfficeDocumentPropPartial.__init__(self, owner.office_doc)
FormsComp.__init__(self, forms) # type: ignore
QiPartial.__init__(self, component=forms, lo_inst=self.lo_inst)
ServicePartial.__init__(self, component=forms, lo_inst=self.lo_inst)
TheDictionaryPartial.__init__(self)
def __next__(self) -> DrawForm:
return DrawForm(owner=self, component=super().__next__(), lo_inst=self.lo_inst) # type: ignore
def __getitem__(self, index: str | int) -> DrawForm:
if isinstance(index, int):
return self.get_by_index(index)
return self.get_by_name(index)
def __len__(self) -> int:
return self.component.getCount()
def _get_index(self, idx: int, allow_greater: bool = False) -> int:
"""
Gets the index.
Args:
idx (int): Index of sheet. Can be a negative value to index from the end of the list.
allow_greater (bool, optional): If True and index is greater then the number of
sheets then the index becomes the next index if sheet were appended. Defaults to False.
Returns:
int: Index value.
"""
count = len(self)
return mGenUtil.Util.get_index(idx, count, allow_greater)
def _create_name(self, name: str) -> str:
used_name = True
i = 1
nm = f"{name}{i}"
while used_name:
used_name = self.has_by_name(nm)
if used_name:
i += 1
nm = f"{name}{i}"
return nm
# region add_form
@overload
def add_form(self) -> DrawForm:
"""
Adds a new form at the end.
Returns:
DrawForm: Form
"""
...
@overload
def add_form(self, idx: int) -> DrawForm:
"""
Adds a new form.
Args:
idx (int): Index of form.
Returns:
DrawForm: Form
"""
...
@overload
def add_form(self, name: str) -> DrawForm:
"""
Adds a new form.
Args:
name (str): Name of form.
Returns:
DrawForm: Form
"""
...
[docs] def add_form(self, *args, **kwargs) -> DrawForm:
"""
Adds a new form.
Args:
name (str): Name of form.
idx (int): Index of form.
Raises:
NameClashError: If name already exists.
Returns:
DrawForm: Form
"""
all_args = list(args)
all_args.extend(kwargs.values())
if not all_args:
# add a new form at the end
all_args.append(-1)
if len(all_args) != 1:
raise TypeError(f"add_form() takes 1 argument but {len(all_args)} were given")
arg1 = all_args[0]
if isinstance(arg1, int):
idx = self._get_index(arg1, allow_greater=True)
frm = self.lo_inst.create_instance_mcf(XForm, "stardiv.one.form.component.Form", raise_err=True)
frm.Name = self._create_name("Form") # type: ignore
self.insert_by_index(idx, frm)
return self.get_by_index(idx)
elif isinstance(arg1, str):
if self.has_by_name(arg1):
raise mEx.NameClashError(f"Name '{arg1}' already exists")
frm = self.lo_inst.create_instance_mcf(XForm, "stardiv.one.form.component.Form", raise_err=True)
self.insert_by_name(arg1, frm)
return self.get_by_name(arg1)
else:
raise TypeError("add_form() argument must be int or str")
# endregion add_form
# region XIndexAccess overrides
[docs] @override
def get_by_index(self, idx: int) -> DrawForm:
"""
Gets the element at the specified index.
Args:
idx (int): The Zero-based index of the element. Idx can be a negative value to index from the end of the list.
For example, -1 will return the last element.
Returns:
DrawForm: The element at the specified index.
"""
idx = self._get_index(idx, True)
result = super().get_by_index(idx)
return DrawForm(owner=self, component=result, lo_inst=self.lo_inst) # type: ignore
# endregion XIndexAccess overrides
# region XNameAccess overrides
[docs] @override
def get_by_name(self, name: str) -> DrawForm:
"""
Gets the element with the specified name.
Args:
name (str): The name of the element.
Raises:
MissingNameError: If sheet is not found.
Returns:
DrawForm: The element with the specified name.
"""
if not self.has_by_name(name):
raise mEx.MissingNameError(f"Unable to find sheet with name '{name}'")
result = super().get_by_name(name)
return DrawForm(owner=self, component=result, lo_inst=self.lo_inst) # type: ignore
# endregion XNameAccess overrides
# region Properties
@property
def owner(self) -> DrawPage:
"""
Returns:
DrawPage: Draw Form
"""
return self._owner
# endregion Properties