"""DrawPages class for Draw documents."""
from __future__ import annotations
from typing import TYPE_CHECKING, TypeVar, Generic
import contextlib
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.drawing import XDrawPage
from ooodev.adapter.drawing.draw_pages_comp import DrawPagesComp
from ooodev.utils import gen_util as mGenUtil
from ooodev.utils import info as mInfo
from ooodev.loader import lo as mLo
from ooodev.loader.inst.lo_inst import LoInst
from ooodev.utils.partial.qi_partial import QiPartial
from ooodev.utils.partial.service_partial import ServicePartial
from ooodev.utils.partial.lo_inst_props_partial import LoInstPropsPartial
from ooodev.utils.partial.the_dictionary_partial import TheDictionaryPartial
from ooodev.calc.partial.calc_doc_prop_partial import CalcDocPropPartial
from ooodev.calc.spreadsheet_draw_page import SpreadsheetDrawPage
if TYPE_CHECKING:
from com.sun.star.drawing import XDrawPages
from ooodev.proto.component_proto import ComponentT
_T = TypeVar("_T", bound="ComponentT")
[docs]class SpreadsheetDrawPages(
LoInstPropsPartial, DrawPagesComp, QiPartial, ServicePartial, TheDictionaryPartial, CalcDocPropPartial, Generic[_T]
):
"""
Class for managing Spreadsheet Draw Pages.
"""
[docs] def __init__(self, owner: _T, slides: XDrawPages, lo_inst: LoInst | None = None) -> None:
"""
Constructor
Args:
owner (DrawDoc): Owner Document
sheet (XDrawPages): Document Pages.
"""
if lo_inst is None:
lo_inst = mLo.Lo.current_lo
self._owner = owner
LoInstPropsPartial.__init__(self, lo_inst=lo_inst)
DrawPagesComp.__init__(self, slides) # type: ignore
ServicePartial.__init__(self, component=slides, lo_inst=self.lo_inst)
# The API does not show that DrawPages implements XNameAccess, but it does.
QiPartial.__init__(self, component=slides, lo_inst=self.lo_inst)
TheDictionaryPartial.__init__(self)
if not isinstance(owner, CalcDocPropPartial):
raise TypeError(f"Owner must inherit from CalcDocPropPartial: {type(owner)}")
CalcDocPropPartial.__init__(self, obj=owner.calc_doc)
self._current_index = 0
[docs] @override
def __getitem__(self, idx: int) -> SpreadsheetDrawPage[_T]: # type: ignore
"""
Gets the draw page at the specified index.
This is short hand for ``get_by_index()``.
Args:
idx (int): The index of the draw page. Idx can be a negative value to get from the end of the document.
Returns:
SpreadsheetDrawPage[_T]: The drawpage with the specified index.
See Also:
- :py:meth:`~ooodev.calc.SpreadsheetDrawPages.get_by_index`
"""
return self.get_by_index(idx=idx)
[docs] def __len__(self) -> int:
"""
Gets the number of draw pages in the document.
Returns:
int: Number of draw pages in the document.
"""
return self.component.getCount()
[docs] def __iter__(self):
"""
Iterates through the draw pages.
Returns:
SpreadsheetDrawPage[_T]: current instance.
"""
self._current_index = 0
return self
[docs] @override
def __next__(self) -> SpreadsheetDrawPage[_T]: # type: ignore
"""
Gets the next draw page.
Returns:
SpreadsheetDrawPage[_T]: The next draw page.
"""
if self._current_index >= len(self):
self._current_index = 0
raise StopIteration
self._current_index += 1
return self[self._current_index - 1]
[docs] def __delitem__(self, _item: int | SpreadsheetDrawPage[_T] | XDrawPage) -> None:
"""
Removes a draw page from the sheet.
Args:
_item (int | SpreadsheetDrawPage[_T] | XDrawPage): Index, name, or object of the draw page.
Raises:
TypeError: If the item is not a supported type.
"""
# Delete slide by index, name, or object
if mInfo.Info.is_instance(_item, int):
self.delete_page(_item)
elif mInfo.Info.is_instance(_item, SpreadsheetDrawPage):
super().remove(_item.component)
elif mInfo.Info.is_instance(_item, XDrawPage):
super().remove(_item)
else:
raise TypeError(f"Unsupported type: {type(_item)}")
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)
[docs] def insert_page(self, idx: int) -> SpreadsheetDrawPage[_T]:
"""
Inserts a draw page at the given position in the document
Args:
idx (int): Index, can be a negative value to insert from the end of the document.
For example, -1 will insert at the end of the document.
Returns:
SpreadsheetDrawPage: New slide that was inserted.
"""
idx = self._get_index(idx=idx, allow_greater=True)
return SpreadsheetDrawPage(self.owner, self.component.insertNewByIndex(idx), lo_inst=self.lo_inst)
[docs] def delete_page(self, idx: int) -> bool:
"""
Deletes a draw page
Args:
idx (int): Index. Can be a negative value to delete from the end of the document.
For example, -1 will delete the last slide.
Returns:
bool: ``True`` on success; Otherwise, ``False``
"""
idx = self._get_index(idx=idx, allow_greater=False)
with contextlib.suppress(Exception):
# get the slide as UNO object and remove it
result = super().get_by_index(idx)
if result is None:
return False
self.remove(result)
return True
return False
# region XIndexAccess overrides
[docs] @override
def get_by_index(self, idx: int) -> SpreadsheetDrawPage[_T]: # type: ignore
"""
Gets the element with the specified index.
Args:
idx (int): The index of the element. Idx can be a negative value to get from the end of the document.
For example, -1 will get the last slide.
Raises:
IndexError: If unable to find slide with index.
Returns:
SpreadsheetDrawPage: The drawpage with the specified index.
"""
idx = self._get_index(idx=idx, allow_greater=False)
if idx >= len(self):
raise IndexError(f"Index out of range: '{idx}'")
result = super().get_by_index(idx)
return SpreadsheetDrawPage(owner=self.owner, component=result, lo_inst=self.lo_inst)
# endregion XIndexAccess overrides
# region XDrawPages overrides
[docs] @override
def insert_new_by_index(self, idx: int) -> SpreadsheetDrawPage[_T]: # type: ignore
"""
Creates and inserts a new GenericDrawPage or MasterPage into this container.
Args:
idx (int): The index at which the new page will be inserted.
``idx`` can be a negative value to insert from the end of the document.
For example, ``-1`` will insert at the end of the document.
Returns:
SpreadsheetDrawPage: The new page.
"""
idx = self._get_index(idx=idx, allow_greater=True)
result = super().insert_new_by_index(idx)
return SpreadsheetDrawPage(owner=self.owner, component=result, lo_inst=self.lo_inst)
# endregion XDrawPages overrides
# region Properties
@property
def owner(self) -> _T:
"""
Returns:
_T: Draw or Impress document.
"""
return self._owner
# endregion Properties