ooodev.adapter.drawing.shape_partial_props module

This class is a partial class for com.sun.star.drawing.Shape service. It may be used in classes that implement the ooodev.adapter.drawing.shape_comp.ShapeComp class. These properties are optional for a shape service.

class ooodev.adapter.drawing.shape_partial_props.ShapePartialProps(component)[source]

Bases: object

Partial Class for Shape Service.

Parameters:: component (Shape) –

__init__(component)[source]

Constructor

Parameters:: component (Shape) – UNO Component that implements com.sun.star.drawing.Shape service.
Return type:: None

property hyperlink: str | None

Gets/Sets, this property lets you get and set a hyperlink for this shape.

optional

Return type:: str | None

property interop_grab_bag: Tuple[PropertyValue, ...] | None

Gets/Sets grab bag of shape properties, used as a string-any map for interim interop purposes. This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

optional

Return type:: Tuple[PropertyValue, …] | None

property layer_id: int | None

Gets/Sets the ID of the Layer to which this Shape is attached.

optional

Return type:: int | None

property layer_name: str | None

Gets/Sets the name of the Layer to which this Shape is attached.

optional

Return type:: str | None

property move_protect: bool | None

Gets/Sets, With this set to True, this Shape cannot be moved interactively in the user interface.

optional

Return type:: bool | None

property name: str | None

Gets/Sets the name of this Shape.

Return type:: str | None

property navigation_order: int | None

Gets/Sets, this property stores the navigation order of this shape. If this value is negative, the navigation order for this shapes page is equal to the z-order.

optional

Return type:: int | None

property printable: bool | None

Gets/Sets, If this is False, the Shape is not visible on printer outputs.

optional

Return type:: bool | None

property relative_height: int | None

Gets/Sets the relative height of the object.

It is only valid if it is greater than zero.

optional

Return type:: int | None

property relative_height_relation: int | None

Gets/Sets the relation of the relative height of the object.

It is only valid if RelativeHeight is greater than zero.

optional

Return type:: int | None

property relative_width: int | None

Gets/Sets the relative width of the object.

It is only valid if it is greater than zero.

optional

Return type:: int | None

property relative_width_relation: int | None

Gets/Sets the relation of the relative width of the object.

It is only valid if RelativeWidth is greater than zero.

optional

Return type:: int | None

property shape_user_defined_attributes: XNameContainer | None

Gets/Sets, this property stores xml attributes.

They will be saved to and restored from automatic styles inside xml files.

optional

Return type:: XNameContainer | None

property size_protect: bool | None

Gets/Sets, With this set to True, this Shape may not be sized interactively in the user interface.

optional

Return type:: bool | None

property style: StyleComp | None

Gets/Sets, this property lets you get and set a style for this shape.

When setting property can be a StyleComp or XStyle.

optional

Return type:: StyleComp | None

property transformation: HomogenMatrix3StructComp | None

Gets/Sets, this property lets you get and set the transformation matrix for this shape.

The transformation is a 3x3 homogeneous matrix and can contain translation, rotation, shearing and scaling.

When setting property can be a HomogenMatrix3 or HomogenMatrix3StructComp.

optional

Returns:: The transformation matrix for this shape or None if property not supported.
Return type:: HomogenMatrix3StructComp | None

Hint

HomogenMatrix3 can be imported from ooo.dyn.drawing.homogen_matrix3

property visible: bool | None

Gets/Sets, If this is False, the Shape is not visible on screen outputs.

Please note that the Shape may still be visible when printed, see Printable.

optional

Return type:: bool | None

property z_order: int | None

Gets/Sets the Zorder of this Shape.

optional

Return type:: int | None