Class: THighlightTextTool

Declaration: TextToolsCore.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSimpleMouseTool

Inherited By:

None.

Purpose:

THighlightTextTool is a tool that sets the background fill color on text.

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: THighlightTextTool::THighlightTextTool

THighlightTextTool ()
THighlightTextTool (TColor * colorToAdopt)
THighlightTextTool (const THighlightTextTool &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a text tool with the specified background highlight color.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
TColor * colorToAdopt -The background highlight color for the tool to adopt.
const THighlightTextTool & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THighlightTextTool::~THighlightTextTool

virtual ~ THighlightTextTool ()

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: THighlightTextTool::GetHighlightColor

virtual void GetHighlightColor (TColor & color) const

Interface Category:

API.

Purpose:

Accessor that returns the tool's current highlight color.

Calling Context:

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

Parameters:

TColor & color -Receives the background highlight color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THighlightTextTool::SetHighlightColor

virtual void SetHighlightColor (const TColor & color)

Interface Category:

API.

Purpose:

Sets the tool's background highlight color to the specified color.

Calling Context:

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

Parameters:

const TColor & color -The new color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THighlightTextTool::operator=

THighlightTextTool & operator =(const THighlightTextTool &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const THighlightTextTool & -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: THighlightTextTool::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called by the Text Framework command classes. 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: THighlightTextTool::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called by the Text Framework command classes. 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: THighlightTextTool::GetPaletteText

virtual void GetPaletteText (TText &) const

Interface Category:

API.

Purpose:

Returns text representing name of tool. For example Hilight tool.

Calling Context:

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

Parameters:

TText & -Receives the text of the tool name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TTool function.

Member Function: THighlightTextTool::CreatePaletteGraphic

virtual MGraphic * CreatePaletteGraphic () const

Interface Category:

API.

Purpose:

Returns NIL for the palette graphic.

Calling Context:

Called by the Text Framework command 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 TTool function.

Member Function: THighlightTextTool::CreateCursorGraphic

virtual MGraphic * CreateCursorGraphic () const

Interface Category:

API.

Purpose:

Creates and returns a shape for the cursor graphic.

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

A pointer to a graphic with highlight pen shape.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TTool function.

Member Function: THighlightTextTool::CreateInteractor

virtual TToolInteractor * CreateInteractor (MToolTarget* adoptTarget) const

Interface Category:

API.

Purpose:

Creates and returns a pointer to a THighlightTextToolInteractor if the target is a TTextToolInteractionTarget. Otherwise returns NIL.

Calling Context:

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

Parameters:

MToolTarget * adoptTarget -A pointer to the target to adopt.

Return Value:

A pointer to a THighlightTextToolInteractor if the target is a TTextToolInteractionTarget. Otherwise returns NIL.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TSimpleMouseTool function.

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