ooodev.adapter.lang.locale_comp module

class ooodev.adapter.lang.locale_comp.LocaleComp(component, prop_name, event_provider=None)

Bases: StructBase[Locale]

Locale Struct

Object represents a specific geographical, political, or cultural region.

This class raises an event before and after a property is changed if it has been passed an event provider.

The event raised before the property is changed is called com_sun_star_lang_Locale_changing. The event raised after the property is changed is called com_sun_star_lang_Locale_changed.

The event args for before the property is changed is of type KeyValCancelArgs. The event args for after the property is changed is of type KeyValArgs.

__init__(component, prop_name, event_provider=None)

Constructor

Parameters:

• component (Locale) – Border Line.

• prop_name (str) – Property Name. This value is assigned to the prop_name of event_data.

• event_provider (EventsT, optional) – Event Provider.

Return type:

None

property country: str

Gets/Sets - an ISO 3166 Country Code.

These codes are the upper-case two-letter codes as defined by ISO 3166-1. If this field contains an empty string, the meaning depends on the context.

Return type:

str

property language: str

Gets/Sets - an ISO 639 Language Code.

These codes are preferably the lower-case two-letter codes as defined by ISO 639-1, or three-letter codes as defined by ISO 639-3. If this field contains an empty string, the meaning depends on the context.

Return type:

str

property variant: str

Gets/Sets - a BCP 47 Language Tag.

Return type:

str