service CaptionShape in module com::sun::star::drawing::

(Global Index)

Syntax

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

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

Description

the position and size is only used for the caption area


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

Description

This is a set of properties to describe the style for rendering an area.


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

Description

This is a set of properties to describe the style for rendering a Line.


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

Description

This is a set of properties to describe the style for rendering a shadow.


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

Description

This abstract service specifies the general characteristics of an optional text inside a Shape .


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

Description

This abstract service specifies the general characteristics of an optional rotation and shearing for a Shape .


Property Summary

CornerRadius This is the radius of the caption area corners.

CaptionPoint The caption point property specify the position of the point that is captioned. A set of lines are rendered from the caption area.

CaptionType This property specifies the geometry of the line of a caption.

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.

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

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

CaptionEscapeDirection This property specifies the escape direction for the line of a caption.

CaptionIsEscapeRelative If this property is true , the property CaptionEscapeRelative is used, else the property CaptionEscapeAbsolute is used.

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

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

CaptionLineLength This property specifies the length of the caption line.

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

Property Details



CornerRadius

Syntax

long CornerRadius;

Description

This is the radius of the caption area corners.


CaptionPoint

Syntax

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

Syntax

short CaptionType;

Description

This property specifies the geometry of the line of a caption.

See also

CaptionType

CaptionIsFixedAngle

Syntax

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

Syntax

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

Syntax

long CaptionGap;

Description

This property specifies the distance between the text area of the caption and the start of the line.


CaptionEscapeDirection

Syntax

long CaptionEscapeDirection;

Description

This property specifies the escape direction for the line of a caption.

See also

CaptionEscapeDirection;

CaptionIsEscapeRelative

Syntax

boolean CaptionIsEscapeRelative;

Description

If this property is true , the property CaptionEscapeRelative is used, else the property CaptionEscapeAbsolute is used.


CaptionEscapeRelative

Syntax

long CaptionEscapeRelative;

Description

This property specifies the relativ escape distance for the line of a caption.


CaptionEscapeAbsolute

Syntax

long CaptionEscapeAbsolute;

Description

This property specifies the absolut escape distance for the line of a caption.


CaptionLineLength

Syntax

long CaptionLineLength;

Description

This property specifies the length of the caption line.


CaptionIsFitLineLength

Syntax

boolean CaptionIsFitLineLength;

Description

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

Top of Page