Class CharacterStyler

class ooodev.write.style.direct.character_styler.CharacterStyler(write_doc, component)[source]

Bases: WriteDocPropPartial, EventsPartial, LoInstPropsPartial, FontOnlyPartial, FontEffectsPartial, FontPartial, WriteCharBordersPartial, FontPositionPartial, HighlightPartial, TheDictionaryPartial

Character Styler class.

Class set various character properties.

Events are raises when a style is being applied and when a style has been applied. The WriteNamedEvent.CHARACTER_STYLE_APPLYING event is raised before a style is applied. The WriteNamedEvent.CHARACTER_STYLE_APPLIED event is raised after a style has been applied. The event data is a dictionary that contains the following:

cancel_apply: If set to True the style will not be applied. This is only used in the CHARACTER_STYLE_APPLYING event.
this_component: The component that the style is being applied to. This is the normally same component passed to the constructor. Usually a XTextCursor.
styler_object: The style that is being applied. This is None when CHARACTER_STYLE_APPLYING is raised. Is the style that was applied when CHARACTER_STYLE_APPLIED is raised.

Other style specific data is also in the dictionary such as the parameter values used to apply the style.

The event_args.event_source is the instance of the CharacterStyler class.

Subscribing to Events:

from ooodev.events.write_named_event import WriteNamedEvent
# ... other code

def on_char_style_applied(src: Any, event_args: EventArgs) -> None:
    styler = cast(CharacterStyler, src)
    skip = styler.extra_data.get("skip", False)
    if skip:
        return
    cursor = cast("XTextCursor", event_args.event_data.get("this_component", None))
    if cursor is None:
        return
    cursor.gotoEnd(False)
    styler.clear()
    event_args.event_source

doc = WriteDoc.create_doc(visible=True)
cursor = doc.get_cursor()

# subscribe to the event that resets the cursor when a style is applied.
cursor.style_direct_char.subscribe_event(WriteNamedEvent.CHARACTER_STYLE_APPLIED, on_char_style_applied)
# or alternatively
# cursor.subscribe_event(WriteNamedEvent.CHARACTER_STYLE_APPLIED, on_char_style_applied)

Parameters:

write_doc (WriteDoc) –
component (Any) –

__init__(write_doc, component)[source]

Constructor.

Parameters:

write_doc (WriteDoc) – Write Document instance.
component (Any) – component instance. Usually a XTextCursor.

Return type:

None

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

clear()[source]

Clears the formatting of the character.

Return type:: None

remove_event_observer(observer)

Removes an observer

Parameters:: observer (EventObserver) – One or more observers to add.
Returns:: True if observer has been removed; Otherwise, False.
Return type:: bool

style_borders(*, right=None, left=None, top=None, bottom=None, border_side=None, shadow=None, padding=None)

Style Write Character Borders.

Parameters:

left (Side | None, optional) – Determines the line style at the left edge.
right (Side | None, optional) – Determines the line style at the right edge.
top (Side | None, optional) – Determines the line style at the top edge.
bottom (Side | None, optional) – Determines the line style at the bottom edge.
border_side (Side | None, optional) – Determines the line style at the top, bottom, left, right edges. If this argument has a value then arguments top, bottom, left, right are ignored
shadow (Shadow | None, optional) – Character Shadow
padding (Padding | None, optional) – Character padding

Raises:

CancelEventError – If the event before_style_char_borders is cancelled and not handled.

Returns:

Attribute Options Style instance or None if cancelled.

Return type:

Borders | None

Hint

BorderLine can be imported from ooodev.format.writer.direct.char.borders
BorderLine2 can be imported from ooodev.format.writer.direct.char.borders
BorderLineKind can be imported from ooodev.format.writer.direct.char.borders
Borders can be imported from ooodev.format.writer.direct.char.borders
LineSize can be imported from ooodev.format.writer.direct.char.borders
Padding can be imported from ooodev.format.writer.direct.char.borders
Shadow can be imported from ooodev.format.inner.direct.write.char.border.shadow
ShadowFormat can be imported from ooodev.format.writer.direct.char.borders
Side can be imported from ooodev.format.writer.direct.char.borders
side can be imported from ooodev.format.writer.direct.char.borders
Sides can be imported from ooodev.format.writer.direct.char.borders
ShadowLocation can be imported from ooo.dyn.table.shadow_location

style_borders_padding(*, left=None, right=None, top=None, bottom=None, all_sides=None)

Style Padding for Write Characters.

Parameters:

left (float, UnitT, optional) – Left (in mm units) or Class UnitT.
right (float, UnitT, optional) – Right (in mm units) or Class UnitT.
top (float, UnitT, optional) – Top (in mm units) or Class UnitT.
bottom (float, UnitT, optional) – Bottom (in mm units) or Class UnitT.
all_sides (float, UnitT, optional) – Left, right, top, bottom (in mm units) or Class UnitT. If argument is present then left, right, top, and bottom arguments are ignored.

Raises:

CancelEventError – If the event before_style_char_borders is cancelled and not handled.

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

style_borders_side(*, line=BorderLineKind.SOLID, color=0, width=LineSize.THIN, shadow=None, padding=None)

Style All Write Character Borders.

Parameters:

line (BorderLineStyleEnum, optional) – Line Style of the border. Default BorderLineKind.SOLID.
color (Color, optional) – Color of the border. Default StandardColor.BLACK
width (LineSize, float, UnitT, optional) – Contains the width in of a single line or the width of outer part of a double line (in pt units) or Class UnitT. If this value is zero, no line is drawn. Default LineSize.THIN
shadow (Shadow | None, optional) – Character Shadow
padding (Padding | None, optional) – Character padding

Raises:

CancelEventError – If the event before_style_char_borders is cancelled and not handled.

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

Hint

BorderLine can be imported from ooodev.format.writer.direct.char.borders
BorderLine2 can be imported from ooodev.format.writer.direct.char.borders
BorderLineKind can be imported from ooodev.format.writer.direct.char.borders
LineSize can be imported from ooodev.format.writer.direct.char.borders
Padding can be imported from ooodev.format.writer.direct.char.borders
Shadow can be imported from ooodev.format.writer.direct.char.borders
ShadowFormat can be imported from ooodev.format.writer.direct.char.borders
ShadowLocation can be imported from ooo.dyn.table.shadow_location

style_font(name=None, size=None, font_style=None, lang=None)

Style Font.

Parameters:

name (str | None, optional) – Font Name.
size (float | UnitT | None, optional) – Font Size in PT units or UnitT.
font_style (str | None, optional) – Font Style such as Bold Italics
lang (FontLangT | None, optional) – Font Language.

Raises:

CancelEventError – If the event before_style_font_only is cancelled and not handled.

Returns:

Font Only instance or None if cancelled.

Return type:

FontOnlyT | None