ooodev.format.writer.direct.image.hyperlink package

Module contents

class ooodev.format.writer.direct.image.hyperlink.ImageMapOptions(*, server_map=False)[source]

Bases: StyleBase

Image Map Options

New in version 0.9.0.

__init__(*, server_map=False)[source]

Constructor

Parameters:: server_map (str, optional) – Server side image map. Defaults to False.
Return type:: None

apply(obj: Any)[source]

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies padding to obj

Parameters:

obj (Any) – UNO object that supports com.sun.star.style.CharacterProperties service.
kwargs (Any, optional) – Expandable list of key value pairs that may be used in child classes.

Return type:

None

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets Image Map info instance from object.

Parameters:: obj (object) – UNO object.
Raises:: NotSupportedError – If obj is not supported.
Returns:: Instance that represents obj Image map options.
Return type:: ImageMapOptions

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_server_map: bool

Gets/Sets server side

Return type:: bool

class ooodev.format.writer.direct.image.hyperlink.LinkTo(*, name=None, url=None, target=TargetKind.NONE)[source]

Bases: StyleBase

Link to.

New in version 0.9.0.

__init__(*, name=None, url=None, target=TargetKind.NONE)[source]

Constructor

Parameters:

name (str, optional) – Link name.
url (str, optional) – Link URL.
target (TargetKind, str, optional) – Link target. Defaults to TargetKind.NONE.

Return type:

None

apply(obj: Any)[source]

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies padding to obj

Parameters:

obj (Any) – UNO object that supports com.sun.star.style.CharacterProperties service.
kwargs (Any, optional) – Expandable list of key value pairs that may be used in child classes.

Return type:

None

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets hyperlink instance from object

Parameters:: obj (Any) – UNO object.
Raises:: NotSupportedError – If obj is not supported.
Returns:: LinkTo that represents obj Hyperlink.
Return type:: LinkTo

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_name: str | None

Gets/Sets name

Return type:: str | None

property prop_target: str

Gets/Sets target

Return type:: str

property prop_url: str | None

Gets/Sets url

Return type:: str | None