// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TWebLink  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Inherits From:
 | MCollectible 
> Inherited By:
 | None. 
> Purpose:
 | A web link object stores all of the persistent information needed to represent a hypertextual World Wide Web link. This includes the text that is displayed by the link, the Uniform Resource Locator that indicates the destination of the link, and the context-sensitive state information that indicates where a link is embedded.  
> 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: TWebLink::CreateWebLinkComponent ;
 | static TDocumentComponent * CreateWebLinkComponent (const TURL & destinationURL, const TStandardText & text, const TModelReference & parent)  
> Interface Category:
 | Sample.  
> Purpose:
 | This static member function can be used to create a hypertext link document component.  
> Calling Context:
 | Called by any client that needs a link component.  
> Parameters:
 = const TURL & destinationURL -The destination of the link.  
 = const TStandardText & text -The text to display in the link's view.  
 = const TModelReference & parent -This should either be a reference to the TWebModel that is embedding the component or an invalid reference.  
> Return Value:
 | Returns the newly created document component.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLink::TWebLink ;
 | 1. TWebLink ()  
 | 2. TWebLink (const TWebLink & source)  
 | 3. TWebLink (const TURL & destinationURL, const TStandardText & text, const TModelReference & parentDocument)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Copy constructor.  
 | 3. Creates a link out of its constituent pieces.  
> Calling Context:
 | 1. Called by the stream-in operators.  
 | 2. Called to copy an object.  
 | 3. Called by clients of this class.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. const TWebLink & source -The object to copy.  
 = 3. const TURL & destinationURL -The destination of the link.  
 = 3. const TStandardText & text -The text to display in the link's view.  
 = 3. const TModelReference & parentDocument -This should either be a reference to the TWebModel that is embedding the component or an invalid reference.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLink::~ TWebLink ;
 | virtual ~ TWebLink ()  
> 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: TWebLink::operator =;
 | TWebLink & operator =(const TWebLink & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TWebLink & source -The object to assign.  
> 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: TWebLink::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: TWebLink::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: TWebLink::GetDisplayedText ;
 | virtual TStandardText GetDisplayedText () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Retrieves the styled text that is used to display this link.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the text that is used to display this link.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLink::OpenWebDocument ;
 | virtual void OpenWebDocument ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Opens this link's URL as a new document on the desktop.  
> Calling Context:
 | Call this function directly.  
> 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: TWebLink::GetViewerModelReference ;
 | virtual TModelReference GetViewerModelReference () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Retrieves the model reference that either refers to the TWebModel that is embedding this component or no model. (For example, it is invalid so it returns false to the IsValid member function.)  
> Calling Context:
 | Called by the TWebLinkView to gain access to the embedding model.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the model reference.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLink::GetDestination ;
 | virtual TURL GetDestination () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the Uniform Resource Locator that indicates the address of the information to display when this link is activated.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the destination URL for this link.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif