Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: drawing ::

service Shape
Description
This abstract service specifies the general characteristics of all Shapes.
See also
XShape, ::com::sun::star::lang::XComponent, ::com::sun::star::text::XText, ShapeDescriptor
Developers Guide
Drawings - Shape Types

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet

handles all the properties of this instance.

XShape

This gives you the size and position of this Shape and lets you change it. You can use getShapeType to determine what kind of shape this is.

::com::sun::star::lang::XComponent

is used for lifetime control of this Shape.

XShapeDescriptor

The XShapeDescriptor tells you what kind of Shape this instance is.

XGluePointsSupplier

This interfaces gives access to an optional container of glue points. To have unique ids you should query the returned interface for ::com::sun::star::container::XIdentifierContainer. (details)

::com::sun::star::beans::XTolerantMultiPropertySet
Properties' Summary
long
ZOrder
[ OPTIONAL ]
is used to query or change the ZOrder of this Shape.  
short
LayerID
[ OPTIONAL ]
This is the ID of the Layer to which this Shape is attached.  
string
LayerName
[ OPTIONAL ]
This is the name of the Layer to which this Shape is attached.  
boolean
Visible
[ OPTIONAL ]
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.  
boolean
Printable
[ OPTIONAL ]
If this is false, the Shape is not visible on printer outputs.  
boolean
MoveProtect
[ OPTIONAL ]
With this set to true, this Shape cannot be moved interactively in the user interface.  
string
Name
[ OPTIONAL ]
This is the name of this Shape.  
boolean
SizeProtect
[ OPTIONAL ]
With this set to true, this Shape may not be sized interactively in the user interface.  
::com::sun::star::style::XStyle
Style
[ OPTIONAL ]
this property lets you get and set a style for this shape.  
HomogenMatrix3
Transformation
[ OPTIONAL ]
this property lets you get and set the transformation matrix for this shape. The transformation is a 3x3 homogen matrix and can contain translation, rotation, shearing and scaling.  
::com::sun::star::container::XNameContainer
ShapeUserDefinedAttributes
[ OPTIONAL ]
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.  
long
NavigationOrder
[ OPTIONAL ]
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.  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
Description
handles all the properties of this instance.
XShape
Description
This gives you the size and position of this Shape and lets you change it. You can use getShapeType to determine what kind of shape this is.
::com::sun::star::lang::XComponent
Description
is used for lifetime control of this Shape.
XShapeDescriptor
Description
The XShapeDescriptor tells you what kind of Shape this instance is.
XGluePointsSupplier
Usage Restrictions
optional
Description
This interfaces gives access to an optional container of glue points. To have unique ids you should query the returned interface for ::com::sun::star::container::XIdentifierContainer.
::com::sun::star::beans::XTolerantMultiPropertySet
Usage Restrictions
optional
Properties' Details
ZOrder
long ZOrder;
Usage Restrictions
optional
Description
is used to query or change the ZOrder of this Shape.
LayerID
short LayerID;
Usage Restrictions
optional
Description
This is the ID of the Layer to which this Shape is attached.
LayerName
string LayerName;
Usage Restrictions
optional
Description
This is the name of the Layer to which this Shape is attached.
Visible
boolean Visible;
Usage Restrictions
optional
Description
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.
Printable
boolean Printable;
Usage Restrictions
optional
Description
If this is false, the Shape is not visible on printer outputs.
MoveProtect
boolean MoveProtect;
Usage Restrictions
optional
Description
With this set to true, this Shape cannot be moved interactively in the user interface.
Name
string Name;
Usage Restrictions
optional
Description
This is the name of this Shape.
SizeProtect
boolean SizeProtect;
Usage Restrictions
optional
Description
With this set to true, this Shape may not be sized interactively in the user interface.
Style
::com::sun::star::style::XStyle Style;
Usage Restrictions
optional
Description
this property lets you get and set a style for this shape.
Transformation
HomogenMatrix3 Transformation;
Usage Restrictions
optional
Description
this property lets you get and set the transformation matrix for this shape. The transformation is a 3x3 homogen matrix and can contain translation, rotation, shearing and scaling.
ShapeUserDefinedAttributes
::com::sun::star::container::XNameContainer ShapeUserDefinedAttributes;
Usage Restrictions
optional
Description
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
See also
::com::sun::star::xml::AttributeContainer
NavigationOrder
long NavigationOrder;
Usage Restrictions
optional
Description
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.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.