// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TWebLinkView  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Inherits From:
 | TTextControl, MGUIBundle 
> Inherited By:
 | None. 
> Purpose:
 | This view is used to display a web link document component. Its two main responsibilities are: creating and displaying the text and handling user mouse clicks, which cause new web documents to be opened.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | This class currently descends from TTextControl to provide a way to display a label in an activatable view. In the future, this will be switched to TLabelView because text entry has nothing to do with this class.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLinkView::TWebLinkView ;
 | 1. TWebLinkView ()  
 | 2. TWebLinkView (TGUIBundle * bundleToAlias)  
 | 3. TWebLinkView (const TWebLinkView & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Presentation framework constructor.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators.  
 | 2. Called by the Presentation framework.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. TGUIBundle * bundleToAlias -The component's presentation state.  
 = 3. const TWebLinkView & source -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: TWebLinkView::~ TWebLinkView ;
 | virtual ~ TWebLinkView ()  
> 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: TWebLinkView::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: TWebLinkView::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: TWebLinkView::MouseDown ;
 | virtual bool MouseDown (TMouseDownEvent & mouseDown)  
> Interface Category:
 | Sample.  
> Purpose:
 | When the View system informs this view of a mouse-down event, it reacts by either opening a new document on the desktop or by commanding the currently embedding TWebModel to display a different page of information. A discussion of this is documented in the _Interesting_ _Mechanisms_ section of the WebRunner Sample chapter in the Documented Samples book.  
> Calling Context:
 | Called by the Input system.  
> Parameters:
 = TMouseDownEvent & mouseDown -The event that caused this action.  
> Return Value:
 | Returns true because this view handles every mouse down it receives.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLinkView::CreateCurrentLabel ;
 | TLabel * CreateCurrentLabel (const TTextColorStyle & linkTextColor =TTextColorStyle :: GetRed ()) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates the label that should be displayed in this view. The label includes the text of the WebLink along with the appropriate glyph to indicate the link status. All of this is styled by the color passed in as an argument.  
> Calling Context:
 | Called internally.  
> Parameters:
 = const TTextColorStyle & linkTextColor =TTextColorStyle :: GetRed () -The color style to apply to the text before creating a link out of it.  
> Return Value:
 | Returns the created link label.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLinkView::AdoptLabel ;
 | void AdoptLabel (TLabel * label)  
> Interface Category:
 | Sample.  
> Purpose:
 | Adopts the provided label into this view and scales the view to the size of the label.  
> Calling Context:
 | Called internally.  
> Parameters:
 = TLabel * label -The label to display.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TWebLinkView::ActivateFeedback ;
 | virtual void ActivateFeedback ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Changes the appearance of the label to indicate that the link has been activated and that it is currently constructing the new information to display.  
> Calling Context:
 | Called internally when a mouse down happens on this link.  
> 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: TWebLinkView::DeactivateFeedback ;
 | virtual void DeactivateFeedback ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Changes the appearance of the label to indicate that the link is no longer activated.  
> Calling Context:
 | Called internally when a mouse-down handling has finished.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif