// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TXBMConverter :: TXBMConverterException  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Inherits From:
 | None. 
> Inherited By:
 | None. 
> Purpose:
 | This exception is thrown by the XBMConverter when a problem arises during conversion of an X-Bitmap stream.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | No special considerations.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Enumeration:
 | TXBMConverter :: TXBMConverterException :: ErrorCode  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Purpose:
 | Enumerates the different failure exception conditions that can arise during X-Bitmap conversion.  
> Tags:
 = kNotXBM -The stream provided does not contain an X-Bitmap file.  
 = kBadData -The stream provided cannot be parsed as an X-Bitmap file.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TXBMConverterException::TXBMConverterException ;
 | 1. TXBMConverterException ()  
 | 2. TXBMConverterException (ErrorCode)  
 | 3. TXBMConverterException (const TXBMConverterException &)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Constructs with an error value to indicate the cause.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operator.  
 | 2. Called to create an exception with an indication of its cause.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. ErrorCode -The code of the error.  
 = 3. const TXBMConverterException & -The object 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: TXBMConverterException::~ TXBMConverterException ;
 | virtual ~ TXBMConverterException ()  
> 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: TXBMConverterException::GetDescription ;
 | virtual void GetDescription (TText &)  
> Interface Category:
 | Sample.  
> Purpose:
 | Places the textual description of the error condition into the provided TText argument.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = TText & -The text object to fill with the error condition.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TXBMConverterException::GetErrorCode ;
 | ErrorCode GetErrorCode () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the error code used in the construction of this exception.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the error code used in the construction of this exception.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TXBMConverterException::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: TXBMConverterException::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: TXBMConverterException::Throw ;
 | virtual void Throw () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Polymorphically throws a TXBMConverterException.  
> Calling Context:
 | Called by the runtime.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws TXBMConverterException.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Class:
 | TXBMConverter  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Inherits From:
 | None. 
> Inherited By:
 | None. 
> Purpose:
 | TXBMConverter represents an interface for converting between a stream containing an X-Bitmap file and an TModifiableImage CommonPoint value.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | No special considerations.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TXBMConverter::TXBMConverter ;
 | TXBMConverter ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Default constructor.  
> Calling Context:
 | Called by the stream-in operators and users of this converter.  
> 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: TXBMConverter::CreateFrom ;
 | TModifiableImage * CreateFrom (TStream & XBMStream)  
> Interface Category:
 | Sample.  
> Purpose:
 | Does all of the actual work in converting a stream containing the sequence of bytes for an X-Bitmap file into a TModifiableImage object.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = TStream & XBMStream -The stream to convert from.  
> Return Value:
 | Returns the modifiable image resulting from converting the stream.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif