![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TTextToolInteractionTarget
Inherited By:
None.
Purpose:
TDocumentTextToolInteractionTarget is derived from TTextToolInteractionTarget. It is a tool target that can create and extend document text selections from positional information.
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.
- TDocumentTextToolInteractionTarget (TDocumentTextView * view)
- TDocumentTextToolInteractionTarget (const TDocumentTextToolInteractionTarget & target)
- TDocumentTextToolInteractionTarget ()
Interface Category:
API.
Purpose:
- Constructs a TDocumentTextToolInteractionTarget for use with the specified document text view.
- Copy constructor.
- Default constructor. This constructor is protected.
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:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TDocumentTextToolInteractionTarget ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Typically not called directly by clients.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void ExtendTextSelection (const TGPoint & extendPoint, TTextOffset anchorOffset, MTextSelection & selection) const
Interface Category:
API.
Purpose:
Extends the current selection area.
Calling Context:
Called by the Text Framework command classes. Typically not called directly by clients.
Parameters:
- const TGPoint & extendPoint -Point in view to extend to.
- TTextOffset anchorOffset -Offset location of present selection.
- MTextSelection & selection -Reference to selection to extend.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void GetTextSelectionColor (TColor & color) const
Interface Category:
API.
Purpose:
Retrieves the current text selection color. Called to determine the current color. This should be called during tool interaction prior to changing the color, to save the current color for later restoration.
Calling Context:
Called by the Text Framework command classes. Typically not called directly by clients.
Parameters:
- TColor & color -Receives the selection color.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void SetTextSelectionColor (const TColor & color)
Interface Category:
API.
Purpose:
Changes the text selection color. Used to change the selection feedback during tool interaction with text. If the tool is a selection tool, the highlight should not be changed. But it may be appropriate for an effector tool to highlight in a different color than the selection 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:
If the selection color is changed during a tool's interaction, the current highlight color should be saved first, and restored at the end of the tool's interaction with the text.
TDocumentTextToolInteractionTarget & operator =(const TDocumentTextToolInteractionTarget &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called by the Text Framework command classes. Typically not called directly by clients.
Parameters:
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:
None.
virtual TStream & operator >>=(TStream & towhere) 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 & towhere -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:
None.
virtual TStream & operator <<= (TStream & fromwhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called by the Text Framework command classes. Typically not called directly by clients.
Parameters:
- TStream & fromwhere -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:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.