ooodev.format.proto.structs.gradient_struct_t module

protocol ooodev.format.proto.structs.gradient_struct_t.GradientStructT

Bases: StyleT, Protocol

Gradient Struct Protocol

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

__init__(*, style=Ellipsis, step_count=Ellipsis, x_offset=Ellipsis, y_offset=Ellipsis, angle=Ellipsis, border=Ellipsis, start_color=Ellipsis, start_intensity=Ellipsis, end_color=Ellipsis, end_intensity=Ellipsis)

Parameters:

• style (GradientStyle) –

• step_count (int) –

• x_offset (Intensity | int) –

• y_offset (Intensity | int) –

• angle (Angle | int) –

• border (Intensity | int) –

• start_color (Color) –

• start_intensity (Intensity | int) –

• end_color (Color) –

• end_intensity (Intensity | int) –

Return type:

None

from_obj(obj: Any) → GradientStructT

from_obj(obj: Any, **kwargs) → GradientStructT

from_obj(**kwds)

Helper for @overload to raise when called.

classmethod from_preset(preset)

classmethod from_preset(preset, **kwargs)

classmethod from_preset(preset, **kwargs)

Return type:

GradientStructT

Parameters:

preset (PresetGradientKind) –

classmethod from_uno_struct(value)

classmethod from_uno_struct(value, **kwargs)

classmethod from_uno_struct(value, **kwargs)

Return type:

GradientStructT

Parameters:

value (Gradient) –

get_json()

Get Gradient represented as a json string for use with dispatch commands.

Returns:

Json string.

Return type:

str

get_uno_struct()

Gets UNO Gradient from instance.

Returns:

Gradient instance

Return type:

Gradient

__protocol_attrs__ = {'add_event_listener', 'add_event_observer', 'apply', 'backup', 'copy', 'from_obj', 'from_preset', 'from_uno_struct', 'get_attrs', 'get_json', 'get_props', 'get_uno_struct', 'get_update_obj', 'has_update_obj', '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', 'prop_angle', 'prop_border', 'prop_end_color', 'prop_end_intensity', 'prop_format_kind', 'prop_has_attribs', 'prop_has_backup', 'prop_parent', 'prop_start_color', 'prop_start_intensity', 'prop_step_count', 'prop_style', 'prop_x_offset', 'prop_y_offset', 'remove_event_listener', 'remove_event_observer', 'restore', 'set_update_obj', 'support_service', 'update'}

property prop_angle: Angle

Gets/Sets angle of the gradient.

Return type:

Angle

property prop_border: Intensity

Gets/Sets percent of the total width where just the start color is used.

Return type:

Intensity

property prop_end_color: Color

Gets/Sets the color at the end point of the gradient.

Return type:

NewType()(Color, int)

property prop_end_intensity: Intensity

Gets/Sets the intensity at the end point of the gradient.

Return type:

Intensity

property prop_start_color: Color

Gets/Sets the color at the start point of the gradient.

Return type:

NewType()(Color, int)

property prop_start_intensity: Intensity

Gets/Sets the intensity at the start point of the gradient.

Return type:

Intensity

property prop_step_count: int

Gets/Sets the number of steps of change color.

Return type:

int

property prop_style: GradientStyle

Gets/Sets the style of the gradient.

Return type:

GradientStyle

property prop_x_offset: Intensity

Gets/Sets the X-coordinate, where the gradient begins.

Return type:

Intensity

property prop_y_offset: Intensity

Gets/Sets the Y-coordinate, where the gradient begins.

Return type:

Intensity