// $Revision: 1.6 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TMarkDrawer  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Graphing Framework  
> Interface Category:
 | Sample.  
> Inherits From:
 | TGraphDrawer 
> Inherited By:
 | TXMarkDrawer 
 | TYMarkDrawer 
> Purpose:
 | Holds all of the pertinent data about drawing marks except for exact location; that is up to the derived class.  
> Instantiation:
 | Always allocate on the heap.  
> Deriving Classes:
 | Deriving classes have to override Draw, GetGeometricBounds, and GetLooseFitBounds.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::~ TMarkDrawer ;
 | virtual ~ TMarkDrawer ()  
> 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: TMarkDrawer::operator =;
 | TMarkDrawer & operator =(const TMarkDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TMarkDrawer & source -The object 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: TMarkDrawer::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: TMarkDrawer::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: TMarkDrawer::GetMarkColor ;
 | virtual const TRGBColor & GetMarkColor () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Gets the color of the marks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a const reference to a TRGBColor.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::GetMarkLength ;
 | virtual GraphValue GetMarkLength () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Gets the length, in points, of the marks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the length of the marks in points.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::GetMarkInterval ;
 | virtual GraphValue GetMarkInterval () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Gets the interval between the marks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the interval between the marks.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::SetMarkColor ;
 | virtual void SetMarkColor (const TRGBColor & color)  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets the color of the marks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = const TRGBColor & color -The new color of the marks.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::SetMarkLength ;
 | virtual void SetMarkLength (GraphValue length)  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets the length, in points, of the marks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = GraphValue length -The new length of the marks.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::SetMarkInterval ;
 | virtual void SetMarkInterval (GraphValue interval)  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets the interval between the marks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = GraphValue interval -The new interval between marks.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::DrawIntoGraph ;
 | virtual void DrawIntoGraph (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | This pure virtual function is only here to show clients that they have to override it.  
> Calling Context:
 | Called only by TStandardGraph::Draw.  
> Parameters:
 = TGrafPort & port -The port that the marks will be drawn into.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMarkDrawer::TMarkDrawer ;
 | 1. TMarkDrawer ()  
 | 2. TMarkDrawer (GraphValue markLength, GraphValue markInterval, const TPaint & markColor =TColorPaint :: GetBlack ())  
 | 3. TMarkDrawer (const TMarkDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Properly initializes the drawer.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators. This shouldn't be called by most clients.  
 | 2. Called by most clients.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. GraphValue markLength -The length of the marks in points.  
 = 2. GraphValue markInterval -The interval between the marks.  
 = 2. const TPaint & markColor -The color of the marks.  
 = 3. const TMarkDrawer & source -The object to be copied.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Class:
 | TXMarkDrawer  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Graphing Framework  
> Interface Category:
 | Sample.  
> Inherits From:
 | TMarkDrawer 
> Inherited By:
 | None. 
> Purpose:
 | This class derives from TMarkDrawer. It draws marks along the x-axis.  
> Instantiation:
 | Always allocate on the heap.  
> Deriving Classes:
 | None.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TXMarkDrawer::TXMarkDrawer ;
 | 1. TXMarkDrawer ()  
 | 2. TXMarkDrawer (GraphValue markLength, GraphValue markInterval)  
 | 3. TXMarkDrawer (const TXMarkDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Properly initializes the drawer.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators.  
 | 2. Called by most clients.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. GraphValue markLength -The length of the marks in points.  
 = 2. GraphValue markInterval -The interval between marks.  
 = 3. const TXMarkDrawer & source -The object 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: TXMarkDrawer::~ TXMarkDrawer ;
 | virtual ~ TXMarkDrawer ()  
> 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: TXMarkDrawer::operator =;
 | TXMarkDrawer & operator =(const TXMarkDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TXMarkDrawer & source -The object to be 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: TXMarkDrawer::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: TXMarkDrawer::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: TXMarkDrawer::DrawIntoGraph ;
 | virtual void DrawIntoGraph (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | TDraws to the port.  
> Calling Context:
 | Called by TStandardGraph::Draw. It should not be called by other clients.  
> Parameters:
 = TGrafPort & port -The port that the graph has handed this 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: TXMarkDrawer::GetBounds ;
 | virtual TGRect GetBounds () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Gets the bounds of the area that this drawer draws to.  
> Calling Context:
 | Called mainly by TStandardGraph::GetGeometricBounds.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a rectangle that encompasses all of the drawing that was done by the Draw member function.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Class:
 | TYMarkDrawer  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Graphing Framework  
> Interface Category:
 | Sample.  
> Inherits From:
 | TMarkDrawer 
> Inherited By:
 | None. 
> Purpose:
 | This class derives from TMarkDrawer. It draws marks along the x-axis.  
> Instantiation:
 | Always allocate on the heap.  
> Deriving Classes:
 | None.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TYMarkDrawer::TYMarkDrawer ;
 | 1. TYMarkDrawer ()  
 | 2. TYMarkDrawer (GraphValue markLength, GraphValue markInterval)  
 | 3. TYMarkDrawer (const TYMarkDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Properly initializes the drawer.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators.  
 | 2. Called by most clients.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. GraphValue markLength -The length of the marks in points.  
 = 2. GraphValue markInterval -The interval between the marks.  
 = 3. const TYMarkDrawer & source -The object that is being copied.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TYMarkDrawer::~ TYMarkDrawer ;
 | virtual ~ TYMarkDrawer ()  
> 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: TYMarkDrawer::operator =;
 | TYMarkDrawer & operator =(const TYMarkDrawer & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TYMarkDrawer & source -The object to be 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: TYMarkDrawer::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: TYMarkDrawer::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: TYMarkDrawer::DrawIntoGraph ;
 | virtual void DrawIntoGraph (TGrafPort & port) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Draws to the port. It draws a line of the proper length, the proper color, and at the proper interval.  
> Calling Context:
 | Called only by TStandardGraph::Draw.  
> Parameters:
 = TGrafPort & port -The port in which all of the drawing is happening.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TYMarkDrawer::GetBounds ;
 | virtual TGRect GetBounds () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Gets the bounds of all of the marks drawn.  
> Calling Context:
 | Called mailny by TStandardGraph::GetGeometricBounds.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the bounds of all the marks.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif