// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TGIFTranslator  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Inherits From:
 | TForeignDataTranslator 
> Inherited By:
 | None. 
> Purpose:
 | This class provides an interface to convert between a foreign data value containing a GIF file and a CommonPoint graphic.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | Deriving classes can modify or replace the conversion mechanism by overriding CreateScrapItem and/or ExportData.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGIFTranslator::TGIFTranslator ;
 | 1. TGIFTranslator ()  
 | 2. TGIFTranslator (const TGIFTranslator & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators or directly.  
 | 2. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. const TGIFTranslator & source -The translator to copy.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGIFTranslator::~ TGIFTranslator ;
 | virtual ~ TGIFTranslator ()  
> 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: TGIFTranslator::operator =;
 | TGIFTranslator & operator =(const TGIFTranslator & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TGIFTranslator & source -The translator to copy.  
> 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: TGIFTranslator::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: TGIFTranslator::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 TInvalidVersionError if the object version isn't known.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGIFTranslator::CreateScrapItem ;
 | virtual TScrapItem * CreateScrapItem (const TForeignData & inputData, const TTypeDescription & desiredType, TMemoryHeap * heap =0) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Translates between a foreign data type, which should contain a GIF file, and a CommonPoint data type, which is wrapped up in a scrap item.  
> Calling Context:
 | Called by the Data Tanslation framework, but can be called directly.  
> Parameters:
 = const TForeignData & inputData -The foreign data object to translate.  
 = const TTypeDescription & desiredType -The desired CommonPoint data type for the returned scrap item.  
 = TMemoryHeap * heap =0 -The heap in which to create the result.  
> Return Value:
 | Returns the scrap item that was created, or NIL if conversion was unsuccessful.  
> Exceptions:
 | Throws TForeignDataException if the requested type can't be created.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGIFTranslator::ExportData ;
 | virtual void ExportData (const TTypeDescription & inputType, const TScrapItem & inputData, const TForeignDataType & desiredType, TForeignData & output) const  
> Interface Category:
 | Sample.  
> Purpose:
 | In normal translators, this converts between a CommonPoint scrap item and a foreign data value, but TGIFTranslator does not currently implement this function, so no conversion takes place.  
> Calling Context:
 | Called by the Data Translation framework, but can be called directly.  
> Parameters:
 = const TTypeDescription & inputType -The type of the scrap item.  
 = const TScrapItem & inputData -The scrap item to be converted.  
 = const TForeignDataType & desiredType -The requested result type.  
 = TForeignData & output -The resulting foreign data value.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif