Biomedical Image Analysis Library
The Biomedical Image Analysis Library is a poweful tool for developers, physicians, researchers, engineers, and so on.
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
QCPGrid Class Reference

Responsible for drawing the grid of a QCPAxis. More...

#include <qcustomplot.h>

Inheritance diagram for QCPGrid:
Inheritance graph
Collaboration diagram for QCPGrid:
Collaboration graph

Public Member Functions

 QCPGrid (QCPAxis *parentAxis)
 
bool subGridVisible () const
 
bool antialiasedSubGrid () const
 
bool antialiasedZeroLine () const
 
QPen pen () const
 
QPen subGridPen () const
 
QPen zeroLinePen () const
 
void setSubGridVisible (bool visible)
 
void setAntialiasedSubGrid (bool enabled)
 
void setAntialiasedZeroLine (bool enabled)
 
void setPen (const QPen &pen)
 
void setSubGridPen (const QPen &pen)
 
void setZeroLinePen (const QPen &pen)
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlot * parentPlot () const
 
QCPLayerable * parentLayerable () const
 
QCPLayer * layer () const
 
bool antialiased () const
 
void setVisible (bool on)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setAntialiased (bool enabled)
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 
bool realVisibility () const
 

Protected Member Functions

virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual void draw (QCPPainter *painter)
 
void drawGridLines (QCPPainter *painter) const
 
void drawSubGridLines (QCPPainter *painter) const
 
- Protected Member Functions inherited from QCPLayerable
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 

Protected Attributes

bool mSubGridVisible
 
bool mAntialiasedSubGrid
 
bool mAntialiasedZeroLine
 
QPen mPen
 
QPen mSubGridPen
 
QPen mZeroLinePen
 
QCPAxis * mParentAxis
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlot * mParentPlot
 
QPointer< QCPLayerable > mParentLayerable
 
QCPLayer * mLayer
 
bool mAntialiased
 

Friends

class QCPAxis
 

Additional Inherited Members

- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 

Detailed Description

Responsible for drawing the grid of a QCPAxis.

This class is tightly bound to QCPAxis. Every axis owns a grid instance and uses it to draw the grid lines, sub grid lines and zero-line. You can interact with the grid of an axis via QCPAxis::grid. Normally, you don't need to create an instance of QCPGrid yourself.

The axis and grid drawing was split into two classes to allow them to be placed on different layers (both QCPAxis and QCPGrid inherit from QCPLayerable). Thus it is possible to have the grid in the background and the axes in the foreground, and any plottables/items in between. This described situation is the default setup, see the QCPLayer documentation.

Definition at line 930 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPGrid::QCPGrid ( QCPAxis *  parentAxis)

Creates a QCPGrid instance and sets default values.

You shouldn't instantiate grids on their own, since every QCPAxis brings its own QCPGrid.

Definition at line 3679 of file qcustomplot.cpp.

Member Function Documentation

bool QCPGrid::antialiasedSubGrid ( ) const
inline

Definition at line 946 of file qcustomplot.h.

bool QCPGrid::antialiasedZeroLine ( ) const
inline

Definition at line 947 of file qcustomplot.h.

void QCPGrid::applyDefaultAntialiasingHint ( QCPPainter *  painter) const
protectedvirtual

Implements QCPLayerable.

Definition at line 3760 of file qcustomplot.cpp.

void QCPGrid::draw ( QCPPainter *  painter)
protectedvirtual

Implements QCPLayerable.

Definition at line 3770 of file qcustomplot.cpp.

void QCPGrid::drawGridLines ( QCPPainter *  painter) const
protected

Definition at line 3785 of file qcustomplot.cpp.

void QCPGrid::drawSubGridLines ( QCPPainter *  painter) const
protected

Definition at line 3859 of file qcustomplot.cpp.

QPen QCPGrid::pen ( ) const
inline

Definition at line 948 of file qcustomplot.h.

void QCPGrid::setAntialiasedSubGrid ( bool  enabled)

Sets whether sub grid lines are drawn antialiased.

Definition at line 3707 of file qcustomplot.cpp.

void QCPGrid::setAntialiasedZeroLine ( bool  enabled)

Sets whether zero lines are drawn antialiased.

Definition at line 3715 of file qcustomplot.cpp.

void QCPGrid::setPen ( const QPen &  pen)

Sets the pen with which (major) grid lines are drawn.

Definition at line 3723 of file qcustomplot.cpp.

void QCPGrid::setSubGridPen ( const QPen &  pen)

Sets the pen with which sub grid lines are drawn.

Definition at line 3731 of file qcustomplot.cpp.

void QCPGrid::setSubGridVisible ( bool  visible)

Sets whether grid lines at sub tick marks are drawn.

See also
setSubGridPen

Definition at line 3699 of file qcustomplot.cpp.

void QCPGrid::setZeroLinePen ( const QPen &  pen)

Sets the pen with which zero lines are drawn.

Zero lines are lines at value coordinate 0 which may be drawn with a different pen than other grid lines. To disable zero lines and just draw normal grid lines at zero, set pen to Qt::NoPen.

Definition at line 3742 of file qcustomplot.cpp.

QPen QCPGrid::subGridPen ( ) const
inline

Definition at line 949 of file qcustomplot.h.

bool QCPGrid::subGridVisible ( ) const
inline

Definition at line 945 of file qcustomplot.h.

QPen QCPGrid::zeroLinePen ( ) const
inline

Definition at line 950 of file qcustomplot.h.

Friends And Related Function Documentation

friend class QCPAxis
friend

Definition at line 976 of file qcustomplot.h.

Member Data Documentation

bool QCPGrid::mAntialiasedSubGrid
protected

Definition at line 963 of file qcustomplot.h.

bool QCPGrid::mAntialiasedZeroLine
protected

Definition at line 963 of file qcustomplot.h.

QCPAxis* QCPGrid::mParentAxis
protected

Definition at line 966 of file qcustomplot.h.

QPen QCPGrid::mPen
protected

Definition at line 964 of file qcustomplot.h.

QPen QCPGrid::mSubGridPen
protected

Definition at line 964 of file qcustomplot.h.

bool QCPGrid::mSubGridVisible
protected

Definition at line 962 of file qcustomplot.h.

QPen QCPGrid::mZeroLinePen
protected

Definition at line 964 of file qcustomplot.h.

The documentation for this class was generated from the following files: