LibreOffice
LibreOffice 7.4 SDK API Reference
|
This abstract service specifies the general characteristics of all Shapes. More...
import"Shape.idl";
Public Types | |
typedef sequence< com::sun::star::beans::PropertyValue > | InteropGrabBag |
Grab bag of shape properties, used as a string-any map for interim interop purposes. More... | |
Exported Interfaces | |
interface | com::sun::star::beans::XPropertySet |
handles all the properties of this instance. More... | |
interface | com::sun::star::drawing::XShape |
This gives you the size and position of this Shape and lets you change it. More... | |
interface | com::sun::star::lang::XComponent |
is used for lifetime control of this Shape. More... | |
interface | com::sun::star::drawing::XShapeDescriptor |
The XShapeDescriptor tells you what kind of Shape this instance is. More... | |
interface | com::sun::star::drawing::XGluePointsSupplier |
This interfaces gives access to an optional container of gluepoints. More... | |
interface | com::sun::star::beans::XTolerantMultiPropertySet |
Public Attributes | |
long | ZOrder |
is used to query or change the ZOrder of this Shape. More... | |
short | LayerID |
This is the ID of the Layer to which this Shape is attached. More... | |
string | LayerName |
This is the name of the Layer to which this Shape is attached. More... | |
boolean | Visible |
If this is FALSE , the Shape is not visible on screen outputs. More... | |
boolean | Printable |
If this is FALSE , the Shape is not visible on printer outputs. More... | |
boolean | MoveProtect |
With this set to TRUE , this Shape cannot be moved interactively in the user interface. More... | |
string | Name |
This is the name of this Shape. More... | |
boolean | SizeProtect |
With this set to TRUE , this Shape may not be sized interactively in the user interface. More... | |
com::sun::star::style::XStyle | Style |
this property lets you get and set a style for this shape. More... | |
com::sun::star::drawing::HomogenMatrix3 | Transformation |
this property lets you get and set the transformation matrix for this shape. More... | |
com::sun::star::container::XNameContainer | ShapeUserDefinedAttributes |
this property stores xml attributes. More... | |
long | NavigationOrder |
this property stores the navigation order of this shape. More... | |
string | Hyperlink |
this property lets you get and set a hyperlink for this shape. More... | |
short | RelativeHeight |
contains the relative height of the object. More... | |
short | RelativeWidth |
contains the relative width of the object. More... | |
short | RelativeHeightRelation |
contains the relation of the relative height of the object. More... | |
short | RelativeWidthRelation |
contains the relation of the relative width of the object. More... | |
Additional Inherited Members | |
Public Member Functions inherited from XPropertySet | |
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () |
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) |
sets the value of the property with the specified name. More... | |
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XPropertyChangeListener to the specified property. More... | |
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XPropertyChangeListener from the listener list. More... | |
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
adds an XVetoableChangeListener to the specified property with the name PropertyName. More... | |
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) |
removes an XVetoableChangeListener from the listener list. More... | |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. More... | |
void | acquire () |
increases the reference counter by one. More... | |
void | release () |
decreases the reference counter by one. More... | |
Public Member Functions inherited from XShape | |
com::sun::star::awt::Point | getPosition () |
gets the current position of this object. More... | |
void | setPosition ([in] com::sun::star::awt::Point aPosition) |
sets the current position of this object More... | |
com::sun::star::awt::Size | getSize () |
gets the size of this object. More... | |
void | setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException ) |
sets the size of this object. More... | |
Public Member Functions inherited from XShapeDescriptor | |
string | getShapeType () |
Public Member Functions inherited from XComponent | |
void | dispose () |
The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More... | |
void | addEventListener ([in] XEventListener xListener) |
adds an event listener to the object. More... | |
void | removeEventListener ([in] XEventListener aListener) |
removes an event listener from the listener list. More... | |
Protected Member Functions inherited from XGluePointsSupplier | |
com::sun::star::container::XIndexContainer | getGluePoints () |
Protected Member Functions inherited from XTolerantMultiPropertySet | |
sequence< com::sun::star::beans::SetPropertyTolerantFailed > | setPropertyValuesTolerant ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException ) |
sets the values to the properties with the specified names. More... | |
sequence< com::sun::star::beans::GetPropertyTolerantResult > | getPropertyValuesTolerant ([in] sequence< string > aPropertyNames) |
retrieve the values of the specified properties More... | |
sequence< com::sun::star::beans::GetDirectPropertyTolerantResult > | getDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames) |
retrieve only those values of the specified properties which are direct values. More... | |
This abstract service specifies the general characteristics of all Shapes.
|
optionalproperty |
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.
interface com::sun::star::beans::XPropertySet |
handles all the properties of this instance.
|
optional |
|
optional |
This interfaces gives access to an optional container of gluepoints.
To have unique ids you should query the returned interface for com::sun::star::container::XIdentifierContainer.
interface com::sun::star::drawing::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.
The XShapeDescriptor tells you what kind of Shape this instance is.
interface com::sun::star::lang::XComponent |
is used for lifetime control of this Shape.
|
optionalproperty |
this property lets you get and set a hyperlink for this shape.
|
optionalproperty |
With this set to TRUE
, this Shape cannot be moved interactively in the user interface.
|
optionalproperty |
This is the name of this Shape.
|
optionalproperty |
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.
|
optionalproperty |
If this is FALSE
, the Shape is not visible on printer outputs.
|
optionalproperty |
contains the relative height of the object.
It is only valid if it is greater than zero.
|
optionalproperty |
contains the relation of the relative height of the object.
It is only valid if RelativeHeight is greater than zero.
|
optionalproperty |
contains the relative width of the object.
It is only valid if it is greater than zero.
|
optionalproperty |
contains the relation of the relative width of the object.
It is only valid if RelativeWidth is greater than zero.
|
optionalproperty |
this property stores xml attributes.
They will be saved to and restored from automatic styles inside xml files.
|
optionalproperty |
With this set to TRUE
, this Shape may not be sized interactively in the user interface.
|
optionalproperty |
this property lets you get and set a style for this shape.
|
optionalproperty |
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.
|
optionalproperty |
|
optionalproperty |
is used to query or change the ZOrder of this Shape.