ooodev.format.inner.direct.structs.locale_struct module

Module for LocaleStruct struct.

New in version 0.9.0.

class ooodev.format.inner.direct.structs.locale_struct.LocaleStruct(*, country='US', language='en', variant='')[source]

Bases: StructBase

Paragraph Drop Cap

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together properties.

New in version 0.9.0.

__init__(*, country='US', language='en', variant='')[source]

Constructor

Parameters:

country (str, optional) – Specifies an ISO 3166 Country Code. These codes are the upper-case two-letter codes as defined by ISO 3166-1. You can find a full list of these codes at a number of sites, such as: Wikipedia ISO 3166-1 alpha-2. If this field contains an empty string, the meaning depends on the context.
language (str, optional) – Specifies 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. You can find a full list of these codes at a number of sites, such as: ISO 639 Code Tables. If this field contains an empty string, the meaning depends on the context.
variant (str, optional) – Specifies a BCP 47 Language Tag. You can find BCP 47 language tag resources at: Wikipedia IETF language tag or Language tags in HTML and XML.

Return type:

None

apply(obj: Any)[source]

apply(obj: Any, keys: Dict[str, str])

apply(obj, **kwargs)

Applies tab properties to obj

Parameters:

obj (object) – UNO object.
keys (Dict[str, str], optional) – Property key, value items that map properties.

Events:

Return type:

None

fmt_country(value)[source]

Gets a copy of instance with country set.

Parameters:

value (int) – Country value.
self (_TLocaleStruct) –

Returns:

LocaleStruct instance

Return type:

LocaleStruct

fmt_language(value)[source]

Gets a copy of instance with language set.

Parameters:

value (int) – Language value.
self (_TLocaleStruct) –

Returns:

LocaleStruct instance

Return type:

LocaleStruct

fmt_variant(value)[source]

Gets a copy of instance with variant set.

Parameters:

value (int) – Variant value.
self (_TLocaleStruct) –

Returns:

LocaleStruct instance

Return type:

LocaleStruct

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:: obj (object) – UNO object
Raises:: PropertyNotFoundError – If obj does not have required property
Returns:: DropCap instance that represents obj Drop cap format properties.
Return type:: DropCap

classmethod from_uno_struct(locale)[source]

classmethod from_uno_struct(locale, **kwargs)

Converts a Locale Stop instance to a LocaleStruct

Parameters:

dcf (Locale) – UNO locale
locale (Locale) –

Returns:

LocaleStruct set with locale properties

Return type:

LocaleStruct

get_attrs()[source]

Gets the attributes that are slated for change in the current instance

Returns:: Tuple of attributes
Return type:: Tuple(str, …)

get_uno_struct()[source]

Gets UNO Locale from instance.

Returns:: Locale instance
Return type:: Locale

property english_australia: _TLocaleStruct

Gets English Australia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_belize: _TLocaleStruct

Gets English Belize locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_botswana: _TLocaleStruct

Gets English Botswana locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_canada: _TLocaleStruct

Gets English Canada locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_caribbean: _TLocaleStruct

Gets English Caribbean locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_gambia: _TLocaleStruct

Gets English Gambia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_ghana: _TLocaleStruct

Gets English Ghana locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_hong_kong: _TLocaleStruct

Gets English Hong Kong locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_india: _TLocaleStruct

Gets English India locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_ireland: _TLocaleStruct

Gets English Ireland locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_israel: _TLocaleStruct

Gets English Israel locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_jamaica: _TLocaleStruct

Gets English Jamaica locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_kenya: _TLocaleStruct

Gets English Kenya locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_malawi: _TLocaleStruct

Gets English Malawi locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_malaysia: _TLocaleStruct

Gets English Malaysia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_mauritius: _TLocaleStruct

Gets English Mauritius locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_namibia: _TLocaleStruct

Gets English Namibia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_new_zealand: _TLocaleStruct

Gets English New Zealand locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_nigeria: _TLocaleStruct

Gets English Nigeria locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_philippines: _TLocaleStruct

Gets English Philippines locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_south_africa: _TLocaleStruct

Gets English South Africa locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_sri_lanka: _TLocaleStruct

Gets English Sri Lanka locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_trinidad: _TLocaleStruct

Gets English Trinidad locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_uk: _TLocaleStruct

Gets English UK locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_uk_ode: _TLocaleStruct

Gets English ODE Spelling UK locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_us: _TLocaleStruct

Gets English US locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_usa: _TLocaleStruct

Gets English USA locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_zambia: _TLocaleStruct

Gets English Zambia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property english_zimbabwe: _TLocaleStruct

Gets English Zimbabwe locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_belgium: _TLocaleStruct

Gets French Belgium locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_benin: _TLocaleStruct

Gets French Benin locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_burkina_faso: _TLocaleStruct

Gets French Burkina Faso locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_canada: _TLocaleStruct

Gets French Canada locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_cote_d_ivoire: _TLocaleStruct

Gets French Côte d'Ivoire locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_france: _TLocaleStruct

Gets French France locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_luxembourg: _TLocaleStruct

Gets French Luxembourg locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_mali: _TLocaleStruct

Gets French Mali locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_mauritius: _TLocaleStruct

Gets French Mauritius locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_monaco: _TLocaleStruct

Gets French Monaco locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_niger: _TLocaleStruct

Gets French Niger locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_senegal: _TLocaleStruct

Gets French Senegal locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_switzerland: _TLocaleStruct

Gets French Switzerland locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property french_togo: _TLocaleStruct

Gets French Togo locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property german_austria: _TLocaleStruct

Gets German Austria locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property german_belgium: _TLocaleStruct

Gets German Belgium locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property german_germany: _TLocaleStruct

Gets German Germany locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property german_liechtenstein: _TLocaleStruct

Gets German Liechtenstein locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property german_luxembourg: _TLocaleStruct

Gets German Luxembourg locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property german_switzerland: _TLocaleStruct

Gets German Switzerland locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property locale_none: _TLocaleStruct

Gets no locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property prop_country: str

Gets/Sets the ISO 3166 Country Code

Return type:: str

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_language: str

Gets/Sets the ISO 639 Language Code.

Return type:: str

property prop_variant: str

Gets/Sets the BCP 47 Language Tag.

Return type:: str

property spanish_argentina: _TLocaleStruct

Gets Spanish Argentina locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_bolivia: _TLocaleStruct

Gets Spanish Bolivia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_chile: _TLocaleStruct

Gets Spanish Chile locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_colombia: _TLocaleStruct

Gets Spanish Colombia locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_costa_rica: _TLocaleStruct

Gets Spanish Costa Rica locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_cuba: _TLocaleStruct

Gets Spanish Cuba locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_dom_rep: _TLocaleStruct

Gets Spanish Dominion Republic locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_ecuador: _TLocaleStruct

Gets Spanish Ecuador locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_el_salvador: _TLocaleStruct

Gets Spanish El Salvador locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_equatorial_guinea: _TLocaleStruct

Gets Spanish Equatorial Guinea locale es-GQ

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_es: _TLocaleStruct

Gets Spanish locale es

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_guatemala: _TLocaleStruct

Gets Spanish Guatemala locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_honduras: _TLocaleStruct

Gets Spanish Honduras locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_mexico: _TLocaleStruct

Gets Spanish Mexico locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_nicaragua: _TLocaleStruct

Gets Spanish Nicaragua locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_panama: _TLocaleStruct

Gets Spanish Panama locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_paraguay: _TLocaleStruct

Gets Spanish Paraguay locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_peru: _TLocaleStruct

Gets Spanish Peru locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_philippines: _TLocaleStruct

Gets Spanish Philippines locale es-PH

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_puerto_rico: _TLocaleStruct

Gets Spanish Puerto Rico locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_spain: _TLocaleStruct

Gets Spanish Spain locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_uruguay: _TLocaleStruct

Gets Spanish Uruguay locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_usa: _TLocaleStruct

Gets Spanish USA locale es-US

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)

property spanish_venezuela: _TLocaleStruct

Gets Spanish Venezuela locale

Return type:: TypeVar(_TLocaleStruct, bound= LocaleStruct)