Source code for ooodev.adapter.text.sentence_cursor_partial

from __future__ import annotations
from typing import Any, TYPE_CHECKING

import uno
from com.sun.star.text import XSentenceCursor

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 SentenceCursorPartial: """ Partial class for XSentenceCursor. """ # pylint: disable=unused-argument
[docs] def __init__(self, component: XSentenceCursor, interface: UnoInterface | None = XSentenceCursor) -> None: """ Constructor Args: component (XSentenceCursor): UNO Component that implements ``com.sun.star.text.XSentenceCursor`` interface. interface (UnoInterface, optional): The interface to be validated. Defaults to ``XSentenceCursor``. """ 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 XSentenceCursor
[docs] def is_start_of_sentence(self) -> bool: """ Returns true if the cursor is at the start of a sentence. Returns: bool: ``True`` if the cursor is at the start of a sentence. """ return self.__component.isStartOfSentence()
[docs] def is_end_of_sentence(self) -> bool: """ Returns true if the cursor is at the end of a sentence. Returns: bool: ``True`` if the cursor is at the end of a sentence. """ return self.__component.isEndOfSentence()
[docs] def goto_next_sentence(self, expand: bool = False) -> bool: """ Moves the cursor to the next sentence. Args: expand (bool, optional): If ``True`` the range of the cursor will be expanded to the next sentence. Default is ``False``. Returns: bool: ``True`` if the cursor is now at the start of a sentence, ``False`` otherwise. If ``False`` is returned the cursor will remain at its original position. """ return self.__component.gotoNextSentence(expand)
[docs] def goto_previous_sentence(self, expand: bool = False) -> bool: """ Moves the cursor to the previous sentence. Args: expand (bool, optional): If ``True`` the range of the cursor will be expanded to the previous sentence. Default is ``False``. Returns: bool: ``True`` if the cursor is now at the start of a sentence, ``False`` otherwise. If ``False`` is returned the cursor will remain at its original position. """ return self.__component.gotoPreviousSentence(expand)
[docs] def goto_start_of_sentence(self, expand: bool = False) -> bool: """ Moves the cursor to the start of the sentence. Args: expand (bool, optional): If ``True`` the range of the cursor will be expanded to the start of the sentence. Default is ``False``. Returns: bool: ``True`` if the cursor is now at the start of a sentence, ``False`` otherwise. If ``False`` is returned the cursor will remain at its original position. """ return self.__component.gotoStartOfSentence(expand)
[docs] def goto_end_of_sentence(self, expand: bool = False) -> bool: """ Moves the cursor to the end of the sentence. Args: expand (bool, optional): If ``True`` the range of the cursor will be expanded to the end of the sentence. Default is ``False``. Returns: bool: ``True`` if the cursor is now at the end of a sentence, ``False`` otherwise. If ``False`` is returned the cursor will remain at its original position. """ return self.__component.gotoEndOfSentence(expand)
# endregion XSentenceCursor