// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Struct:
 | _HTStream  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Purpose:
 | This structure is required by the LibWWW, which fills it with data by using a series of callback functions.  
 | This structure is implemented by storing a few CommonPoint objects that receive the data as it comes in.  
 | Its design is constrained by the requirements of this library, so it doesn't conform to many of the conventions of CommonPoint programming.  
 | Because it isn't a well-behaved CommonPoint class, its use is hidden from the majority of the WebRunner Sample. Interface to this class should be limited to the TURL::Follow member function.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HTStream::_HTStream ;
 | _HTStream (TStream * taligentStreamAlias, THypertextScrapItem * taligentTextAlias, TMIMEForeignDataType * mimeDataTypeAlias)  
> Interface Category:
 | Same as class.  
> Purpose:
 | Constructor.  
> Calling Context:
 | Only called internally by the LibWWW gateway.  
> Parameters:
 = TStream * taligentStreamAlias -The CommonPoint stream to place data into.  
 = THypertextScrapItem * taligentTextAlias -The WebRunner Sample scrap item to place hypertext information into.  
 = TMIMEForeignDataType * mimeDataTypeAlias -A pointer to the value that stores the MIME type of the incoming data.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HTStream::~ _HTStream ;
 | ~ _HTStream ()  
> Interface Category:
 | Same as class.  
> 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:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HTStream::GetTaligentStreamAlias ;
 | TStream * GetTaligentStreamAlias () const  
> Interface Category:
 | Same as class.  
> Purpose:
 | Gets access to the CommonPoint stream filled by this object.  
> Calling Context:
 | Called by the LibWWW interface functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a pointer to the stream that was used during the construction of this object.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HTStream::GetHypertextAlias ;
 | THypertextScrapItem * GetHypertextAlias () const  
> Interface Category:
 | Same as class.  
> Purpose:
 | Gets access to the CommonPoint hypertext scrap item filled by this object.  
> Calling Context:
 | Called by the LibWWW interface functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a pointer to the hypertext scrap item that was given during the construction of this object.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HTStream::GetMIMETypeAlias ;
 | TMIMEForeignDataType * GetMIMETypeAlias () const  
> Interface Category:
 | Same as class.  
> Purpose:
 | Gets access to the CommonPoint MIME type that this object is supposedly reading.  
> Calling Context:
 | Called by the LibWWW interface functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a pointer to the MIME foreign data type object that was used during the construction of this object.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Struct:
 | _HText  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Purpose:
 | This structure is required by the LibWWW, which fills it with data by using a series of callback functions.  
 | This structure is implemented by storing an alias to a CommonPoint hypertext scrap item that becomes the recipient of each of the LibWWW callbacks.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::_HText ;
 | _HText (THypertextScrapItem * taligentTextAlias, HTParentAnchor * anchor)  
> Interface Category:
 | Same as class.  
> Purpose:
 | Constructor.  
> Calling Context:
 | Only called internally by the LibWWW gateway.  
> Parameters:
 = THypertextScrapItem * taligentTextAlias -The WebRunner Sample scrap item to place hypertext information into.  
 = HTParentAnchor * anchor -A LibWWW value that is needed by the _HText functions.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::~ _HText ;
 | ~ _HText ()  
> Interface Category:
 | Same as class.  
> 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:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::AppendToCurrent ;
 | 1. void AppendToCurrent (const TText & text)  
 | 2. void AppendToCurrent (char)  
> Interface Category:
 | Same as class.  
> Purpose:
 | 1. Appends a block of text to the current hypertext scrap item.  
 | 2. Appends one ASCII character to the end of the current scrap item.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = 1. const TText & text -The text to append.  
 = 2. char -The character to append.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::AppendLineBreakToCurrent ;
 | void AppendLineBreakToCurrent ()  
> Interface Category:
 | Same as class.  
> Purpose:
 | Appends a linebreak character to the current hypertext scrap item.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::AppendImage ;
 | void AppendImage (const TURL & imageURL)  
> Interface Category:
 | Same as class.  
> Purpose:
 | Tells the hypertext to retrieve the image pointed to by the argument URL and append it to the hypertext scrap item. This uses the library to fetch the information and translate the data into an MGraphic, and then apply it to a character as an graphic text style. The resulting styled character is appended to the text block.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = const TURL & imageURL -The URL pointing to the desired image.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::AddStyleToCurrentText ;
 | void AddStyleToCurrentText (const TStyle & style)  
> Interface Category:
 | Same as class.  
> Purpose:
 | Takes a LibWWW style and applies it to the current piece of text being constructed for insertion into the hypertext scrap item.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = const TStyle & style -The LibWWW style to use.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::ApplyCurrentText ;
 | void ApplyCurrentText ()  
> Interface Category:
 | Same as class.  
> Purpose:
 | Takes the current piece of text that is being manipulated by the LibWWW callback functions and appends it to the hypertext scrap item that was used in the construction of this _HText object.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::BeginAnchor ;
 | void BeginAnchor (const TURL & destination)  
> Interface Category:
 | Same as class.  
> Purpose:
 | Indicates the beginning of a hypertext link with the URL given as an argument. The _HText object continues to accept text for the anchor until it hits the _HText::EndAnchor member function, which causes it to close off the link and add it to the links stored in the hypertext scrap item used in the construction of this object.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = const TURL & destination -The destination (or address) of this link.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::EndAnchor ;
 | void EndAnchor ()  
> Interface Category:
 | Same as class.  
> Purpose:
 | Signals the end of the creation of a hypertext link that was started with _HText::BeginAnchor.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: _HText::EndAppend ;
 | void EndAppend ()  
> Interface Category:
 | Same as class.  
> Purpose:
 | Signals that all data on this hypertext page has been read and that the hypertext scrap item can be completed.  
> Calling Context:
 | Called by the LibWWW callback functions.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | Same as class.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Global Function: AddTaligentConversions ;
 | void AddTaligentConversions (HTList * conversionList)  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Purpose:
 | Adds accepted CommonPoint MIME types to the recognized conversion list.  
> Calling Context:
 | Used by the LibWWW gateway to put together a type list that LibWWW will recognize and use to return data in the desired manner.  
> Parameters:
 = HTList * conversionList -The LibWWW list of acceptable conversions.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif