ooodev.adapter.style.drop_cap_format_struct_comp module

class ooodev.adapter.style.drop_cap_format_struct_comp.DropCapFormatStructComp(component, prop_name, event_provider=None)[source]

Bases: StructBase[DropCapFormat]

Drop Cap Format Struct.

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_style_DropCapFormat_changing. The event raised after the property is changed is called com_sun_star_style_DropCapFormat_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)[source]

Constructor

Parameters:

  • component (DropCapFormat) – Drop Cap Format Component.

  • 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 count: int

This is the number of characters in the drop cap.

Return type:

int

property distance: UnitMM100

Gets/Sets the distance between the drop cap in the following text.

Returns:

Distance in 100th of a millimeter.

Return type:

UnitMM100

Hint

  • UnitMM100 can be imported from ooodev.units

property lines: int

This is the number of lines used for a drop cap.

Return type:

int