Gridlines Class Reference
Provides a grid from which all other plot objects can be referenced. More...
#include <Gridlines.h>
Public Member Functions | |
| virtual void | enableMinorGridlines (bool bEnable)=0 |
| virtual bool | areMinorGridlinesEnabled () const =0 |
| virtual void | setColor (const ColorType &lineColor)=0 |
| virtual ColorType | getColor () const =0 |
| virtual void | setLineWidth (int lineWidth)=0 |
| virtual int | getLineWidth () const =0 |
| virtual void | setLineStyle (LineStyle lineStyle)=0 |
| virtual LineStyle | getLineStyle () const =0 |
| virtual void | setMaxNumMajorLines (int numLines)=0 |
| virtual void | setMaxNumMinorLines (int numLines)=0 |
| virtual int | getMaxNumMajorLines () const =0 |
| virtual int | getMaxNumMinorLines () const =0 |
Protected Member Functions | |
| virtual | ~Gridlines () |
Detailed Description
Provides a grid from which all other plot objects can be referenced.The gridlines object is provided automatically by a plot view and is created as a secondary plot object. As a secondary object, the gridlines object does not have extents, so the getExtents() method will return false.
A gridlines object consists of major and minor gridlines. The major gridlines are always displayed, and the display of the minor gridlines can be toggled on and off with enableMinorGridlines().
This subclass of Subject will notify upon the following conditions:
- The following methods are called: enableMinorGridlines(), setColor(), setLineWidth(), setLineStyle(), setMaxNumMajorLines(), and setMaxNumMinorLines().
- Everything else documented in PlotObject.
- See also:
- PlotObject
Definition at line 37 of file Gridlines.h.
Constructor & Destructor Documentation
| virtual Gridlines::~Gridlines | ( | ) | [protected, virtual] |
A plug-in cannot create this object, it can only retrieve an already existing object from a plot view.
The plot view manages any instances of this object.
Definition at line 181 of file Gridlines.h.
Member Function Documentation
| virtual void Gridlines::enableMinorGridlines | ( | bool | bEnable | ) | [pure virtual] |
Toggles the display of the minor gridlines.
- Parameters:
-
bEnable Set this value to true to display the minor gridlines, or to false to hide the minor gridlines.
- Subject Notifications:
- This method notifies Subject::signalModified() since the number of gridlines displayed changes.
| virtual bool Gridlines::areMinorGridlinesEnabled | ( | ) | const [pure virtual] |
Queries whether minor gridlines are displayed.
- Returns:
- Returns true if the minor gridlines are displayed, or false if the minor gridlines are hidden.
| virtual void Gridlines::setColor | ( | const ColorType & | lineColor | ) | [pure virtual] |
Sets the color of the gridlines.
- Parameters:
-
lineColor The gridline color.
- Subject Notifications:
- This method notifies Subject::signalModified() if the given color is different than the current color, and the given color is valid.
- See also:
- ColorType::isValid()
| virtual ColorType Gridlines::getColor | ( | ) | const [pure virtual] |
Returns the gridline color.
- Returns:
- The gridline color.
| virtual void Gridlines::setLineWidth | ( | int | lineWidth | ) | [pure virtual] |
Sets the line width of the gridlines.
- Parameters:
-
lineWidth The gridline width.
- Subject Notifications:
- This method notifies Subject::signalModified() if the given line width is different than the current line width, and the given line width is greater than zero.
| virtual int Gridlines::getLineWidth | ( | ) | const [pure virtual] |
Returns the gridline width.
- Returns:
- The gridline width.
| virtual void Gridlines::setLineStyle | ( | LineStyle | lineStyle | ) | [pure virtual] |
Sets the line style of the gridlines.
- Parameters:
-
lineStyle The gridline style.
- Subject Notifications:
- This method notifies Subject::signalModified() if the given line style is different than the current line style.
| virtual LineStyle Gridlines::getLineStyle | ( | ) | const [pure virtual] |
Returns the gridline style.
- Returns:
- The gridline style.
| virtual void Gridlines::setMaxNumMajorLines | ( | int | numLines | ) | [pure virtual] |
Sets the maximum number of major gridlines.
This method sets the maximum number of major gridlines to display in the plot view. Calling this method recalculates the overall locations of the gridlines.
- Parameters:
-
numLines The new maximum number of major gridlines.
- Subject Notifications:
- This method notifies Subject::signalModified() if the given maximum number of major gridlines is different than the current maximum number.
- See also:
- setMaxNumMinorLines()
| virtual void Gridlines::setMaxNumMinorLines | ( | int | numLines | ) | [pure virtual] |
Sets the maximum number of minor gridlines.
This method sets the maximum number of minor gridlines to display between each major gridline in the plot view. Calling this method recalculates the overall locations of the gridlines.
- Parameters:
-
numLines The new maximum number of minor gridlines.
- Subject Notifications:
- This method notifies Subject::signalModified() if the given maximum number of minor gridlines is different than the current maximum number.
- See also:
- setMaxNumMajorLines()
| virtual int Gridlines::getMaxNumMajorLines | ( | ) | const [pure virtual] |
Returns the maximum number of major gridlines.
This method returns the maximum number of major gridlines that are displayed in the plot view. The default value is ten.
- Returns:
- The maximum value of major gridlines.
| virtual int Gridlines::getMaxNumMinorLines | ( | ) | const [pure virtual] |
Returns the maximum number of minor gridlines.
This method returns the maximum number of minor gridlines that are displayed between each major gridline in the plot view. The default value is four.
- Returns:
- The maximum value of minor gridlines.