KDChart::GridAttributes Class Reference

#include <KDChartGridAttributes.h>

List of all members.

---

Detailed Description

A set of attributes controlling the appearance of grids.

Definition at line 44 of file KDChartGridAttributes.h.

Public Member Functions
bool	adjustLowerBoundToGrid () const
bool	adjustUpperBoundToGrid () const
	GridAttributes (const GridAttributes &)
	GridAttributes ()
KDChartEnums::GranularitySequence	gridGranularitySequence () const
	Returns the granularity sequence to be used for calculating the grid lines.
QPen	gridPen () const
qreal	gridStepWidth () const
	Returns the step width to be used for calculating the grid lines.
qreal	gridSubStepWidth () const
	Returns the sub-step width to be used for calculating the sub-grid lines.
bool	isGridVisible () const
bool	isSubGridVisible () const
bool	operator!= (const GridAttributes &other) const
GridAttributes &	operator= (const GridAttributes &)
bool	operator== (const GridAttributes &) const
void	setAdjustBoundsToGrid (bool adjustLower, bool adjustUpper)
	By default visible bounds of the data area are adjusted to match a main grid line.
void	setGridGranularitySequence (KDChartEnums::GranularitySequence sequence)
	Specify which granularity sequence is to be used to find a matching grid granularity.
void	setGridPen (const QPen &pen)
void	setGridStepWidth (qreal stepWidth=0.0)
	Specifies the step width to be used for calculating the grid lines.
void	setGridSubStepWidth (qreal subStepWidth=0.0)
	Specifies the sub-step width to be used for calculating the grid sub-lines.
void	setGridVisible (bool visible)
void	setSubGridPen (const QPen &pen)
void	setSubGridVisible (bool visible)
void	setZeroLinePen (const QPen &pen)
QPen	subGridPen () const
QPen	zeroLinePen () const
	~GridAttributes ()

---

Constructor & Destructor Documentation

GridAttributes::GridAttributes

(

)

Definition at line 73 of file KDChartGridAttributes.cpp.

    : _d( new Private() )
{
    // this bloc left empty intentionally
}

GridAttributes::GridAttributes

(

const GridAttributes &

r

)

Definition at line 79 of file KDChartGridAttributes.cpp.

    : _d( new Private( *r.d ) )
{
}

GridAttributes::~GridAttributes

(

)

Definition at line 94 of file KDChartGridAttributes.cpp.

{
    delete _d; _d = 0;
}

---

Member Function Documentation

bool GridAttributes::adjustLowerBoundToGrid

(

)

const

Definition at line 226 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator==().

{
    return d->adjustLower;
}

bool GridAttributes::adjustUpperBoundToGrid

(

)

const

Definition at line 230 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator==().

{
    return d->adjustUpper;
}

KDChartEnums::GranularitySequence GridAttributes::gridGranularitySequence

(

)

const

Returns the granularity sequence to be used for calculating the grid lines.

See also:

setGridGranularitySequence

Definition at line 216 of file KDChartGridAttributes.cpp.

References d.

Referenced by KDChart::CartesianCoordinatePlane::getDataDimensionsList(), and operator==().

{
    return d->sequence;
}

QPen GridAttributes::gridPen

(

)

const

Definition at line 241 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->pen;
}

qreal GridAttributes::gridStepWidth

(

)

const

Returns the step width to be used for calculating the grid lines.

See also:

setGridStepWidth

Definition at line 152 of file KDChartGridAttributes.cpp.

References d.

Referenced by KDChart::CartesianCoordinatePlane::getDataDimensionsList(), and operator<<().

{
    return d->stepWidth;
}

qreal GridAttributes::gridSubStepWidth

(

)

const

Returns the sub-step width to be used for calculating the sub-grid lines.

See also:

setGridStepWidth

Definition at line 183 of file KDChartGridAttributes.cpp.

References d.

Referenced by KDChart::CartesianCoordinatePlane::getDataDimensionsList(), and operator<<().

{
    return d->subStepWidth;
}

bool GridAttributes::isGridVisible

(

)

const

Definition at line 118 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->visible;
}

bool GridAttributes::isSubGridVisible

(

)

const

Definition at line 251 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->subVisible;
}

bool KDChart::GridAttributes::operator!=

(

const GridAttributes &

other

)

const

Definition at line 107 of file KDChartGridAttributes.h.

References KDGantt::operator==().

{ return !operator==(other); }

GridAttributes & GridAttributes::operator=

(

const GridAttributes &

r

)

Definition at line 84 of file KDChartGridAttributes.cpp.

References d.

{
    if( this == &r )
        return *this;

    *d = *r.d;

    return *this;
}

bool GridAttributes::operator==

(

const GridAttributes &

r

)

const

Definition at line 100 of file KDChartGridAttributes.cpp.

References adjustLowerBoundToGrid(), adjustUpperBoundToGrid(), gridGranularitySequence(), gridPen(), isGridVisible(), isSubGridVisible(), subGridPen(), and zeroLinePen().

{
    return  isGridVisible() == r.isGridVisible() &&
            gridGranularitySequence() == r.gridGranularitySequence() &&
            adjustLowerBoundToGrid() == r.adjustLowerBoundToGrid() &&
            adjustUpperBoundToGrid() == r.adjustUpperBoundToGrid() &&
            gridPen() == r.gridPen() &&
            isSubGridVisible() == r.isSubGridVisible() &&
            subGridPen() == r.subGridPen() &&
            zeroLinePen() == r.zeroLinePen();
}

void GridAttributes::setAdjustBoundsToGrid	(	bool	adjustLower,
		bool	adjustUpper
	)

By default visible bounds of the data area are adjusted to match a main grid line.

If you set the respective adjust flag to false the bound will not start at a grid line's value but it will be the exact value of the data range set.

See also:

CartesianCoordinatePlane::setHorizontalRange

CartesianCoordinatePlane::setVerticalRange

Definition at line 221 of file KDChartGridAttributes.cpp.

References d.

{
    d->adjustLower = adjustLower;
    d->adjustUpper = adjustUpper;
}

void GridAttributes::setGridGranularitySequence

(

KDChartEnums::GranularitySequence

sequence

)

Specify which granularity sequence is to be used to find a matching grid granularity.

Specifies the granularity sequence to be used for calculating the grid lines.

See details explained at KDChartEnums::GranularitySequence.

You might also want to use setAdjustBoundsToGrid for fine-tuning the start/end value.

See also:

setAdjustBoundsToGrid, GranularitySequence

By default the GridAttributes class uses KDChartEnums::GranularitySequence_10_20.

Note:

Granularity can be set for Linear axis calculation mode only, there is no way to specify a step width for Logarithmic axes.

The sequence specified by this method is ignored, if a fixed step width was specified via setStepWidth.

Parameters:

sequence

one of the sequences declared in KDChartEnums::GranularitySequence.

See also:

gridGranularitySequence, setStepWidth

Definition at line 205 of file KDChartGridAttributes.cpp.

References d.

{
    d->sequence = sequence;
}

void GridAttributes::setGridPen

(

const QPen &

pen

)

Definition at line 235 of file KDChartGridAttributes.cpp.

References d.

{
    d->pen = pen;
    d->pen.setCapStyle( Qt::FlatCap );
}

void GridAttributes::setGridStepWidth

(

qreal

stepWidth = 0.0

)

Specifies the step width to be used for calculating the grid lines.

Note:

Step with can be set for Linear axis calculation mode only, there is no way to specify a step width for Logarithmic axes.

By default the GridAttributes class does not use a fixed step width, but it uses KDChartEnums::GranularitySequence_10_20.

Parameters:

stepWidth

the step width to be used. If this parameter is omitted (or set to Zero, resp.) the automatic step width calculation will be done, using the granularity sequence specified. This is the default.

See also:

gridStepWidth, setGranularitySequence

Definition at line 141 of file KDChartGridAttributes.cpp.

References d.

{
    d->stepWidth = stepWidth;
}

void GridAttributes::setGridSubStepWidth

(

qreal

subStepWidth = 0.0

)

Specifies the sub-step width to be used for calculating the grid sub-lines.

Parameters:

subStepWidth

the sub-step width to be used. If this parameter is omitted (or set to Zero, resp.) the automatic calculation will be done, using the granularity sequence specified. This is the default.

See also:

gridSubStepWidth

Definition at line 172 of file KDChartGridAttributes.cpp.

References d.

{
    d->subStepWidth = subStepWidth;
}

void GridAttributes::setGridVisible

(

bool

visible

)

Definition at line 113 of file KDChartGridAttributes.cpp.

References d.

{
    d->visible = visible;
}

void GridAttributes::setSubGridPen

(

const QPen &

pen

)

Definition at line 256 of file KDChartGridAttributes.cpp.

References d.

{
    d->subPen = pen;
    d->subPen.setCapStyle( Qt::FlatCap );
}

void GridAttributes::setSubGridVisible

(

bool

visible

)

Definition at line 246 of file KDChartGridAttributes.cpp.

References d.

{
    d->subVisible = visible;
}

void GridAttributes::setZeroLinePen

(

const QPen &

pen

)

Definition at line 267 of file KDChartGridAttributes.cpp.

References d.

{
    d->zeroPen = pen;
    d->zeroPen.setCapStyle( Qt::FlatCap );
}

QPen GridAttributes::subGridPen

(

)

const

Definition at line 262 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->subPen;
}

QPen GridAttributes::zeroLinePen

(

)

const

Definition at line 273 of file KDChartGridAttributes.cpp.

References d.

Referenced by operator<<(), and operator==().

{
    return d->zeroPen;
}

---

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

• KDChartGridAttributes.h
• KDChartGridAttributes.cpp

---