// $Revision: 1.8 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TPickerView  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Picker  
> Interface Category:
 | Sample.  
> Inherits From:
 | TDOMDocumentComponentView 
> Inherited By:
 | None. 
> Purpose:
 | Displays the names of the stocks contained in the model.  
> Instantiation:
 | Always allocate on the heap.  
> Deriving Classes:
 | No special instructions.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::TPickerView ;
 | 1. TPickerView ()  
 | 2. TPickerView (TGUIBundle * guiBundleToAlias, const TPaint & backgroundColor =TColorPaint :: GetWhite ())  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Constructor.  
> Calling Context:
 | 1. Called by derived classes and to construct an object.  
 | 2. Called to construct a valid object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. TGUIBundle * guiBundleToAlias -A pointer to the bundle object needed by many Presentation framework objects.  
 = 2. const TPaint & backgroundColor =TColorPaint :: GetWhite () -The color to paint the background of this view.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::~ TPickerView ;
 | virtual ~ TPickerView ()  
> 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: TPickerView::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: TPickerView::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: TPickerView::DrawContents ;
 | virtual void DrawContents (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Draws the contents of the view.  
> Calling Context:
 | Called by the View system.  
> Parameters:
 = TGrafPort & port -The grafport object to draw into.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::HandleAfterConnectionToViewRoot ;
 | virtual void HandleAfterConnectionToViewRoot ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets the initial state of the view.  
> Calling Context:
 | Called by the View system.  
> 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: TPickerView::HandleModelChanged ;
 | virtual void HandleModelChanged (const TNotification & notification)  
> Interface Category:
 | Sample.  
> Purpose:
 | Updates the view's internal cache of items to display.  
> Calling Context:
 | Called by the Presentation framework in response to a notification from the model that the model changed.  
> Parameters:
 = const TNotification & notification -The notification object sent 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: TPickerView::GetSelectionDisplayArea ;
 | virtual TGArea GetSelectionDisplayArea (const TModelSelection & selection) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the physical area of the view specified by the given selection.  
> Calling Context:
 | Called by the Taligent Selection Tool.  
> Parameters:
 = const TModelSelection & selection -The selection to derive the area from.  
> Return Value:
 | The area taken up by the selection.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::CreateInsertionPoint ;
 | virtual TModelSelection * CreateInsertionPoint (const TGPoint & where) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates an empty selection for inserting new data into a Stock Picker.  
> Calling Context:
 | Called by the Taligent Selection Tool.  
> Parameters:
 = const TGPoint & where -The point where insertion will take place.  
> Return Value:
 | An empty model selection to use when inserting data at the given point.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::CreateSelectionFromPoint ;
 | virtual TModelSelection * CreateSelectionFromPoint (const TGPoint & where) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates a model selection specifying the data being displayed at the given point.  
> Calling Context:
 | Called by the Taligent Selection Tool.  
> Parameters:
 = const TGPoint & where -A point inside the data to make a selection for.  
> Return Value:
 | A pointer to a new model selection.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::CreateSelectionFromArea ;
 | virtual TModelSelection * CreateSelectionFromArea (const TGArea & area) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates a model selection specifying the data being displayed in the given area.  
> Calling Context:
 | Called by the Taligent Selection Tool.  
> Parameters:
 = const TGArea & area -The area to make a selection for.  
> Return Value:
 | A pointer to a new model selection.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::GetDisplaysHit ;
 | bool GetDisplaysHit (const TGArea & hitRect, TCollectionOf < TTextDisplay > & fill) const 
> Interface Category:
 | Sample.  
> Purpose:
 | This is an obsolete function. 
> Calling Context:
 | Not called. 
> Parameters:
 = const TGArea & hitRect -Ignored. 
 = TCollectionOf < TTextDisplay > & fill -Ignored. 
> Return Value:
 | This obsolete function produces an assertion failure if called. 
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None. 
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TPickerView::CacheDisplaysAndUpdate ;
 | void CacheDisplaysAndUpdate ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Updates this object's internal collection of TTextDisplay objects. 
> Calling Context:
 | Called by this class. 
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, catches TCompoundDocumentException and passes all other exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None. 
---------------------------------------------------------------------------
#endif