ooodev.adapter.awt.pattern_field_partial module

class ooodev.adapter.awt.pattern_field_partial.PatternFieldPartial(component, interface=com.sun.star.awt.XPatternField)[source]

Bases: object

Partial class for XPatternField.

Parameters:
  • component (XPatternField) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.awt.XPatternField)[source]

Constructor

Parameters:
  • component (XPatternField) – UNO Component that implements com.sun.star.awt.XPatternField interface.

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

Return type:

None

get_masks()[source]

Gets the currently set pattern mask.

Returns:

The currently set EditMask mask and LiteralMask mask.

Return type:

Tuple[str, str]

get_string()[source]

Gets the currently set string value of the pattern field.

Return type:

str

is_strict_format()[source]

Gets whether the format is currently checked during user input.

Return type:

bool

set_masks(edit_mask, literal_mask)[source]

Sets the pattern mask.

Return type:

None

Parameters:
  • edit_mask (str) –

  • literal_mask (str) –

set_strict_format(strict)[source]

Determines if the format is checked during user input.

Return type:

None

Parameters:

strict (bool) –

set_string(value)[source]

Sets the string value of the pattern field.

Return type:

None

Parameters:

value (str) –