Class: TStandardIBeamTool

Declaration: TextToolsCore.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardArrowTool

Inherited By:

None.

Purpose:

TStandardIBeamTool is derived from TStandardArrowTool. When the cursor enters a text component, the cursor shape is changed to an I-beam.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardIBeamTool::TStandardIBeamTool

TStandardIBeamTool ()
TStandardIBeamTool (const TStandardIBeamTool &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Typically not called directly by clients.
Typically not called directly by clients.

Parameters:

Takes no parameters.
const TStandardIBeamTool & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardIBeamTool::~TStandardIBeamTool

virtual ~ TStandardIBeamTool ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardIBeamTool::operator=

TStandardIBeamTool & operator =(const TStandardIBeamTool &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Typically not called directly by clients.

Parameters:

const TStandardIBeamTool & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited MCollectible function.

Member Function: TStandardIBeamTool::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Typically not called directly by clients.

Parameters:

TStream & -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited MCollectible function.

Member Function: TStandardIBeamTool::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Typically not called directly by clients.

Parameters:

TStream & -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited MCollectible function.

Member Function: TStandardIBeamTool::GetPaletteText

virtual void GetPaletteText (TText &) const

Interface Category:

API.

Purpose:

Returns tool name as the palette text.

Calling Context:

Called by the Text Framework classes. Typically not called directly by clients.

Parameters:

TText & -Receives the text for the tool name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TStandardArrowTool function.

Member Function: TStandardIBeamTool::CreatePaletteGraphic

virtual MGraphic * CreatePaletteGraphic () const

Interface Category:

API.

Purpose:

Returns NIL for the palette graphic.

Calling Context:

Called by the Text Framework classes. Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

NIL.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TStandardArrowTool function.

Member Function: TStandardIBeamTool::CreateCursorGraphic

virtual MGraphic * CreateCursorGraphic () const

Interface Category:

API.

Purpose:

Returns a shape for the cursor graphic.

Calling Context:

Called by the Text Framework classes. Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

A pointer to a graphic with a shape.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TStandardArrowTool function.

Member Function: TStandardIBeamTool::GetHint

virtual TToken GetHint () const

Interface Category:

API.

Purpose:

Returns TToken representing this tool.

Calling Context:

Called by the Text Framework classes. Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

Returns TToken representing this tool.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Click the icon to mail questions or corrections about this material to Taligent personnel.