Source code for ooodev.adapter.text.simple_text_partial

from __future__ import annotations
from typing import TYPE_CHECKING
import uno

from com.sun.star.text import XSimpleText
from ooo.dyn.text.control_character import ControlCharacterEnum

from ooodev.adapter.text.text_range_partial import TextRangePartial

if TYPE_CHECKING:
    from com.sun.star.text import XTextCursor
    from com.sun.star.text import XTextRange
    from ooodev.utils.type_var import UnoInterface


[docs]class SimpleTextPartial(TextRangePartial): """ Partial class for XSimpleText. """ # pylint: disable=unused-argument
[docs] def __init__(self, component: XSimpleText, interface: UnoInterface | None = XSimpleText) -> None: """ Constructor Args: component (XSimpleText): UNO Component that implements ``com.sun.star.text.XSimpleText`` interface. interface (UnoInterface, optional): The interface to be validated. Defaults to ``XSimpleText``. """ TextRangePartial.__init__(self, component, interface=interface) self.__component = component
# region XSimpleText
[docs] def create_text_cursor(self) -> XTextCursor: """ Creates a new text cursor. Returns: XTextCursor: The new text cursor. """ return self.__component.createTextCursor()
[docs] def create_text_cursor_by_range(self, text_position: XTextRange) -> XTextCursor: """ The initial position is set to ``text_position``. Args: text_position (XTextRange): The initial position of the new text cursor. Returns: XTextCursor: The new text cursor. """ return self.__component.createTextCursorByRange(text_position)
[docs] def insert_control_character(self, rng: XTextRange, control_character: ControlCharacterEnum, absorb: bool) -> None: """ Inserts a control character (like a paragraph break or a hard space) into the text. Args: rng (XTextRange): The position of the new control character. control_character (ControlCharacterEnum): The control character to be inserted. absorb (bool): If TRUE the text range will contain the new inserted control character, otherwise the range (and it's text) will remain unchanged. Raises: IllegalArgumentException: ``com.sun.star.lang.IllegalArgumentException`` """ return self.__component.insertControlCharacter(rng, int(control_character), absorb)
[docs] def insert_string(self, rng: XTextRange, text: str, absorb: bool) -> None: """ Inserts a string of characters into the text. The string may contain the following white spaces: If the parameter bAbsorb() was TRUE the text range will contain the new inserted string, otherwise the range (and it's text) will remain unchanged. """ self.__component.insertString(rng, text, absorb)
# endregion XSimpleText