Source code for ooodev.calc.spreadsheet_draw_page

from __future__ import annotations
from typing import TYPE_CHECKING, TypeVar, Generic
import uno

from ooodev.adapter.container.index_access_partial import IndexAccessPartial
from ooodev.adapter.drawing.shapes2_partial import Shapes2Partial
from ooodev.adapter.drawing.shapes3_partial import Shapes3Partial
from ooodev.adapter.sheet.spreadsheet_draw_page_comp import SpreadsheetDrawPageComp
from ooodev.draw.partial.draw_page_partial import DrawPagePartial
from ooodev.draw.shapes.partial.shape_factory_partial import ShapeFactoryPartial
from ooodev.format.inner.style_partial import StylePartial
from ooodev.loader import lo as mLo
from ooodev.loader.inst.lo_inst import LoInst
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.calc.partial.calc_doc_prop_partial import CalcDocPropPartial
from ooodev.calc.calc_forms import CalcForms

if TYPE_CHECKING:
    from com.sun.star.drawing import XDrawPage
    from com.sun.star.awt import XControlModel
    from ooodev.proto.component_proto import ComponentT
    from ooodev.draw.shapes.shape_base import ShapeBase
    from ooodev.calc.calc_cell import CalcCell
    from ooodev.form.controls.form_ctl_base import FormCtlBase

_T = TypeVar("_T", bound="ComponentT")


[docs]class SpreadsheetDrawPage( LoInstPropsPartial, DrawPagePartial["SpreadsheetDrawPage[_T]"], Generic[_T], SpreadsheetDrawPageComp, IndexAccessPartial, Shapes2Partial, Shapes3Partial, ServicePartial, QiPartial, StylePartial, CalcDocPropPartial, ShapeFactoryPartial["SpreadsheetDrawPage[_T]"], ): """Represents a draw page.""" # Draw page does implement XDrawPage, but it show in the API of DrawPage Service.
[docs] def __init__(self, owner: _T, component: XDrawPage, lo_inst: LoInst | None = None) -> None: if lo_inst is None: lo_inst = mLo.Lo.current_lo self._owner = owner LoInstPropsPartial.__init__(self, lo_inst=lo_inst) DrawPagePartial.__init__(self, owner=self, component=component) SpreadsheetDrawPageComp.__init__(self, component) IndexAccessPartial.__init__(self, component=component, interface=None) # type: ignore Shapes2Partial.__init__(self, component=component, interface=None) # type: ignore Shapes3Partial.__init__(self, component=component, interface=None) # type: ignore ServicePartial.__init__(self, component=component, lo_inst=self.lo_inst) QiPartial.__init__(self, component=component, lo_inst=self.lo_inst) StylePartial.__init__(self, component=component) if not isinstance(owner, CalcDocPropPartial): raise TypeError("Owner must inherit from CalcDocPropPartial") CalcDocPropPartial.__init__(self, obj=owner.calc_doc) ShapeFactoryPartial.__init__(self, owner=self, lo_inst=self.lo_inst) self._forms = None
def __len__(self) -> int: """ Gets the number of shapes in the draw page. Returns: int: Number of shapes in the draw page. """ return self.get_count() def __getitem__(self, idx: int) -> ShapeBase[SpreadsheetDrawPage[_T]]: """ Gets the shape at the specified index. Args: idx (int): The index of the shape. Returns: ShapeBase[SpreadsheetDrawPage[_T]]: _description_ """ shape = self.component.getByIndex(idx) # type: ignore return self.shape_factory(shape) def __next__(self) -> ShapeBase[SpreadsheetDrawPage[_T]]: """ Gets the next shape in the draw page. Returns: ShapeBase[SpreadsheetDrawPage[_T]]: The next shape in the draw page. """ shape = super().__next__() return self.shape_factory(shape)
[docs] def find_cell_with_control(self, ctl: FormCtlBase | XControlModel) -> CalcCell | None: """ Find the cell that contains the control. Args: ctl (FormCtlBase | XControlModel): Control to find cell for. Returns: CalcCell | None: Cell that contains the control or ``None`` if not found. .. versionadded:: 0.38.0 """ # pylint: disable=import-outside-toplevel from ooodev.form.forms import Forms cell = Forms.find_cell_with_control(self.component, ctl) if cell is None: return None from ooodev.calc.calc_cell import CalcCell co = self.calc_doc.range_converter.get_cell_obj(cell=cell) sheet = self.calc_doc.sheets[co.sheet_idx] return CalcCell(owner=sheet, cell=co, lo_inst=self.lo_inst)
# region Properties @property def owner(self) -> _T: """Component Owner""" return self._owner @property def name(self) -> str: """ Gets/Sets the name of the draw page. Note: Naming for Impress pages seems a little different then Draw pages. Attempting to name a Draw page `Slide #` where `#` is a number will fail and Draw will auto name the page. It seems that `Slide` followed by a space and a number is reserved for Impress. """ return self.component.Name # type: ignore @name.setter def name(self, value: str) -> None: self.component.Name = value # type: ignore @property def forms(self) -> CalcForms: """ Gets the forms of the draw page. """ if self._forms is None: self._forms = CalcForms(owner=self, forms=self.component.getForms(), lo_inst=self.lo_inst) # type: ignore return self._forms
# endregion Properties