Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftElementWithLeader

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

interface CATIDftElementWithLeader

Interface on Leader list management.

See also:

Method Index

o AddLeader(int,double[2],CATIDftLeader**,CATSymbolType): Add a leader to the element.
o GetAnchorDelta(int,double*): Get the leader anchor delta without view scale.
o GetAnchorPoint(int,double [2]): Returns the position of a particular anchor point for leader.
o GetAnchorPoints(int*,double**,int**,double**): Returns all possible anchor points for leaders on the element.
o GetExtendedLeaderAnchorPointsAvailability(CATBoolean&): Returns the availability of extended leader anchor points.
o GetLeader(int,CATIDftLeader**): Returns a particular leader.
o GetNbLeader(int*): Returns the number of leader on the element.
o GetStandardBehavior(boolean*)
o RemoveLeader(int): Removes a leader.
o SetAnchorDelta(int,double): Set the leader anchor delta without view scale.
o SetExtendedLeaderAnchorPointsAvailability(CATBoolean): Set the availability of extended leader anchor points.
o SetStandardBehavior(boolean)
o SlideAlongLeader(double,double): Slide the text along its leaders.

Methods

o AddLeader

public virtual AddLeader(		`iAnchorOnElement`,
	const	`iEndPoint`,
		`oLeader`,
		`iSymbolType`	`= NOTUSED`)

Add a leader to the element.

Parameters:

iAnchorOnElement: [in] The rank of the point in the list returned by GetAnchorPoints
iEndPoint: [in] The point of the arrow
oLeader: [out] A pointer on the leader added.
iSymbolType: [in] The type of the symbol (can be automaticly overriden by some annotations)

o GetAnchorDelta

public virtual GetAnchorDelta(	const	`iNoLeader`,
		`oDelta`)

Get the leader anchor delta without view scale.

Parameters:

oDelta

Returns:

HRESULT S_OK : implementation succeed E_FAIL : implementation failed S_READONLY : only default value is return in oDelta.

o GetAnchorPoint

public virtual GetAnchorPoint(		`iNoPoint`,
		`oPoint`)

Returns the position of a particular anchor point for leader.

Parameters:

iNoPoints: [in] rank of the point in the possible list of anchor point.
oPoint: [out] The point.

o GetAnchorPoints

public virtual GetAnchorPoints(		`oNbPoints`,
		`oPointListe`,
		`oPointIsValid`,
		`oDeltaListe`)

Returns all possible anchor points for leaders on the element.

Parameters:

oNbPoints: [out] Number of possible points to anchor leader.
oPointListe: [out, delete] Liste of points, X1,Y1,X2,Y2,...
oPointIsValid: [out, delete] Liste of usable points rank in the previous list.
oDeltaListe: [out, delete] Liste of delta for anchor point

o GetExtendedLeaderAnchorPointsAvailability

public virtual GetExtendedLeaderAnchorPointsAvailability( oBool)

Returns the availability of extended leader anchor points.

Parameters:

oBool: if oBool = TRUE -> All leader anchor points are available if oBool = FALSE -> Only restricted leader anchor point are available

Returns:

HRESULT S_OK : implementation succeed E_FAIL : implementation failed S_READONLY : there is no available extended leader anchor points

o GetLeader

public virtual GetLeader(		`iNoLeader`,
		`oLeader`)

Returns a particular leader.

Parameters:

iNoLeader: The rank of the leader. Start to 1 to number of leader returned by GetNbLeader method.
oLeader: A pointer on the leader.

o GetNbLeader

public virtual GetNbLeader( oNbLeader)

Returns the number of leader on the element.

Parameters:

oNbLeader: The number of leader on the element.

o GetStandardBehavior

public virtual GetStandardBehavior( oStd)

Deprecated:: R210 please use GetExtendedLeaderAnchorPointsAvailability

o RemoveLeader

public virtual RemoveLeader( iNoLeader)

Removes a leader.

Parameters:

iNoLeader: [in] Rank of leader to delete. If iNoLeader is equal to 0, all leaders will be deleted.

o SetAnchorDelta

public virtual SetAnchorDelta(	const	`iNoLeader`,
	const	`iDelta`)

Set the leader anchor delta without view scale.

Parameters:

iDelta

o SetExtendedLeaderAnchorPointsAvailability

public virtual SetExtendedLeaderAnchorPointsAvailability( const iBool)

Set the availability of extended leader anchor points.

Parameters:

iBool: if iBool = TRUE -> All leader anchor points are available if iBool = FALSE -> Only restricted leader anchor point are available

Returns:

HRESULT S_OK : implementation succeed E_FAIL : implementation failed E_NOTIMPL : there is no available extended leader anchor points

o SetStandardBehavior

public virtual SetStandardBehavior( const iStd)

Deprecated:: R210 please use SetExtendedLeaderAnchorPointsAvailability

o SlideAlongLeader

public virtual SlideAlongLeader(	const	`iDeltaX`,
	const	`iDeltaY`)

Slide the text along its leaders.

Parameters:

iDeltaX
iDeltaY

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