Service CaptionShape

Devguide

Index

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

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

service CaptionShape

Description: The CaptionShape represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing.

Included Services - Summary
Shape	the position and size is only used for the caption area
FillProperties	(referenced entity's summary:) This is a set of properties to describe the style for rendering an area.
LineProperties	(referenced entity's summary:) This is a set of properties to describe the style for rendering a Line.
ShadowProperties	(referenced entity's summary:) This is a set of properties to describe the style for rendering a shadow.
Text	(referenced entity's summary:) This abstract service specifies the general characteristics of an optional text inside a Shape.
RotationDescriptor	(referenced entity's summary:) This abstract service specifies the general characteristics of an optional rotation and shearing for a Shape. This service is depricated, instead please use the `Transformation` property of the service Shape.

Properties' Summary
long CornerRadius	This is the radius of the caption area corners.
::com::sun::star::awt::Point CaptionPoint	The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area.
short CaptionType	This property specifies the geometry of the line of a caption.
boolean CaptionIsFixedAngle	This property specifies if the escape angle of the line of a caption is fixed or free. If this is set to false, the application can choose the best possible angle. If not, the value in `CaptionAngle` is used.
long CaptionAngle	This property specifies the escape angle of the line of a caption. It is only used if `CaptionIsFixedAngle` is set to true
long CaptionGap	This property specifies the distance between the text area of the caption and the start of the line.
long CaptionEscapeDirection	This property specifies the escape direction for the line of a caption.
boolean CaptionIsEscapeRelative	If this property is true, the property `CaptionEscapeRelative` is used, else the property `CaptionEscapeAbsolute` is used.
long CaptionEscapeRelative	This property specifies the relativ escape distance for the line of a caption.
long CaptionEscapeAbsolute	This property specifies the absolut escape distance for the line of a caption.
long CaptionLineLength	This property specifies the length of the caption line.
boolean CaptionIsFitLineLength	If this property is true, the application determines the best possible length for the caption line.

Included Services - Details

Shape

Description the position and size is only used for the caption area

FillProperties

(referenced entity's summary:) This is a set of properties to describe the style for rendering an area.

LineProperties

(referenced entity's summary:) This is a set of properties to describe the style for rendering a Line.

ShadowProperties

(referenced entity's summary:) This is a set of properties to describe the style for rendering a shadow.

Text

(referenced entity's summary:) This abstract service specifies the general characteristics of an optional text inside a Shape.

RotationDescriptor

(referenced entity's summary:) This abstract service specifies the general characteristics of an optional rotation and shearing for a Shape. This service is depricated, instead please use the `Transformation` property of the service Shape.

Properties' Details

CornerRadius

long CornerRadius; Description This is the radius of the caption area corners.

CaptionPoint

::com::sun::star::awt::Point CaptionPoint; Description The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area.

CaptionType

short CaptionType; Description This property specifies the geometry of the line of a caption. See also CaptionType

CaptionIsFixedAngle

boolean CaptionIsFixedAngle; Description This property specifies if the escape angle of the line of a caption is fixed or free. If this is set to false, the application can choose the best possible angle. If not, the value in `CaptionAngle` is used.

CaptionAngle

long CaptionAngle; Description This property specifies the escape angle of the line of a caption. It is only used if `CaptionIsFixedAngle` is set to true

CaptionGap

long CaptionGap; Description This property specifies the distance between the text area of the caption and the start of the line.

CaptionEscapeDirection

long CaptionEscapeDirection; Description This property specifies the escape direction for the line of a caption. See also CaptionEscapeDirection

CaptionIsEscapeRelative

boolean CaptionIsEscapeRelative; Description If this property is true, the property `CaptionEscapeRelative` is used, else the property `CaptionEscapeAbsolute` is used.

CaptionEscapeRelative

long CaptionEscapeRelative; Description This property specifies the relativ escape distance for the line of a caption.

CaptionEscapeAbsolute

long CaptionEscapeAbsolute; Description This property specifies the absolut escape distance for the line of a caption.

CaptionLineLength

long CaptionLineLength; Description This property specifies the length of the caption line.

CaptionIsFitLineLength

boolean CaptionIsFitLineLength; Description If this property is true, the application determines the best possible length for the caption line.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous