Source code for ooodev.adapter.text.page_cursor_partial

from __future__ import annotations
from typing import Any, TYPE_CHECKING
import uno

from com.sun.star.text import XPageCursor
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo

if TYPE_CHECKING:
    from ooodev.utils.type_var import UnoInterface


[docs]class PageCursorPartial: """ Partial class for XPageCursor. """ # pylint: disable=unused-argument
[docs] def __init__(self, component: XPageCursor, interface: UnoInterface | None = XPageCursor) -> None: """ Constructor Args: component (XPageCursor): UNO Component that implements ``com.sun.star.text.XPageCursor`` interface. interface (UnoInterface, optional): The interface to be validated. Defaults to ``XPageCursor``. """ 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 XPageCursor
[docs] def get_page(self) -> int: """Returns the current page number.""" return self.__component.getPage()
[docs] def jump_to_first_page(self) -> bool: """ Jumps to the first page. Returns: bool: ``True`` if the jump was successful, ``False`` otherwise. """ return self.__component.jumpToFirstPage()
[docs] def jump_to_last_page(self) -> None: """Jumps to the last page.""" self.__component.jumpToLastPage()
[docs] def jump_to_next_page(self) -> bool: """ Jumps to the next page. Returns: bool: ``True`` if the jump was successful, ``False`` otherwise. """ return self.__component.jumpToNextPage()
[docs] def jump_to_previous_page(self) -> bool: """ Jumps to the previous page. Returns: bool: ``True`` if the jump was successful, ``False`` otherwise. """ return self.__component.jumpToPreviousPage()
[docs] def jump_to_start_of_page(self) -> bool: """ Jumps to the start of the current page. Returns: bool: ``True`` if the jump was successful, ``False`` otherwise. """ return self.__component.jumpToStartOfPage()
[docs] def jump_to_end_of_page(self) -> bool: """ Jumps to the end of the current page. Returns: bool: ``True`` if the jump was successful, ``False`` otherwise. """ return self.__component.jumpToEndOfPage()
[docs] def jump_to_page_(self, number: int) -> bool: """ Jumps to the page with the given number. Args: number (int): Page number to jump to. Returns: bool: ``True`` if the jump was successful, ``False`` otherwise. """ return self.__component.jumpToPage(number)
# endregion XPageCursor