// $Revision: 1.5 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TTitleDrawer  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Graphing Framework  
> Interface Category:
 | Sample.  
> Inherits From:
 | TGraphDrawer 
> Inherited By:
 | None. 
> Purpose:
 | Draws an axis title aligned with either the x- or y-axis.  
> 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
---------------------------------------------------------------------------
> Enumeration:
 | TTitleDrawer :: ETitleType  
> Taxonomy Category:
 | Documented Samples.  
> Interface Category:
 | Sample.  
> Purpose:
 | Identifies the alignment of this drawer.  
> Tags:
 = kInvalidType -Used internally.  
 = kXAxisTitle -Aligns the title with the x-axis.  
 = kYAxisTitle -Aligns the title with the y-axis.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TTitleDrawer::TTitleDrawer ;
 | 1. TTitleDrawer (ETitleType xOrYAxisTitle, const GCoordinate & distanceFromAxis, const TStandardText & titleText, const TFontPointSizeStyle & fontSize =TFontPointSizeStyle :: GetDefaultFontPointSizeStyle (), const TFontFamilyStyle & font =TFontFamilyStyle :: GetDefaultFontFamilyStyle ())  
 | 2. TTitleDrawer (const TTitleDrawer & source)  
 | 3. TTitleDrawer ()  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Constructor.  
 | 2. Copy constructor.  
 | 3. Default constructor.  
> Calling Context:
 | 1. Called to construct a valid object.  
 | 2. Called to copy an object.  
 | 3. Called by derived classes and to construct an object.  
> Parameters:
 = 1. ETitleType xOrYAxisTitle -A value indicating how to align the title.  
 = 1. const GCoordinate & distanceFromAxis -How far away from the axis to draw the title.  
 = 1. const TStandardText & titleText -The title text to draw.  
 = 1. const TFontPointSizeStyle & fontSize =TFontPointSizeStyle :: GetDefaultFontPointSizeStyle () -The font size.  
 = 1. const TFontFamilyStyle & font =TFontFamilyStyle :: GetDefaultFontFamilyStyle () -The font.  
 = 2. const TTitleDrawer & source -The object to copy.  
 = 3. 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: TTitleDrawer::~ TTitleDrawer ;
 | virtual ~ TTitleDrawer ()  
> 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: TTitleDrawer::operator =;
 | TTitleDrawer & operator =(const TTitleDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TTitleDrawer & source -The object to copy.  
> 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: TTitleDrawer::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: TTitleDrawer::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: TTitleDrawer::Prepare ;
 | virtual void Prepare (const TStandardGraph & theGraph)  
> Interface Category:
 | Sample.  
> Purpose:
 | Prepares this object for eventual drawing. Sets the origin of the title text.  
> Calling Context:
 | Called by the Graphing framework.  
> Parameters:
 = const TStandardGraph & theGraph -The graph this object will eventually 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: TTitleDrawer::DrawIntoGraph ;
 | virtual void DrawIntoGraph (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Draws the title.  
> Calling Context:
 | Called by the Graphing framework.  
> Parameters:
 = TGrafPort & port -The port 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: TTitleDrawer::GetBounds ;
 | virtual TGRect GetBounds () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the boundary rectangle of the text drawn by this object.  
> Calling Context:
 | Called by the Graphing framework and directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | The object's bounds.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif