Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMValidationInterfaces Interface CATIMarker3DText

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIMarker3DText

Interface to manage an 3D Text.

Errors not documented on each method:

E_OUTOFMEMORY: One memory allocation fails.
E_UNEXPECTED: There is an unexpected failure.

Method Index

o GetLeaderEndType(int&): Retrieves the leader end type of the Marker.
o GetLeaderPointingPoint(CATMathPoint&): Retrieves the Pointing Point of the leader of the Marker.
o GetPosition(CATMathPoint&): Retrieves the Position of the Marker.
o GetTextBoxOrientation(double&): Retrieves the angle of orientation of a text box.
o GetTextContent(CATListOfCATUnicodeString&): Retrieves the TextContent of the Marker.
o GetTextDirection(int&): Retrieves the direction to read the text.
o GetTextFontName(CATUnicodeString&): Retrieves the Font Name of the Marker.
o GetTextFontSize(double&): Retrieves the Font Size of the Marker.
o HasABorder(CATBoolean&): Retrieves the border status of the Marker.
o HasALeader(CATBoolean&): Retrieves the leader status of the Marker.
o IsFilled(CATBoolean&): Retrieves the filled status of the Marker.
o SetBorder(CATBoolean&): Sets the border status of the Marker.
o SetFilled(CATBoolean&): Sets the filled status of the Marker.
o SetLeader(CATBoolean&): Sets the leader status of the Marker.
o SetLeaderEndType(int&): Sets the leader end type of the Marker.
o SetLeaderPointingPoint(CATMathPoint&): Sets the Pointing Point of the leader of the Marker.
o SetPosition(CATMathPoint&): Sets the Position of the Marker.
o SetTextBoxOrientation(double&): Sets the angle of orientation of a text box.
o SetTextContent(CATListOfCATUnicodeString&): Sets the TextContent of the Marker.
o SetTextDirection(int&): Sets the leader end type of the Marker.
o SetTextFontName(CATUnicodeString&): Sets the Font Name of the Marker.
o SetTextFontSize(double&): Sets the Font Size of the Marker.

Methods

o GetLeaderEndType

public virtual GetLeaderEndType( oLeaderEndType)

Retrieves the leader end type of the Marker.

Parameters:

oLeaderEndType

The leader end type.
Legal values:

0: The leader end type is an arrow.
1: The leader end type is a bubble.
2: The leader end type is nothing.

Returns:

HRESULT
Legal values:

S_OK: The leader end type is successfully returned.
E_FAIL: The leader end type is not returned.

o GetLeaderPointingPoint

public virtual GetLeaderPointingPoint( oPoint)

Retrieves the Pointing Point of the leader of the Marker.

Parameters:

oPoint: The Point.

Returns:

HRESULT
Legal values:

S_OK: The Point is successfully returned.
E_FAIL: The Point is not returned.

o GetPosition

public virtual GetPosition( oPoint)

Retrieves the Position of the Marker. if the Text Marker has a leader, oPoint is the leader break point. if the Text Marker hasn't a leader, oPoint is the top left corner of the text box.

Parameters:

oPoint: The Point.

Returns:

HRESULT
Legal values:

S_OK: The Point is successfully returned.
E_FAIL: The Point is not returned.

o GetTextBoxOrientation

public virtual GetTextBoxOrientation( oAngle)

Retrieves the angle of orientation of a text box.

Parameters:

oAngle: The angle of orientation expressed in degree between 0 and 360.

Returns:

HRESULT
Legal values:

S_OK: The angle is successfully returned.
E_FAIL: The angle is not returned.

o GetTextContent

public virtual GetTextContent( oText)

Retrieves the TextContent of the Marker.

Parameters:

oText: The TextContent. Each element of the list corresponds to a line of text.

Returns:

HRESULT
Legal values:

S_OK: The TextContent is successfully returned.
E_FAIL: The TextContent is not returned.

o GetTextDirection

public virtual GetTextDirection( oTextDirection)

Retrieves the direction to read the text.

Parameters:

oTextDirection

The text direction
Legal values:

0: direction : left to right.
1: direction : top to bottom.
2: direction : right to left.
3: direction : bottom to top.

Returns:

HRESULT
Legal values:

S_OK: The direction is successfully returned.
E_FAIL: The direction is not returned.

o GetTextFontName

public virtual GetTextFontName( oName)

Retrieves the Font Name of the Marker.

Parameters:

oName: The Font Name.

Returns:

HRESULT
Legal values:

S_OK: The Font Name is successfully returned.
E_FAIL: The Font Name is not returned.

o GetTextFontSize

public virtual GetTextFontSize( oSize)

Retrieves the Font Size of the Marker.

Parameters:

oSize: The Font Size : value between 1 and 99.

Returns:

HRESULT
Legal values:

S_OK: The Font Size is successfully returned.
E_FAIL: The Font Size is not returned.

o HasABorder

public virtual HasABorder( oHasABorder)

Retrieves the border status of the Marker.

Parameters:

oHasABorder

The status.
Legal values:

true: The Marker has a border.
false: The Marker hasn't a border.

Returns:

HRESULT
Legal values:

S_OK: The marker Text has a border.
E_FAIL: The marker Text hasn't a border.

o HasALeader

public virtual HasALeader( oHasALeader)

Retrieves the leader status of the Marker.

Parameters:

oHasALeader

The status.
Legal values:

true: The Marker has a leader.
false: The Marker hasn't a leader.

Returns:

HRESULT
Legal values:

S_OK: The marker Text has a leader.
E_FAIL: The marker Text hasn't a leader.

o IsFilled

public virtual IsFilled( oFilled)

Retrieves the filled status of the Marker.

Parameters:

oFilled

The status.
Legal values:

true: The Marker is filled.
false: The Marker is unfilled.

Returns:

HRESULT
Legal values:

S_OK: The status is successfully returned.
E_FAIL

o SetBorder

public virtual SetBorder( iHasABorder)

Sets the border status of the Marker.

Parameters:

iHasABorder

The status.
Legal values:

true: The Marker has a border.
false: The Marker hasn't a border.

Returns:

HRESULT
Legal values:

S_OK: The status is successfully set.
E_FAIL: The status is not set.

o SetFilled

public virtual SetFilled( iFilled)

Sets the filled status of the Marker.

Parameters:

iFilled

The status.
Legal values:

true: The Marker status is filled.
false: The Marker status is unfilled.

Returns:

HRESULT
Legal values:

S_OK: The status is successfully set.
E_FAIL: The status is not set.

o SetLeader

public virtual SetLeader( iHasALeader)

Sets the leader status of the Marker.

Parameters:

iHasALeader

The status.
Legal values:

true: The Marker has a leader.
false: The Marker hasn't a leader.

Returns:

HRESULT
Legal values:

S_OK: The status is successfully set.
E_FAIL: The status is not set.

o SetLeaderEndType

public virtual SetLeaderEndType( iLeaderEndType)

Sets the leader end type of the Marker.

Parameters:

iLeaderEndType

The status.
Legal values:

0: The leader end type is an arrow.
1: The leader end type is a bubble.
2: The leader end type is nothing.

Returns:

HRESULT
Legal values:

S_OK: The status is successfully set.
E_FAIL: The status is not set.

o SetLeaderPointingPoint

public virtual SetLeaderPointingPoint( iPoint)

Sets the Pointing Point of the leader of the Marker.

Parameters:

iPoint: The Point.

Returns:

HRESULT
Legal values:

S_OK: The Point is successfully set.
E_FAIL: The Point is not set.

o SetPosition

public virtual SetPosition( iPoint)

Sets the Position of the Marker. if the Text Marker has a leader, iPoint is the leader break point. if the Text Marker hasn't a leader, iPoint is the top left corner of the text box.

Parameters:

iPoint: The Point.

Returns:

HRESULT
Legal values:

S_OK: The Point is successfully set.
E_FAIL: The Point is not set.

o SetTextBoxOrientation

public virtual SetTextBoxOrientation( iAngle)

Sets the angle of orientation of a text box.

Parameters:

iAngle: The angle of orientation expressed in degree between 0 and 360.

Returns:

HRESULT
Legal values:

S_OK: The angle is successfully set.
E_FAIL: The angle is not set.

o SetTextContent

public virtual SetTextContent( iText)

Sets the TextContent of the Marker.

Parameters:

iText: The TextContent. Each element of the list corresponds to a line of text.

Returns:

HRESULT
Legal values:

S_OK: The TextContent is successfully set.
E_FAIL: The TextContent is not set.

o SetTextDirection

public virtual SetTextDirection( iTextDirection)

Sets the leader end type of the Marker.

Parameters:

iLeaderEndType

The status.
Legal values:

0: The leader end type is an arrow.
1: The leader end type is a bubble.
2: The leader end type is nothing.

Returns:

HRESULT
Legal values:

S_OK: The direction is successfully set.
E_FAIL: The direction is not set.

o SetTextFontName

public virtual SetTextFontName( iName)

Sets the Font Name of the Marker.

Parameters:

iName: The Font Name.

Returns:

HRESULT
Legal values:

S_OK: The Font Name is successfully set.
E_FAIL: The Font Name is not set.

o SetTextFontSize

public virtual SetTextFontSize( iSize)

Sets the Font Size of the Marker.

Parameters:

iSize: The FontSize : value between 1 and 99.

Returns:

HRESULT
Legal values:

S_OK: The Font Size is successfully set.
E_FAIL: The Font Size is not set.

This object is included in the file: CATIMarker3DText.h
If needed, your Imakefile.mk should include the module: PLMValidationItf