// Copyright (C) 1995 Taligent, Inc. All rights reserved. #if 0 --------------------------------------------------------------------------- > Class: | TWebView > Taxonomy Category: | Documented Samples | WebRunner Sample > Interface Category: | Sample. > Inherits From: | TDocumentComponentView > Inherited By: | None. > Purpose: | The primary view for the default presentation on the WebRunner Sample document. This view displays the hypertext in a scrolling text view below a TLabelView displaying the title of the document. This view coordinates the three subviews (the title view, the text view, and the scrolling view) and updates them when needed. > Instantiation: | Allocate on the heap or the stack. > Deriving Classes: | Deriving classes must maintain communication with the model through HandleModelChanged and continue to update the subviews when needed. > Concurrency: | _Not_ multithread safe. > Resource Use: | No special requirements. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TWebView::TWebView ; | 1. TWebView (TGUIBundle * bundleToAlias) | 2. TWebView () | 3. TWebView (const TWebView & source) > Interface Category: | Sample. > Purpose: | 1. Constructs the web view using a Presentation framework state bundle. | 2. Default constructor. | 3. Copy constructor. > Calling Context: | 1. Called by the Presentation framework in creating the component. | 2. Called by the stream-in operators. | 3. Called to copy an object. > Parameters: = 1. TGUIBundle * bundleToAlias -The Presentation framework state. = 2. Takes no parameters. = 3. const TWebView & 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: TWebView::~ TWebView ; | virtual ~ TWebView () > 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: TWebView::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: TWebView::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 no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TWebView::AdoptHypertextView ; | virtual void AdoptHypertextView (TView * view) > Interface Category: | Sample. > Purpose: | Adopts the hypertext view that is to display the text information below the title of the document. > Calling Context: | Called by the creator of the view to give it the proper subview. > Parameters: = TView * view -The subview to adopt. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TWebView::HandleAllocatedAreaChanged ; | virtual void HandleAllocatedAreaChanged (const TGArea & newArea) > Interface Category: | Sample. > Purpose: | Calculates the proper positions of this view's subviews and commands them to resize to the proper dimensions. > Calling Context: | Called by the View system whenever this view must change its area. > Parameters: = const TGArea & newArea -The area this view now occupies. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TWebView::HandleAfterConnectionToViewRoot ; | virtual void HandleAfterConnectionToViewRoot () > Interface Category: | Sample. > Purpose: | The initialization function for this view. Creates the title subview if none exists. > Calling Context: | Called by the View system the first time this view is added to the view hierarchy. > 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: TWebView::HandleModelChanged ; | virtual void HandleModelChanged (const TNotification & change) > Interface Category: | Sample. > Purpose: | This function is provided on TDocumentComponentView and is called whenever this component's model sends out a notification of a change. It provides a convenient hook for model-view notification without elaborate setup. TWebView uses this function to force a redraw of all subviews whenever the model changes. > Calling Context: | Called by the Presentation framework whenever the model calls NotifyOfChange. > Parameters: = const TNotification & change -The notification used by the model. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif #if 0 --------------------------------------------------------------------------- > Member Function: TWebView::CreateTitleView ; | virtual void CreateTitleView () > Interface Category: | Sample. > Purpose: | Creates the label view that displays the title of this web page. After it is created, it is placed in the correct place in the view. > Calling Context: | Called internally when the subviews of this view are constructed. > 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: TWebView::PlaceLabelView ; | virtual void PlaceLabelView (const TGArea & mainViewArea) > Interface Category: | Sample. > Purpose: | Places the title of this web page into the correct place in the view. > Calling Context: | Called internally by the TWebView whenever the size of the view changes or a new title view is created. > Parameters: = const TGArea & mainViewArea -The area of the main view that the title view must fit within. > Return Value: | None. > Exceptions: | Throws no exceptions, passes all exceptions through. > Concurrency: | _Not_ multithread safe. > Other Considerations: | None. --------------------------------------------------------------------------- #endif