GPortAuxInfoParam Class Reference

#include <IGraphicsPort.h>

Public Types
enum	AuxInfoObjectType {   kNone, kImage, kTextFrame, kImageStream,   kText, kColor, kTextRun }

Public Member Functions
	GPortAuxInfoParam (AuxInfoObjectType objType)
void	SetObjectType (AuxInfoObjectType bObjType)
void	GetObjectType (AuxInfoObjectType *bObjType)
AuxInfoObjectType	GetObjectType ()
void	SetOPIInfo (IOPIInfo *bOPIInfo)
void	GetOPIInfo (IOPIInfo **bOPIInfo)
IOPIInfo *	GetOPIInfo ()
void	SetObjectRef (const UIDRef &obj)
const UIDRef &	GetObjectRef ()
void	SetTextStart (TextIndex start)
TextIndex	GetTextStart ()
void	SetTextSpan (int32 span)
int32	GetTextSpan ()
void	SetTint (const PMReal &tint)
const PMReal &	GetTint ()

Detailed Description

The following is a class container, to pass on auxiliary information using BeginAuxInfoContext/EndAuxInfoContext. For future usage, we could add kText, and pass on text run information, so a GPort can mark the received text strings from the show() methods, and group them and mark them as paragraphs, or text links.

Member Function Documentation

const UIDRef& GPortAuxInfoParam::GetObjectRef ( )

inline

Get the UIDRef stored with this object.

Returns

UIDRef&: Returns the UIDRef object stored.

void GPortAuxInfoParam::GetObjectType ( AuxInfoObjectType *  bObjType )

inline

Get the type of information stored by this object.

Parameters

AuxInfoObjectType*

bObjType: Return the object type.

AuxInfoObjectType GPortAuxInfoParam::GetObjectType ( )

inline

Get the type of information stored by this object.

Returns

AuxInfoObjectType

void GPortAuxInfoParam::GetOPIInfo ( IOPIInfo **  bOPIInfo )

inline

Get the OPI information stored with this object.

Parameters

IOPIInfo**

bOPIInfo: Returns the OPI object stored.

IOPIInfo* GPortAuxInfoParam::GetOPIInfo ( )

inline

Get the OPI information stored with this object.

Returns

IOPIInfo*: Returns the OPI object stored.

int32 GPortAuxInfoParam::GetTextSpan ( )

inline

Get the span stored with this object.

Returns

int32: Returns the span stored.

TextIndex GPortAuxInfoParam::GetTextStart ( )

inline

Get the starting text index stored with this object.

Returns

TextIndex Returns the TextIndex stored.

const PMReal& GPortAuxInfoParam::GetTint ( )

inline

Get the tint stored with this object.

Returns

PMReal&: Returns the tint stored.

void GPortAuxInfoParam::SetObjectRef ( const UIDRef &  obj )

inline

Store a UIDRef with this object.

Parameters

UIDRef&

obj: UIDRef to store.

void GPortAuxInfoParam::SetObjectType ( AuxInfoObjectType  bObjType )

inline

Set the type of information stored by this object.

Parameters

AuxInfoObjectType

bObjType: object type.

void GPortAuxInfoParam::SetOPIInfo ( IOPIInfo *  bOPIInfo )

inline

Store OPI information with this object.

Parameters

IOPIInfo*

bOPIInfo: OPI object to store.

void GPortAuxInfoParam::SetTextSpan ( int32  span )

inline

Store the span with this object.

Parameters

int32,:

Return span stored.

void GPortAuxInfoParam::SetTextStart ( TextIndex  start )

inline

Store the starting text index with this object.

Parameters

TextIndex

start: TextIndex to store.

void GPortAuxInfoParam::SetTint ( const PMReal &  tint )

inline

Store the tint with this object.

Parameters

const

PMReal& tint: tint to store with this object.