// $Revision: 1.5 $ // Copyright (C) 1995 Taligent, Inc. All rights reserved. #if 0 --------------------------------------------------------------------------- > Class: | MSelectionToolHandler > Taxonomy Category: | Documented Samples | GlobalSelectionTool > Interface Category: | Sample. > Inherits From: | MGUIToolHandler > Inherited By: | TDOMDocumentComponentView > Purpose: | Implements a selection tool handler that supports the arrow tool. > Instantiation: | Allocate on the heap or the stack. > Deriving Classes: | None. > Concurrency: | _Not_ multithread safe. > Resource Use: | No special requirements. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::MSelectionToolHandler ; | MSelectionToolHandler (MFeedbacker * feedbacker, MSelectionMapping * mapping, MGUIBundle * bundle) > Interface Category: | Sample. > Purpose: | Constructor. > Calling Context: | Called in derived class constructors and by clients. > Parameters: = MFeedbacker * feedbacker -The feedbacker that targets should use. = MSelectionMapping * mapping -The mapping that targets should use. = MGUIBundle * bundle -The MGUIBundle that TCurrentSelectionTargets should use to access the current selection. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::~ MSelectionToolHandler ; | virtual ~ MSelectionToolHandler () > Interface Category: | Sample. > Purpose: | Destructor. > Calling Context: | Called to destroy an object. > Parameters: = Takes no parameters. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::CreateToolTarget ; | virtual MToolTarget * CreateToolTarget (const TTypeDescription &, const TGPoint &) const > Interface Category: | Sample. > Purpose: | Creates a tool target of a specific type. > Calling Context: | Called by tools. > Parameters: = const TTypeDescription & -The type of target desired. = const TGPoint & -The mouse location in global coordinates. > Return Value: | The requested tool target, or NIL if a target could not be created. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::CreateToolInteractor ; | virtual TToolInteractor * CreateToolInteractor (const TGPoint &, const TToken & hint) const > Interface Category: | Sample. > Purpose: | Creates an interactor for delegating cursor tools. > Calling Context: | Called by the Cursor Tool framework. > Parameters: = const TGPoint & -The mouse location in global coordinates. = const TToken & hint -A _hint_ of the type of interaction desired by the tool. Each delegating cursor tool has a unique hint. The hint for the standard arrow tool is "Arrow". > Return Value: | A TToolInteractor that performs the desired interactions. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::AdoptAndDo ; | virtual void AdoptAndDo (TToolCommandBinding *) > Interface Category: | Sample. > Purpose: | Adopts the tool binding and does the command. > Calling Context: | Called by clients. > Parameters: = TToolCommandBinding * -The command binding to execute. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::DoBegin ; | virtual void DoBegin (TToolCommandBinding &) > Interface Category: | Sample. > Purpose: | Starts interaction. > Calling Context: | Called by clients. > Parameters: = TToolCommandBinding & -The command binding to execute. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::DoIncrement ; | virtual void DoIncrement (TToolCommandBinding &) > Interface Category: | Sample. > Purpose: | Increments interaction. > Calling Context: | Called directly by clients. > Parameters: = TToolCommandBinding & -The command binding to execute. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::AdoptAndDoEnd ; | virtual void AdoptAndDoEnd (TToolCommandBinding *) > Interface Category: | Sample. > Purpose: | Completes interaction. > Calling Context: | Called directly by clients. > Parameters: = TToolCommandBinding * -The command binding to execute. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::GetFeedbacker ; | MFeedbacker * GetFeedbacker () const > Interface Category: | Sample. > Purpose: | Gets the feedbacker used by the handler and the targets it creates. > Calling Context: | Called by derived classes and internally. > Parameters: = Takes no parameters. > Return Value: | The feedbacker used by the handler and the targets it creates. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::GetSelectionMapping ; | MSelectionMapping * GetSelectionMapping () const > Interface Category: | Sample. > Purpose: | Gets the mapping used by the handler and the targets it creates. > Calling Context: | Called by derived classes and internally. > Parameters: = Takes no parameters. > Return Value: | The mapping used by the handler and the targets it creates. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: MSelectionToolHandler::GetGUIBundle ; | MGUIBundle * GetGUIBundle () const > Interface Category: | Sample. > Purpose: | Gets the MGUIBundle used by the handler and the targets it creates. > Calling Context: | Called by derived classes and internally. > Parameters: = Takes no parameters. > Return Value: | The MGUIBundle used by the handler and the targets it creates. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif