Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

service Shape

Description
This abstract service specifies the general characteristics of all Shape s.
See also
XShape
See also
com::sun::star::lang::XComponent
See also
com::sun::star::text::XText
See also
ShapeDescriptor


Exported Interfaces

com::sun::star::beans::XPropertySet
Description
handles all the properties of this instance.
com::sun::star::drawing::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 .
com::sun::star::drawing::XShapeDescriptor
Description
The XShapeDescriptor tells you what kind of Shape this instance is.
com::sun::star::drawing::XGluePointsSupplier
[ 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 .

Properties' Summary

ZOrder [ OPTIONAL ]
is used to query or change the ZOrder of this Shape .
LayerID [ OPTIONAL ]
This is the ID of the Layer to which this Shape is attached.
LayerName [ OPTIONAL ]
This is the name of the Layer to which this Shape is attached.
Printable [ OPTIONAL ]
If this is false , the Shape is not visible on printer outputs.
MoveProtect [ OPTIONAL ]
With this set to true , this Shape cannot be moved interactively in the user interface.
Name [ OPTIONAL ]
This is the name of this Shape .
SizeProtect [ OPTIONAL ]
With this set to true , this Shape may not be sized interactively in the user interface.
Style [ OPTIONAL ]
this property lets you get and set a style for this shape.
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.
ShapeUserDefinedAttributes [ OPTIONAL ]
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.

Properties' Details

ZOrder
 
long ZOrder;
[ OPTIONAL ]
Description
is used to query or change the ZOrder of this Shape .
LayerID
 
short LayerID;
[ OPTIONAL ]
Description
This is the ID of the Layer to which this Shape is attached.
LayerName
 
string LayerName;
[ OPTIONAL ]
Description
This is the name of the Layer to which this Shape is attached.
Printable
 
boolean Printable;
[ OPTIONAL ]
Description
If this is false , the Shape is not visible on printer outputs.
MoveProtect
 
boolean MoveProtect;
[ OPTIONAL ]
Description
With this set to true , this Shape cannot be moved interactively in the user interface.
Name
 
string Name;
[ OPTIONAL ]
Description
This is the name of this Shape .
SizeProtect
 
boolean SizeProtect;
[ 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;
[ OPTIONAL ]
Description
this property lets you get and set a style for this shape.
Transformation
 
com::sun::star::drawing::HomogenMatrix3 Transformation;
[ 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;
[ 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

Top of Page