Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TToolInteractor, MMouseEventHandler
Inherited By:
None.
Purpose:
THighlightTextToolInteractor is derived from TToolInteractor and MMouseEventHandler. It is an interactor that gives selection feedback in the highlight color, and actually sets the highlight color at the end of the interaction on all the text selected. THighlightTextToolInteractor objects are created by calling the CreateInteractor function of THighlightTextTool objects.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
This class is designed to be used directly.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
- THighlightTextToolInteractor (MToolHandler * handlerAlias, TTextToolInteractionTarget * targetToAdopt, TColor * colorToAdopt)
- THighlightTextToolInteractor (const THighlightTextToolInteractor & interactor)
Interface Category:
API.
Purpose:
- Constructs a highlight text tool interactor with the specified tool handler, target, and color.
- Copy constructor.
Calling Context:
- Typically not called directly by clients.
- 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 ~ THighlightTextToolInteractor ()
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 bool MouseDown (TMouseDownEvent & mouseDown)
Interface Category:
API.
Purpose:
Handles the event that occurs when the user pushes down the mouse button. Sets up for the mouse dragging to follow. Creates a text tool interaction target selection at the mouse down position, and sets the text selection color.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
- TMouseDownEvent & mouseDown -The mouse-down event that caused this function to be called.
Return Value:
Returns true when finished handling the event.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Overrides inherited MMouseEventHandler function.
virtual bool MouseUp (TMouseUpEvent & mouseUp)
Interface Category:
API.
Purpose:
Handles the event that occurs when the user lets the mouse button up. Extends the text tool interaction target selection based on the mouse up position. Applies the background color style. Computes the final position of the mouse and sets an insertion point at the computed location.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
- TMouseUpEvent & mouseUp -The mouse-up event that caused this function to be called.
Return Value:
Returns true when finished handling the event.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Overrides inherited MMouseEventHandler function.
virtual bool MouseMoved (TMouseMovedEvent & mouseMoved)
Interface Category:
API.
Purpose:
Tracks mouse movement for click and drag behavior. Extends the text tool interaction target selection based on the current position of the mouse.
Calling Context:
Called by the Text Framework classes. Typically not called directly by clients.
Parameters:
- TMouseMovedEvent & mouseMoved -The mouse-moved event that caused this function to be called.
Return Value:
Returns true when finished handling the event.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Overrides inherited MMouseEventHandler function.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.