// $Revision: 1.5 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
----------------------------------------------------------------------
> Class:
 | TAxisDrawer  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Graphing Framework  
> Interface Category:
 | Sample.  
> Inherits From:
 | TGraphDrawer 
> Inherited By:
 | None. 
> Purpose:
 | This class draws a set of axes in a TStandardGraph. The axes default to black. The axes are drawn to be as long as TStandardGraph::GetAxisLengths.  
> Instantiation:
 | Always allocate on the heap because the whole point of this object is to be adopted by a TStandardGraph.  
> Deriving Classes:
 | None.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
----------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TAxisDrawer::TAxisDrawer ;
 | 1. TAxisDrawer ()  
 | 2. TAxisDrawer (GraphValue xAxisLocation)  
 | 3. TAxisDrawer (const TAxisDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Sets the x-axis to be drawn at a particular y-value.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators and by anyone who wants axes with the default settings.  
 | 2. Called if a client doesn't want the x-axis to be drawn from y-value zero.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. GraphValue xAxisLocation -The y-value that the x-axis will be drawn from.  
 = 3. const TAxisDrawer & source -The axis-drawer to be copied.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
----------------------------------------------------------------------
> Member Function: TAxisDrawer::~TAxisDrawer ;
 | virtual ~ TAxisDrawer ()  
> 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: TAxisDrawer::operator= ;
 | TAxisDrawer & operator =(const TAxisDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TAxisDrawer & source -The object that is being copied.  
> 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: TAxisDrawer::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: TAxisDrawer::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: TAxisDrawer::GetAxisColor ;
 | virtual const TRGBColor & GetAxisColor () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the color of the axes.  
> Calling Context:
 | Call this funtion directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | A const reference to the color of the axes.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
----------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TAxisDrawer::GetXAxisLocation ;
 | virtual GraphValue GetXAxisLocation () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the y-value that the x-axis draws from.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns, as a GraphValue, the y-value that the x-axis draws from.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
----------------------------------------------------------------------
> Member Function: TAxisDrawer::SetAxisColor ;
 | virtual void SetAxisColor (const TRGBColor & color)  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets the color of the axes.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = const TRGBColor & color -The color that the axes will be.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
----------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TAxisDrawer::SetXAxisLocation ;
 | virtual void SetXAxisLocation (GraphValue xAxisLocation)  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets the y-value that the x-axis will be drawn from.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = GraphValue xAxisLocation -The y-value that the x-axis will be drawn from.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
----------------------------------------------------------------------
> Member Function: TAxisDrawer::DrawIntoGraph ;
 | virtual void DrawIntoGraph (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Draws the axes into the grafport.  
> Calling Context:
 | Called only by TStandardGraph::Draw.  
> Parameters:
 = TGrafPort & port -The port to draw into. If the standard graph has been transformed, it will already be taken into account by this port.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
----------------------------------------------------------------------
#endif
#if 0
----------------------------------------------------------------------
> Member Function: TAxisDrawer::GetBounds ;
 | virtual TGRect GetBounds () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the bounds of the axes.  
> Calling Context:
 | Called whenever a client needs to know the bounds of the axes.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the bounds of the axes in a TGRect.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
----------------------------------------------------------------------
#endif