ooodev.format.proto.write.char.font.font_position_t module

protocol ooodev.format.proto.write.char.font.font_position_t.FontPositionT[source]

Bases: StyleT, Protocol

Font Position Protocol

Classes that implement this protocol must have the following methods / attributes:

__init__(*, script_kind=Ellipsis, raise_lower=Ellipsis, rel_size=Ellipsis, rotation=Ellipsis, scale=Ellipsis, fit=Ellipsis, spacing=Ellipsis, pair=Ellipsis)[source]

Character Font Position.

Parameters:

script_kind (FontScriptKind, optional) – Specifies Superscript/Subscript option.
raise_lower (int, optional) – Specifies raise or Lower as percent value. Set to a value of 0 for automatic.
rel_size (int, Intensity, optional) – Specifies relative Font Size as percent value. Set this value to 0 for automatic; Otherwise value from 1 to 100.
rotation (int, Angle, optional) – Specifies the rotation of a character in degrees. Depending on the implementation only certain values may be allowed.
scale (int, optional) – Specifies scale width as percent value. Min value is 1.
fit (bool, optional) – Specifies if rotation is fit to line.
spacing (CharSpacingKind, float, UnitT, optional) – Specifies character spacing in pt (point) units or Class UnitT.
pair (bool, optional) – Specifies pair kerning.

Return type:

None

fmt_fit(value=Ellipsis)[source]

Get copy of instance with rotation fit set or removed.

Parameters:: value (bool, optional) – Rotation fit value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_pair(value=Ellipsis)[source]

Get copy of instance with pair kerning set or removed.

Parameters:: value (bool, optional) – Pair kerning value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_raise_lower(value=Ellipsis)[source]

Get copy of instance with raise/lower set or removed.

Parameters:: value (int, Intensity, optional) – Raise or Lower value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_rel_size(value=Ellipsis)[source]

Get copy of instance with relative size set or removed.

Parameters:: value (int, optional) – relative size value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_rotation(value=Ellipsis)[source]

Get copy of instance with rotation set or removed.

Parameters:: value (int, Angle, optional) – The rotation of a character in degrees. Depending on the implementation only certain values may be allowed. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_scale(value=Ellipsis)[source]

Get copy of instance with scale width set or removed.

Parameters:: value (int, optional) – scale width value. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_scrip_kind(value=Ellipsis)[source]

Get copy of instance with superscript/subscript set or removed.

Parameters:: value (FontScriptKind, optional) – font script kind. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

fmt_spacing(value=Ellipsis)[source]

Get copy of instance with spacing set or removed.

Parameters:: value (float, UnitT, optional) – The character spacing in pt (point) units Class UnitT. If None style is removed. Default None
Returns:: Font with style added or removed
Return type:: FontPosition

from_obj(obj: Any) → FontPositionT
from_obj(obj: Any, **kwargs) → FontPositionT
from_obj(**kwds): Helper for @overload to raise when called.

__protocol_attrs__ = {'add_event_listener', 'add_event_observer', 'apply', 'backup', 'copy', 'default', 'fit', 'fmt_fit', 'fmt_pair', 'fmt_raise_lower', 'fmt_rel_size', 'fmt_rotation', 'fmt_scale', 'fmt_scrip_kind', 'fmt_spacing', 'from_obj', 'get_attrs', 'get_props', 'get_update_obj', 'has_update_obj', 'normal', 'on_applied', 'on_applying', 'on_property_backed_up', 'on_property_backing_up', 'on_property_restore_set', 'on_property_restore_setting', 'on_property_set', 'on_property_set_error', 'pair', 'prop_fit', 'prop_format_kind', 'prop_has_attribs', 'prop_has_backup', 'prop_pair', 'prop_parent', 'prop_raise_lower', 'prop_rel_size', 'prop_rotation', 'prop_scale', 'prop_script_kind', 'prop_spacing', 'raise_lower_auto', 'remove_event_listener', 'remove_event_observer', 'restore', 'rotation_270', 'rotation_90', 'rotation_none', 'script_kind_normal', 'script_kind_subscript', 'script_kind_superscript', 'set_update_obj', 'spacing_loose', 'spacing_normal', 'spacing_tight', 'spacing_very_loose', 'spacing_very_tight', 'subscript', 'superscript', 'support_service', 'update'}