// $Revision: 1.6 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TSimpleDragAndDropItem  
> Taxonomy Category:
 | Document Samples  
 | GlobalSelectionTool  
> Interface Category:
 | Sample.  
> Inherits From:
 | TDragAndDropItem 
> Inherited By:
 | None. 
> Purpose:
 | TDragAndDropItem is abstract class that encapsulates the complete set of representations of a logically dragged item. It is what is provided on the drag source side to a drag and drop interactor.  
 | TDragAndDropItem can intuitively be thought of as representing an internal collection of TScrapItems. CopyAvailableTypes can then be explained as providing the sum collection of available types providable by the logical collection of scrap items. FindItemMatchingDescription returns a pointer to the scrap item that represents the specified type description. Both of these functions are pure abstract.  
> 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: TSimpleDragAndDropItem::TSimpleDragAndDropItem ;
 | 1. TSimpleDragAndDropItem (const TViewHandle & viewForActions)  
 | 2. TSimpleDragAndDropItem (const TSimpleDragAndDropItem & source)  
 | 3. TSimpleDragAndDropItem ()  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Creates a new drag and drop item. The specified view is used to delete this drag and drop item when the AcceptDrop function has completed and returned.  
 | 2. Copy constructor.  
 | 3. Default constructor.  
> Calling Context:
 | 1. Called to create a new TDragAndDropItem.  
 | 2. Called to copy an object.  
 | 3. Called by the stream-in operators and derived classes.  
> Parameters:
 = 1. const TViewHandle & viewForActions -The view whose request processor will delete the new TDragAndDropItem.  
 = 2. const TSimpleDragAndDropItem & source -The object to be copied.  
 = 3. 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: TSimpleDragAndDropItem::~ TSimpleDragAndDropItem ;
 | ~ TSimpleDragAndDropItem ()  
> 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: TSimpleDragAndDropItem::operator =;
 | TSimpleDragAndDropItem & operator =(const TSimpleDragAndDropItem & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TSimpleDragAndDropItem & source -The object to be copied.  
> 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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TSimpleDragAndDropItem::operator >>=;
 | virtual TStream & operator >>=(TStream & toStream) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Stream-out operator.  
> Calling Context:
 | Called to stream out data.  
> Parameters:
 = TStream & toStream -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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TSimpleDragAndDropItem::operator <<= ;
 | virtual TStream & operator <<= (TStream & fromStream)  
> Interface Category:
 | Sample.  
> Purpose:
 | Stream-in operator.  
> Calling Context:
 | Called to stream in data.  
> Parameters:
 = TStream & fromStream -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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TSimpleDragAndDropItem::CopyAvailableTypes ;
 | virtual void CopyAvailableTypes (TSequenceOf < TTypeDescription > & result, TMemoryHeap * whichHeap =NIL) const
> Interface Category:
 | Sample.  
> Purpose:
 | Provides the sum collection of available types providable by the logical collection of scrap items.  
> Calling Context:
 | Called from the Input System framework when negotiating the data type of the dropped item.  
> Parameters:
 = TSequenceOf < TTypeDescription > & result -The set of types in which the dropped item is available as returned by this function.
 = TMemoryHeap * whichHeap =NIL -The heap into which to place the result.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TSimpleDragAndDropItem::FindItemMatchingDescription ;
 | virtual TScrapItem * FindItemMatchingDescription (const TTypeDescription & theDescription)  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns a pointer to the scrap item that represents the specified type description.  
> Calling Context:
 | Called from the Input System framework when the dropped type has been agreed upon.  
> Parameters:
 = const TTypeDescription & theDescription -The data type required by the drop acceptor.  
> Return Value:
 | Returns the scrap item that is of the specified type.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TSimpleDragAndDropItem::AdoptScrapItem ;
 | virtual void AdoptScrapItem (TScrapItem * scrapItem)  
> Interface Category:
 | Sample.  
> Purpose:
 | Adds a new scrap item type to the list of available types.  
> Calling Context:
 | Called by clients.  
> Parameters:
 = TScrapItem * scrapItem -The scrap item to add to the list.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TSimpleDragAndDropItem::CopyDictionaryAndScraps ;
 | void CopyDictionaryAndScraps (const TDequeOf < TScrapItem > & otherScraps) 
> Interface Category:
 | Sample.  
> Purpose:
 | An internal convenience function for use by the copy constructor and assignment operator to copy internal data.  
> Calling Context:
 | Called by the assignement and copy constructors.  
> Parameters:
 = const TDequeOf < TScrapItem > & otherScraps -The items to copy.
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif