# region Import
from __future__ import annotations
from typing import Any, cast, Type, TypeVar
from com.sun.star.awt import XBitmap
from ooo.dyn.drawing.rectangle_point import RectanglePoint
from ooodev.format.inner.common.format_types.offset_column import OffsetColumn
from ooodev.format.inner.common.format_types.offset_row import OffsetRow
from ooodev.format.inner.common.format_types.size_percent import SizePercent
from ooodev.format.inner.common.props.area_img_props import AreaImgProps
from ooodev.format.inner.direct.write.fill.area.img import Img as InnerImg
from ooodev.format.inner.direct.write.fill.area.img import ImgStyleKind
from ooodev.format.inner.kind.format_kind import FormatKind
from ooodev.format.inner.modify.write.page.page_style_base_multi import PageStyleBaseMulti
from ooodev.format.inner.preset.preset_image import PresetImageKind
from ooodev.format.writer.style.page.kind.writer_style_page_kind import WriterStylePageKind
from ooodev.utils.data_type.offset import Offset
from ooodev.utils.data_type.size_mm import SizeMM
# endregion Import
_TImg = TypeVar("_TImg", bound="Img")
[docs]class Img(PageStyleBaseMulti):
"""
Page Footer Background Image
.. seealso::
- :ref:`help_writer_format_modify_page_header_area`
.. versionadded:: 0.9.0
"""
[docs] def __init__(
self,
*,
bitmap: XBitmap | None = None,
name: str = "",
mode: ImgStyleKind = ImgStyleKind.TILED,
size: SizePercent | SizeMM | None = None,
position: RectanglePoint | None = None,
pos_offset: Offset | None = None,
tile_offset: OffsetColumn | OffsetRow | None = None,
auto_name: bool = False,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> None:
"""
Constructor
Args:
bitmap (XBitmap, optional): Bitmap instance. If ``name`` is not already in the Bitmap Table then
this property is required.
name (str, optional): Specifies the name of the image. This is also the name that is used to store bitmap
in LibreOffice Bitmap Table.
mode (ImgStyleKind, optional): Specifies the image style, tiled, stretched etc.
Default ``ImgStyleKind.TILED``.
size (SizePercent, SizeMM, optional): Size in percent (``0 - 100``) or size in ``mm`` units.
position (RectanglePoint): Tiling position of Image.
pos_offset (Offset, optional): Tiling position offset.
tile_offset (OffsetColumn, OffsetRow, optional): The tiling offset.
auto_name (bool, optional): Specifies if ``name`` is ensured to be unique. Defaults to ``False``.
style_name (StyleParaKind, str, optional): Specifies the Page Style that instance applies to.
Default is Default Page Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
None:
See Also:
- :ref:`help_writer_format_modify_page_header_area`
"""
direct = InnerImg(
bitmap=bitmap,
name=name,
mode=mode,
size=size,
position=position,
pos_offset=pos_offset,
tile_offset=tile_offset,
auto_name=auto_name,
_cattribs=self._get_inner_cattribs(),
)
super().__init__()
self._style_name = str(style_name)
self._style_family_name = style_family
self._set_style("direct", direct, *direct.get_attrs())
# region internal methods
def _get_inner_props(self) -> AreaImgProps:
return AreaImgProps(
name="HeaderFillBitmapName",
style="HeaderFillStyle",
mode="HeaderFillBitmapMode",
point="HeaderFillBitmapRectanglePoint",
bitmap="HeaderFillBitmap",
offset_x="HeaderFillBitmapOffsetX",
offset_y="HeaderFillBitmapOffsetY",
pos_x="HeaderFillBitmapPositionOffsetX",
pos_y="HeaderFillBitmapPositionOffsetY",
size_x="HeaderFillBitmapSizeX",
size_y="HeaderFillBitmapSizeY",
)
def _get_inner_cattribs(self) -> dict:
return {
"_supported_services_values": self._supported_services(),
"_format_kind_prop": self.prop_format_kind,
"_props_internal_attributes": self._get_inner_props(),
}
# endregion internal methods
# region Static Methods
[docs] @classmethod
def from_style(
cls: Type[_TImg],
doc: Any,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _TImg:
"""
Gets instance from Document.
Args:
doc (Any): UNO Document Object.
style_name (StyleParaKind, str, optional): Specifies the Paragraph Style that instance applies to.
Default is Default Paragraph Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
Img: ``Img`` instance from document properties.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerImg.from_obj(inst.get_style_props(doc), _cattribs=inst._get_inner_cattribs())
inst._set_style("direct", direct, *direct.get_attrs())
return inst
[docs] @classmethod
def from_preset(
cls: Type[_TImg],
preset: PresetImageKind,
style_name: WriterStylePageKind | str = WriterStylePageKind.STANDARD,
style_family: str = "PageStyles",
) -> _TImg:
"""
Gets instance from preset.
Args:
preset (PresetImageKind): Preset.
style_name (StyleParaKind, str, optional): Specifies the Paragraph Style that instance applies to.
Default is Default Paragraph Style.
style_family (str, optional): Style family. Default ``PageStyles``.
Returns:
Img: ``Img`` instance from preset.
"""
inst = cls(style_name=style_name, style_family=style_family)
direct = InnerImg.from_preset(preset=preset, _cattribs=inst._get_inner_cattribs())
inst._set_style("direct", direct, *direct.get_attrs())
return inst
# endregion Static Methods
# region Properties
@property
def prop_format_kind(self) -> FormatKind:
"""Gets the kind of style"""
try:
return self._format_kind_prop
except AttributeError:
self._format_kind_prop = FormatKind.DOC | FormatKind.STYLE | FormatKind.HEADER
return self._format_kind_prop
@property
def prop_style_name(self) -> str:
"""Gets/Sets property Style Name"""
return self._style_name
@prop_style_name.setter
def prop_style_name(self, value: str | WriterStylePageKind):
self._style_name = str(value)
@property
def prop_inner(self) -> InnerImg:
"""Gets/Sets Inner Image instance"""
try:
return self._direct_inner
except AttributeError:
self._direct_inner = cast(InnerImg, self._get_style_inst("direct"))
return self._direct_inner
@prop_inner.setter
def prop_inner(self, value: InnerImg) -> None:
if not isinstance(value, InnerImg):
raise TypeError(f'Expected type of InnerImg, got "{type(value).__name__}"')
self._del_attribs("_direct_inner")
self._set_style("direct", value, *value.get_attrs())
# endregion Properties