ooodev.adapter.util.string_escape_partial module

class ooodev.adapter.util.string_escape_partial.StringEscapePartial(component, interface=com.sun.star.util.XStringEscape)[source]

Bases: object

Partial class for XStringEscape.

Parameters:

  • component (XStringEscape) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.util.XStringEscape)[source]

Constructor

Parameters:

  • component (XStringEscape) – UNO Component that implements com.sun.star.util.XStringEscape.XStringEscape interface.

  • interface (UnoInterface, optional) – The interface to be validated. Defaults to XStringEscape.

Return type:

None

escape_string(string)[source]

Encodes an arbitrary string into an escaped form compatible with some naming rules.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

Return type:

str

Parameters:

string (str) –

unescapeString(escaped_string)[source]

decodes an escaped string into the original form.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

Return type:

str

Parameters:

escaped_string (str) –

ooodev.adapter.util.string_escape_partial.get_builder(component)[source]

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder