Abstract baseclass for grids. More...

#include <KDGanttAbstractGrid>

Inheritance diagram for KDGantt::AbstractGrid:

Public Slots
virtual void	setModel (QAbstractItemModel *model)
	Sets the QAbstractItemModel used by this grid implementation. More...

virtual void	setRootIndex (const QModelIndex &idx)
	Sets the root index used by this grid implementation. More...

Signals
void	gridChanged ()

Public Member Functions
	AbstractGrid (QObject *parent=nullptr)
	Constructor. More...

	~AbstractGrid () override
	Destructor. More...

bool	isSatisfiedConstraint (const Constraint &c) const

virtual bool	mapFromChart (const Span &span, const QModelIndex &idx, const QList< Constraint > &constraints=QList< Constraint >()) const =0
	Implement this to update the model data based on the location of the item. More...

virtual QVariant	mapFromChart (qreal x) const
	Implement this to map from x to the corresponding location in the view. More...

virtual Span	mapToChart (const QModelIndex &idx) const =0
	Implement this to map from the data in the model to the location of the corresponding item in the view. More...

virtual qreal	mapToChart (const QVariant &value) const
	Implement this to map from value to the corresponding location in the view. More...

QAbstractItemModel *	model () const

virtual void	paintGrid (QPainter painter, const QRectF &sceneRect, const QRectF &exposedRect, AbstractRowController rowController=nullptr, QWidget *widget=nullptr)=0
	Implement this to paint the background of the view – typically with some grid lines. More...

virtual void	paintHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, QWidget widget=nullptr)=0
	Implement this to paint the header part of the view. More...

QModelIndex	rootIndex () const

Protected Member Functions
virtual void	drawBackground (QPainter *paint, const QRectF &rect)

virtual void	drawForeground (QPainter *paint, const QRectF &rect)

Detailed Description

Abstract baseclass for grids.

A grid is used to convert between QModelIndex'es and gantt chart values (qreals) and to paint the background and header of the view.

See also: KDGantt::DateTimeGrid

Definition at line 28 of file kdganttabstractgrid.h.

Constructor & Destructor Documentation

◆ AbstractGrid()

AbstractGrid::AbstractGrid ( QObject * parent = nullptr )

Constructor.

Creates an AbstractGrid with parent parent. The QObject parent is not used for anything internally.

Definition at line 29 of file kdganttabstractgrid.cpp.

◆ ~AbstractGrid()

AbstractGrid::~AbstractGrid ( )

override

Destructor.

Does nothing

Definition at line 36 of file kdganttabstractgrid.cpp.

Member Function Documentation

◆ drawBackground()

void AbstractGrid::drawBackground	(	QPainter *	paint,
		const QRectF &	rect
	)

protectedvirtual

Reimplemented in KDGantt::DateTimeGrid.

Definition at line 143 of file kdganttabstractgrid.cpp.

◆ drawForeground()

void AbstractGrid::drawForeground	(	QPainter *	paint,
		const QRectF &	rect
	)

protectedvirtual

Reimplemented in KDGantt::DateTimeGrid.

Definition at line 152 of file kdganttabstractgrid.cpp.

◆ gridChanged

void KDGantt::AbstractGrid::gridChanged ( )

signal

Referenced by KDGantt::DateTimeGrid::setDayWidth(), KDGantt::DateTimeGrid::setFreeDays(), KDGantt::GraphicsScene::setGrid(), KDGantt::DateTimeGrid::setNoInformationBrush(), KDGantt::DateTimeGrid::setScale(), KDGantt::DateTimeGrid::setStartDateTime(), KDGantt::DateTimeGrid::setUserDefinedLowerScale(), KDGantt::DateTimeGrid::setUserDefinedUpperScale(), and KDGantt::DateTimeGrid::setWeekStart().

◆ isSatisfiedConstraint()

bool AbstractGrid::isSatisfiedConstraint ( const Constraint & c ) const

Returns: true if the startpoint is before the endpoint of the constraint c.

Definition at line 74 of file kdganttabstractgrid.cpp.

References KDGantt::Span::end(), KDGantt::Constraint::endIndex(), mapToChart(), KDGantt::Span::start(), and KDGantt::Constraint::startIndex().

Referenced by KDAB_SCOPED_UNITTEST_SIMPLE(), and KDGantt::DateTimeGrid::mapFromChart().

◆ mapFromChart() [1/2]

bool AbstractGrid::mapFromChart	(	const Span &	span,
		const QModelIndex &	idx,
		const QList< Constraint > &	constraints = `QList<Constraint>()`
	)		const

pure virtual

Implement this to update the model data based on the location of the item.

Check against the constraints list to make sure no hard constraints are violated by writing back to the model.

Returns: true if the update succeeded.

Implemented in KDGantt::DateTimeGrid.

◆ mapFromChart() [2/2]

QVariant AbstractGrid::mapFromChart ( qreal x ) const

virtual

Implement this to map from x to the corresponding location in the view.

Return an invalid value if x cannot be mapped.

Reimplemented in KDGantt::DateTimeGrid.

Definition at line 101 of file kdganttabstractgrid.cpp.

◆ mapToChart() [1/2]

Span AbstractGrid::mapToChart ( const QModelIndex & idx ) const

pure virtual

Implement this to map from the data in the model to the location of the corresponding item in the view.

Implemented in KDGantt::DateTimeGrid.

Referenced by isSatisfiedConstraint(), and KDGantt::GraphicsItem::updateItem().

◆ mapToChart() [2/2]

qreal AbstractGrid::mapToChart ( const QVariant & value ) const

virtual

Implement this to map from value to the corresponding location in the view.

Return a negative value if value cannot be mapped. The default implementation returns -1.0.

Reimplemented in KDGantt::DateTimeGrid.

Definition at line 91 of file kdganttabstractgrid.cpp.

◆ model()

QAbstractItemModel * AbstractGrid::model ( ) const

Returns: The QAbstractItemModel used by this grid

Definition at line 52 of file kdganttabstractgrid.cpp.

References d.

Referenced by KDGantt::DateTimeGrid::mapFromChart(), KDGantt::DateTimeGrid::mapToChart(), and setModel().

◆ paintGrid()

void AbstractGrid::paintGrid	(	QPainter *	painter,
		const QRectF &	sceneRect,
		const QRectF &	exposedRect,
		AbstractRowController *	rowController = `nullptr`,
		QWidget *	widget = `nullptr`
	)

pure virtual

Implement this to paint the background of the view – typically with some grid lines.

Parameters

painter	– the QPainter to paint with.
sceneRect	– the total bounding rectangle of the scene.
exposedRect	– the rectangle that needs to be painted.
rowController	– the row controller used by the view – may be 0.
widget	– the widget used by the view – may be 0.

Implemented in KDGantt::DateTimeGrid.

◆ paintHeader()

void AbstractGrid::paintHeader	(	QPainter *	painter,
		const QRectF &	headerRect,
		const QRectF &	exposedRect,
		qreal	offset,
		QWidget *	widget = `nullptr`
	)

pure virtual

Implement this to paint the header part of the view.

Parameters

painter	– the QPainter to paint with.
headerRect	– the total rectangle occupied by the header.
exposedRect	– the rectangle that needs to be painted.
offset	– the horizontal scroll offset of the view.
widget	– the widget used by the view – may be 0.

Implemented in KDGantt::DateTimeGrid.

◆ rootIndex()

QModelIndex AbstractGrid::rootIndex ( ) const

Returns: the current root index for this grid

Definition at line 66 of file kdganttabstractgrid.cpp.

References d.

◆ setModel

void AbstractGrid::setModel ( QAbstractItemModel * model )

virtualslot

Sets the QAbstractItemModel used by this grid implementation.

This is called by the view, you should never need to call this from client code.

Definition at line 46 of file kdganttabstractgrid.cpp.

References d, and model().

Referenced by KDAB_SCOPED_UNITTEST_SIMPLE().

◆ setRootIndex

void AbstractGrid::setRootIndex ( const QModelIndex & idx )

virtualslot

Sets the root index used by this grid implementation.

This is called by the view, you should never need to call this from client code.

Definition at line 60 of file kdganttabstractgrid.cpp.

References d.

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AbstractGrid()

◆ ~AbstractGrid()

Member Function Documentation

◆ drawBackground()

◆ drawForeground()

◆ gridChanged

◆ isSatisfiedConstraint()

◆ mapFromChart() [1/2]

◆ mapFromChart() [2/2]

◆ mapToChart() [1/2]

◆ mapToChart() [2/2]

◆ model()

◆ paintGrid()

◆ paintHeader()

◆ rootIndex()

◆ setModel

◆ setRootIndex