LibreOffice
LibreOffice 5.0 SDK API Reference
|
This service is for a CustomShape. More...
import "CustomShape.idl";
Included Services | |
service | com::sun::star::drawing::Shape |
service | com::sun::star::drawing::FillProperties |
service | com::sun::star::drawing::LineProperties |
service | com::sun::star::drawing::ShadowProperties |
service | com::sun::star::drawing::Text |
service | com::sun::star::drawing::RotationDescriptor |
![]() | |
service | com::sun::star::drawing::TextProperties |
The properties in this service describe the style for rendering a shapes text area. More... | |
![]() | |
service | com::sun::star::style::CharacterProperties |
The properties in this service set default formats for text inside the Shape. More... | |
service | com::sun::star::style::CharacterPropertiesAsian |
The properties in this service set default formats for Asian text inside the Shape. More... | |
service | com::sun::star::style::CharacterPropertiesComplex |
The properties in this service set default formats for complex text inside the Shape. More... | |
service | com::sun::star::style::ParagraphProperties |
The properties in this service set default formats for text inside the Shape. More... | |
service | com::sun::star::style::ParagraphPropertiesAsian |
The properties in this service set default formats for Asian text inside the Shape. More... | |
service | com::sun::star::style::ParagraphPropertiesComplex |
The properties in this service set default formats for complex text inside the Shape. More... | |
Public Attributes | |
string | CustomShapeEngine |
This property contains the CustomShapeEngine service name that has to be used for rendering. More... | |
string | CustomShapeData |
This property can be used to store data that the CustomShapeEngine may use for rendering. More... | |
sequence <::com::sun::star::beans::PropertyValue > | CustomShapeGeometry |
This property describes the geometry of the CustomShape. More... | |
string | CustomShapeReplacementURL |
This property describes the URL to a replacement graphic that could be displayed if the CustomShape engine is not available. More... | |
![]() | |
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::PropertyValue > | InteropGrabBag |
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... | |
![]() | |
FillStyle | FillStyle |
This enumeration selects the style the area will be filled with. More... | |
com::sun::star::util::Color | FillColor |
If the property FillStyle is set to FillStyle::SOLID, this is the color used. More... | |
short | FillTransparence |
This is the transparence of the filled area. More... | |
string | FillTransparenceGradientName |
If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. More... | |
com::sun::star::awt::Gradient | FillTransparenceGradient |
This describes the transparency of the fill area as a gradient. More... | |
string | FillGradientName |
If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style. More... | |
com::sun::star::awt::Gradient | FillGradient |
If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. More... | |
string | FillHatchName |
If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style. More... | |
Hatch | FillHatch |
If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used. More... | |
boolean | FillBackground |
if this is TRUE , the transparent background of a hatch filled area is drawn in the current background color. More... | |
string | FillBitmapName |
If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style. More... | |
com::sun::star::awt::XBitmap | FillBitmap |
If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used. More... | |
string | FillBitmapURL |
If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used. More... | |
short | FillBitmapPositionOffsetX |
This is the horizontal offset where the tile starts. More... | |
short | FillBitmapPositionOffsetY |
This is the vertical offset where the tile starts. More... | |
short | FillBitmapOffsetX |
Every second line of tiles is moved the given percent of the width of the bitmap. More... | |
short | FillBitmapOffsetY |
Every second row of tiles is moved the given percent of the height of the bitmap. More... | |
RectanglePoint | FillBitmapRectanglePoint |
The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering. More... | |
boolean | FillBitmapLogicalSize |
specifies if the size is given in percentage or as an absolute value. More... | |
long | FillBitmapSizeX |
This is the width of the tile for filling. More... | |
long | FillBitmapSizeY |
This is the height of the tile for filling. More... | |
BitmapMode | FillBitmapMode |
this enum selects how a area is filled with a single bitmap. More... | |
boolean | FillBitmapStretch |
if set, the fill bitmap is stretched to fill the area of the shape. More... | |
boolean | FillBitmapTile |
if set, the fill bitmap is repeated to fill the area of the shape. More... | |
com::sun::star::text::GraphicCrop | GraphicCrop |
contains the cropping of the object. More... | |
![]() | |
com::sun::star::drawing::LineStyle | LineStyle |
This property contains the type of the line. More... | |
com::sun::star::drawing::LineDash | LineDash |
This property contains the dash of the line. More... | |
string | LineDashName |
This property contains the name of the dash of the line. More... | |
com::sun::star::util::Color | LineColor |
This property contains the line color. More... | |
short | LineTransparence |
This property contains the extent of transparency. More... | |
long | LineWidth |
This property contains the width of the line in 1/100th mm. More... | |
com::sun::star::drawing::LineJoint | LineJoint |
This property defines the rendering of joints between thick lines. More... | |
com::sun::star::drawing::LineCap | LineCap |
This property defines the rendering of ends of thick lines. More... | |
string | LineStartName |
This property contains the name of the line start poly polygon Bezier. More... | |
string | LineEndName |
This property contains the name of the line end poly polygon Bezier. More... | |
com::sun::star::drawing::PolyPolygonBezierCoords | LineStart |
This property contains the line start in the form of a poly polygon Bezier. More... | |
com::sun::star::drawing::PolyPolygonBezierCoords | LineEnd |
This property contains the line end in the form of a poly polygon Bezier. More... | |
boolean | LineStartCenter |
If this property is TRUE , the line will start from the center of the polygon. More... | |
long | LineStartWidth |
This property contains the width of the line start polygon. More... | |
boolean | LineEndCenter |
If this property is TRUE , the line will end in the center of the polygon. More... | |
long | LineEndWidth |
This property contains the width of the line end polygon. More... | |
![]() | |
boolean | Shadow |
enables/disables the shadow of a Shape. More... | |
com::sun::star::util::Color | ShadowColor |
This is the color of the shadow of this Shape. More... | |
short | ShadowTransparence |
This defines the degree of transparence of the shadow in percent. More... | |
long | ShadowXDistance |
This is the horizontal distance of the left edge of the Shape to the shadow. More... | |
long | ShadowYDistance |
This is the vertical distance of the top edge of the Shape to the shadow. More... | |
![]() | |
long | RotateAngle |
This is the angle for rotation of this Shape. More... | |
long | ShearAngle |
This is the amount of shearing for this Shape. More... | |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
interface | com::sun::star::text::XText |
With this interface you can modify the text of this Shape. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
string | getShapeType () |
![]() | |
void | insertTextContent ([in] com::sun::star::text::XTextRange xRange,[in] com::sun::star::text::XTextContent xContent,[in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException ) |
inserts a content, such as a text table, text frame or text field. More... | |
void | removeTextContent ([in] com::sun::star::text::XTextContent xContent) raises ( com::sun::star::container::NoSuchElementException ) |
removes the specified content from the text object. More... | |
![]() | |
com::sun::star::container::XIndexContainer | getGluePoints () |
![]() | |
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... | |
![]() | |
float | CharHeightAsian |
This value contains the height of the characters in point. More... | |
float | CharWeightAsian |
This property contains the value of the font weight. More... | |
string | CharFontNameAsian |
This property specifies the name of the font style. More... | |
string | CharFontStyleNameAsian |
This property contains the name of the font style. More... | |
short | CharFontFamilyAsian |
This property contains font family as specified in com.sun.star.awt.FontFamily . More... | |
short | CharFontCharSetAsian |
This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More... | |
short | CharFontPitchAsian |
This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More... | |
com::sun::star::awt::FontSlant | CharPostureAsian |
This property contains the value of the posture of the document. More... | |
com::sun::star::lang::Locale | CharLocaleAsian |
contains the value of the locale. More... | |
![]() | |
float | CharHeightComplex |
This value contains the height of the characters in point. More... | |
float | CharWeightComplex |
This property contains the value of the font weight. More... | |
string | CharFontNameComplex |
This property specifies the name of the font style. More... | |
string | CharFontStyleNameComplex |
This property contains the name of the font style. More... | |
short | CharFontFamilyComplex |
This property contains font family as specified in com.sun.star.awt.FontFamily . More... | |
short | CharFontCharSetComplex |
This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More... | |
short | CharFontPitchComplex |
This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More... | |
com::sun::star::awt::FontSlant | CharPostureComplex |
This property contains the value of the posture of the document. More... | |
com::sun::star::lang::Locale | CharLocaleComplex |
contains the value of the locale. More... | |
![]() | |
boolean | ParaIsHangingPunctuation |
determines if hanging punctuation is allowed. More... | |
boolean | ParaIsCharacterDistance |
determines if a distance between Asian text, western text or complex text is set. More... | |
boolean | ParaIsForbiddenRules |
determines if the rules for forbidden characters at the start or end of text lines are considered. More... | |
![]() | |
short | WritingMode |
contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants More... | |
This service is for a CustomShape.
service com::sun::star::drawing::Shape |
service com::sun::star::drawing::Text |
|
optionalproperty |
This property can be used to store data that the CustomShapeEngine may use for rendering.
|
property |
This property contains the CustomShapeEngine service name that has to be used for rendering.
|
optionalproperty |
This property describes the geometry of the CustomShape.
The CustomShapeEngine that is used should be able to get on with the content of this property.
If the CustomShapeEngine property is "com.sun.star.drawing.EnhancedCustomShapeEngine", then this property is containing properties as they are specified in the service com.sun.star.drawing.EnhancedCustomShapeGeometry
|
optionalproperty |
This property describes the URL to a replacement graphic that could be displayed if the CustomShape engine is not available.