// $Revision: 1.5 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | MFeedbacker  
> Taxonomy Category:
 | GlobalSelectionTool  
 | Feedback subsystem  
> Interface Category:
 | Sample.  
> Inherits From:
 | None. 
> Inherited By:
 | TDOMDocumentComponentView 
> Purpose:
 | MFeedbacker class defines a protocol and provides an implementation for feedback management.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | None.  
> Concurrency:
 | Multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | MFeedbacker is internally multitask safe. Derived classes are not allowed to call anything but the HandleXXX member functions from the feedback member functions or a deadlock results.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::MFeedbacker ;
 | MFeedbacker (const TViewHandle & view)  
> Interface Category:
 | Sample.  
> Purpose:
 | Constructor.  
> Calling Context:
 | Called by functions that construct MFeedbacker objects.  
> Parameters:
 = const TViewHandle & view -The feedback coordinate view. This view establishes the coordinate system for feedback graphics.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::~ MFeedbacker ;
 | virtual ~ MFeedbacker ()  
> 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:
 | Multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::AdoptFeedback ;
 | void AdoptFeedback (MGraphic * graphic)  
> Interface Category:
 | Sample.  
> Purpose:
 | Adds feedback to the feedback list. The feedback is drawn when DrawFeedback is called.  
> Calling Context:
 | Called by selection tool targets to add feedback.  
> Parameters:
 = MGraphic * graphic -The new feedback.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | This function acquires an internal lock.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::OrphanFeedback ;
 | MGraphic * OrphanFeedback (const MGraphic & graphic)  
> Interface Category:
 | Sample.  
> Purpose:
 | Removes feedback from the feedback list.  
> Calling Context:
 | Called by selection tool targets to remove feedback.  
> Parameters:
 = const MGraphic & graphic -The feedback to remove.  
> Return Value:
 | The removed graphic.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | This function acquires an internal lock.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::ReplaceFeedback ;
 | MGraphic * ReplaceFeedback (const MGraphic & oldFeedback, MGraphic * newFeedback)  
> Interface Category:
 | Sample.  
> Purpose:
 | Replaces one feedback graphic with another. This function performs a more efficient update than doing OrphanFeedback followed by AdoptFeedback.  
> Calling Context:
 | Called by selection tool targets to change feedback.  
> Parameters:
 = const MGraphic & oldFeedback -The feedback to remove.  
 = MGraphic * newFeedback -The feedback to add.  
> Return Value:
 | The removed feedback.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | This function acquires an internal lock.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::DrawFeedback ;
 | bool DrawFeedback (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Draws all adopted feedback graphics to a port.  
> Calling Context:
 | Typically called by a viewÕs DrawContents function during updates.  
> Parameters:
 = TGrafPort & port -The port in which feedback should be drawn.  
> Return Value:
 | Returns true if any drawing took place, false otherwise.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | This function acquires an internal lock.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::GetFeedbackView ;
 | TViewHandle GetFeedbackView () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the coordinate system view used by the MFeedbacker.  
> Calling Context:
 | Called by selection tool targets when creating feedback graphics.  
> Parameters:
 = Takes no parameters  
> Return Value:
 | The coordinate view.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::HandleHideCurrentSelectionFeedback ;
 | virtual void HandleHideCurrentSelectionFeedback ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Informs the client that it should not draw any feedback except by calling DrawFeedback. By default, the feedback coordinate view is invalidated.  
> Calling Context:
 | Called when the first feedback graphic is added to the feedbacker.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::HandleShowCurrentSelectionFeedback ;
 | virtual void HandleShowCurrentSelectionFeedback ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Informs the client that it can draw feedback other than tool feedback. By default, the feedback coordinate view is invalidated.  
> Calling Context:
 | Called after the last feedback graphic is orphaned.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MFeedbacker::HandleFeedbackChanged ;
 | virtual void HandleFeedbackChanged (const TGArea & area)  
> Interface Category:
 | Sample.  
> Purpose:
 | Informs the client that feedback has changed and the feedback view needs updating. By default, the feedback coordinate view is invalidated.  
> Calling Context:
 | Called whenever feedback is adopted, orphaned, or replaced.  
> Parameters:
 = const TGArea & area -The area in need of an update.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif