LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Public Attributes | List of all members
Shape Service Referencepublished

specifies the service of shapes in a text document More...

import"Shape.idl";

Inheritance diagram for Shape:
Shape XPropertySet XShape XComponent XShapeDescriptor XGluePointsSupplier XTolerantMultiPropertySet XInterface XShapeDescriptor XInterface XInterface XInterface XInterface XInterface

Included Services

service com::sun::star::drawing::Shape
 

Public Attributes

short AnchorPageNo
 contains the number of the page where the objects are anchored. More...
 
com::sun::star::text::XTextFrame AnchorFrame
 contains the text frame the current frame is anchored to. More...
 
com::sun::star::text::TextContentAnchorType AnchorType
 specifies how the text content is attached to its surrounding Text. More...
 
short HoriOrient
 determines the horizontal orientation of the object. More...
 
long HoriOrientPosition
 contains the horizontal position of the object (1/100 mm). More...
 
short HoriOrientRelation
 determines the environment of the object to which the orientation is related. More...
 
short VertOrient
 determines the vertical orientation of the object. More...
 
long VertOrientPosition
 contains the vertical position of the object (1/100 mm). More...
 
short VertOrientRelation
 determines the environment of the object to which the orientation is related. More...
 
long LeftMargin
 contains the left margin of the object. More...
 
long RightMargin
 contains the right margin of the object. More...
 
long TopMargin
 contains the top margin of the object. More...
 
long BottomMargin
 contains the bottom margin of the object. More...
 
com::sun::star::text::WrapTextMode Surround
 determines the type of the surrounding text. More...
 
boolean SurroundAnchorOnly
 determines if the text of the paragraph in which the object is anchored, wraps around the object. More...
 
boolean SurroundContour
 determines if the text wraps around the contour of the object. More...
 
boolean ContourOutside
 the text flows only around the contour of the object. More...
 
boolean Opaque
 determines if the object is opaque or transparent for text. More...
 
com::sun::star::text::XTextRange TextRange
 contains a text range where the shape should be anchored to. More...
 
short WrapInfluenceOnPosition
 determines the influence of the text wrap on the positioning of the shape More...
 
com::sun::star::drawing::HomogenMatrix3 TransformationInHoriL2R
 determines the transformation of the shape in horizontal left-to-right layout More...
 
short PositionLayoutDir
 determines layout direction the position attributes of the shape is given More...
 
com::sun::star::awt::Point StartPositionInHoriL2R
 determines the start position of the shape in horizontal left-to-right layout More...
 
com::sun::star::awt::Point EndPositionInHoriL2R
 determines the end position of the shape in horizontal left-to-right layout More...
 
- Public Attributes inherited from Shape
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...
 
sequence< com::sun::star::beans::PropertyValueInteropGrabBag
 Grab bag of shape properties, used as a string-any map for interim interop purposes. 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

- Exported Interfaces inherited from Shape
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 glue points. More...
 
interface com::sun::star::beans::XTolerantMultiPropertySet
 
- 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::SetPropertyTolerantFailedsetPropertyValuesTolerant ([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::GetPropertyTolerantResultgetPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence< com::sun::star::beans::GetDirectPropertyTolerantResultgetDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 

Detailed Description

specifies the service of shapes in a text document

Developers Guide
Text - Shape Objects in Text
Text - Formatting

Exported Interfaces

Member Data Documentation

com::sun::star::text::XTextFrame AnchorFrame
property

contains the text frame the current frame is anchored to.

The value is valid only if the AnchorType is TextContentAnchorType::AT_FRAME.

short AnchorPageNo
property

contains the number of the page where the objects are anchored.

The value is valid only if the AnchorType is TextContentAnchorType::AT_PAGE.

com::sun::star::text::TextContentAnchorType AnchorType
optionalproperty

specifies how the text content is attached to its surrounding Text.

long BottomMargin
property

contains the bottom margin of the object.

boolean ContourOutside
property

the text flows only around the contour of the object.

com::sun::star::awt::Point EndPositionInHoriL2R
optionalpropertyreadonly

determines the end position of the shape in horizontal left-to-right layout

This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the end position property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.

Since
OOo 2.0
short HoriOrient
property

determines the horizontal orientation of the object.

See also
BaseFrame::HoriOrientation
long HoriOrientPosition
property

contains the horizontal position of the object (1/100 mm).

It is only valid if "HoriOrient" is HoriOrientation_NONE.

short HoriOrientRelation
property

determines the environment of the object to which the orientation is related.

See also
BaseFrame::RelOrientation
long LeftMargin
property

contains the left margin of the object.

boolean Opaque
property

determines if the object is opaque or transparent for text.

short PositionLayoutDir
optionalproperty

determines layout direction the position attributes of the shape is given

Valid values are given by PositionLayoutDir

Since
OOo 2.0
long RightMargin
property

contains the right margin of the object.

com::sun::star::awt::Point StartPositionInHoriL2R
optionalpropertyreadonly

determines the start position of the shape in horizontal left-to-right layout

This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the start position property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.

Since
OOo 2.0

determines the type of the surrounding text.

Deprecated:
boolean SurroundAnchorOnly
property

determines if the text of the paragraph in which the object is anchored, wraps around the object.

boolean SurroundContour
property

determines if the text wraps around the contour of the object.

contains a text range where the shape should be anchored to.

There are two different ways to get newly created shapes into the text document. One of them is to use the insertTextContent() method of the com::sun::star::text::XSimpleText. The other is to call the add() method of the com::sun::star::drawing::XShapes interface. To be able to determine an anchor position for shape that are anchored at a certain text position the property TextRange is used.

This property is used when the shape gets inserted/added and becomes invalid after that.

long TopMargin
property

contains the top margin of the object.

com::sun::star::drawing::HomogenMatrix3 TransformationInHoriL2R
optionalpropertyreadonly

determines the transformation of the shape in horizontal left-to-right layout

This property is needed for the export of the OASIS Open Office file format to the OpenOffice.org file format. It provides the transformation property of the included service com::sun::star::drawing::Shape converted to the horizontal left-to-right layout.

Since
OOo 2.0
short VertOrient
property

determines the vertical orientation of the object.

See also
BaseFrame::VertOrientation
long VertOrientPosition
property

contains the vertical position of the object (1/100 mm).

It is only valid if TextEmbeddedObject::VertOrient is VertOrientation::NONE.

short VertOrientRelation
property

determines the environment of the object to which the orientation is related.

See also
BaseFrame::RelOrientation
short WrapInfluenceOnPosition
optionalproperty

determines the influence of the text wrap on the positioning of the shape

The value of this property is only evaluated for the positioning of the shape, if the text document setting ConsiderTextWrapOnObjPos is TRUE. Valid values are given by WrapInfluenceOnPosition

Since
OOo 2.0

The documentation for this service was generated from the following file: