The GraphicsView class provides a model/view implementation of a gantt chart. More...

#include <KDGanttGraphicsView>

Inheritance diagram for KDGantt::GraphicsView:

Public Slots
void	setConstraintModel (ConstraintModel *)
	Sets the constraintmodel displayed by this view. More...

void	setGrid (AbstractGrid *)
	Sets the AbstractGrid for this view. More...

void	setItemDelegate (ItemDelegate *delegate)
	Sets the KDGantt::ItemDelegate used for rendering items on this view. More...

void	setModel (QAbstractItemModel *)
	Sets the model to be displayed in this view to model. More...

void	setReadOnly (bool)
	Sets the view to read-only mode if to is true. More...

void	setRootIndex (const QModelIndex &)
	Sets the root index of the model displayed by this view. More...

void	setRowController (AbstractRowController *)
	Sets the AbstractRowController used by this view. More...

void	setSelectionModel (QItemSelectionModel *)
	Sets the QItemSelectionModel used by this view to manage selections. More...

void	setSummaryHandlingModel (QAbstractProxyModel *model)

void	updateSceneRect ()

Signals
void	activated (const QModelIndex &index)

void	clicked (const QModelIndex &index)

void	entered (const QModelIndex &index)

void	headerContextMenuRequested (const QPoint &pt)
	This signal is emitted when the header has contextMenuPolicy Qt::CustomContextMenu and the widget wants to show a context menu for the header. More...

void	pressed (const QModelIndex &index)

void	qrealClicked (const QModelIndex &index)

Public Member Functions
	GraphicsView (QWidget *parent=nullptr)
	Constructor. More...

	~GraphicsView () override
	Destroys this view. More...

virtual void	addConstraint (const QModelIndex &from, const QModelIndex &to, Qt::KeyboardModifiers modifiers)
	Adds a constraint from from to to. More...

void	clearItems ()

ConstraintModel *	constraintModel () const

void	deleteSubtree (const QModelIndex &)

AbstractGrid *	grid () const

Qt::ContextMenuPolicy	headerContextMenuPolicy () const

QModelIndex	indexAt (const QPoint &pos) const

bool	isReadOnly () const

ItemDelegate *	itemDelegate () const

QAbstractItemModel *	model () const

void	print (QPainter *painter, const QRectF &target=QRectF(), bool drawRowLabels=true, bool drawColumnLabels=true)
	Render the GanttView inside the rectangle target using the painter painter. More...

void	print (QPainter *painter, qreal start, qreal end, const QRectF &target=QRectF(), bool drawRowLabels=true, bool drawColumnLabels=true)
	Render the GanttView inside the rectangle target using the painter painter. More...

void	print (QPrinter *printer, bool drawRowLabels=true, bool drawColumnLabels=true)
	Print the Gantt chart using printer. More...

void	print (QPrinter *printer, qreal start, qreal end, bool drawRowLabels=true, bool drawColumnLabels=true)
	Print part of the Gantt chart from start to end using printer. More...

QModelIndex	rootIndex () const

AbstractRowController *	rowController () const

QItemSelectionModel *	selectionModel () const

void	setHeaderContextMenuPolicy (Qt::ContextMenuPolicy)
	Sets the context menu policy for the header. More...

QAbstractProxyModel *	summaryHandlingModel () const

void	updateRow (const QModelIndex &)

void	updateScene ()

Protected Member Functions
void	resizeEvent (QResizeEvent *) override

Properties
bool	readOnly

Detailed Description

The GraphicsView class provides a model/view implementation of a gantt chart.

Definition at line 33 of file kdganttgraphicsview.h.

Constructor & Destructor Documentation

◆ GraphicsView()

GraphicsView::GraphicsView ( QWidget * parent = nullptr )

explicit

Constructor.

Creates a new KDGantt::GraphicsView with parent parent.

Definition at line 311 of file kdganttgraphicsview.cpp.

References KDGantt::GraphicsScene::clicked(), KDGantt::GraphicsScene::entered(), entered(), KDGantt::GraphicsScene::gridChanged(), KDGantt::GraphicsScene::pressed(), pressed(), KDGantt::GraphicsScene::qrealClicked(), setSummaryHandlingModel(), and updateSceneRect().

◆ ~GraphicsView()

GraphicsView::~GraphicsView ( )

override

Destroys this view.

Definition at line 357 of file kdganttgraphicsview.cpp.

Member Function Documentation

◆ activated

void GraphicsView::activated ( const QModelIndex & index )

signal

◆ addConstraint()

void GraphicsView::addConstraint	(	const QModelIndex &	from,
		const QModelIndex &	to,
		Qt::KeyboardModifiers	modifiers
	)

virtual

Adds a constraint from from to to.

modifiers are the keyboard modifiers pressed by the user when the action is invoked.

Override this to control how constraints are added. The default implementation adds a soft constraint unless the Shift key is pressed, in that case it adds a hard constraint. If a constraint is already present, it is removed and nothing is added.

Definition at line 588 of file kdganttgraphicsview.cpp.

References KDGantt::ConstraintModel::addConstraint(), constraintModel(), KDGantt::ConstraintModel::hasConstraint(), isReadOnly(), KDGantt::ConstraintModel::removeConstraint(), KDGantt::Constraint::TypeHard, and KDGantt::Constraint::TypeSoft.

◆ clearItems()

void GraphicsView::clearItems ( )

Definition at line 646 of file kdganttgraphicsview.cpp.

References d.

Referenced by updateScene().

◆ clicked

void GraphicsView::clicked ( const QModelIndex & index )

signal

◆ constraintModel()

ConstraintModel * GraphicsView::constraintModel ( ) const

Returns: the KDGantt::ConstraintModel displayed by this view.

Definition at line 449 of file kdganttgraphicsview.cpp.

References d.

Referenced by addConstraint().

◆ deleteSubtree()

void GraphicsView::deleteSubtree ( const QModelIndex & idx )

Definition at line 717 of file kdganttgraphicsview.cpp.

References d.

◆ entered

void GraphicsView::entered ( const QModelIndex & index )

signal

Referenced by GraphicsView().

◆ grid()

AbstractGrid * GraphicsView::grid ( ) const

Returns: the AbstractGrid used by this view.

Definition at line 539 of file kdganttgraphicsview.cpp.

References d.

Referenced by KDGantt::View::setGraphicsView(), and setGrid().

◆ headerContextMenuPolicy()

Qt::ContextMenuPolicy GraphicsView::headerContextMenuPolicy ( ) const

Returns: the context menu policy for the header

Definition at line 575 of file kdganttgraphicsview.cpp.

References d.

◆ headerContextMenuRequested

void GraphicsView::headerContextMenuRequested ( const QPoint & pt )

signal

This signal is emitted when the header has contextMenuPolicy Qt::CustomContextMenu and the widget wants to show a context menu for the header.

Unlike in QWidget::customContextMenuRequested() signal, pt is here in global coordinates.

◆ indexAt()

QModelIndex GraphicsView::indexAt ( const QPoint & pos ) const

Returns: The QModelIndex for the item located at position pos in the view or an invalid index if no item was present at that position.

This is useful for example contextmenus.

Definition at line 635 of file kdganttgraphicsview.cpp.

References d.

◆ isReadOnly()

bool GraphicsView::isReadOnly ( ) const

Returns: true iff the view is in read-only mode

Definition at line 554 of file kdganttgraphicsview.cpp.

References d.

Referenced by addConstraint().

◆ itemDelegate()

ItemDelegate * GraphicsView::itemDelegate ( ) const

Returns: the ItemDelegate used by this view to render items

Definition at line 501 of file kdganttgraphicsview.cpp.

References d.

◆ model()

QAbstractItemModel * GraphicsView::model ( ) const

Returns: the current model displayed by this view

Definition at line 390 of file kdganttgraphicsview.cpp.

References d.

Referenced by setModel(), setSelectionModel(), and updateScene().

◆ pressed

void GraphicsView::pressed ( const QModelIndex & index )

signal

Referenced by GraphicsView().

◆ print() [1/4]

void GraphicsView::print	(	QPainter *	painter,
		const QRectF &	targetRect = `QRectF()`,
		bool	drawRowLabels = `true`,
		bool	drawColumnLabels = `true`
	)

Render the GanttView inside the rectangle target using the painter painter.

If drawRowLabels is true (the default), each row will have it's label printed on the left side. If drawColumnLabels is true (the default), each column will have it's label printed at the top side.

Definition at line 758 of file kdganttgraphicsview.cpp.

References d.

◆ print() [2/4]

void GraphicsView::print	(	QPainter *	painter,
		qreal	start,
		qreal	end,
		const QRectF &	targetRect = `QRectF()`,
		bool	drawRowLabels = `true`,
		bool	drawColumnLabels = `true`
	)

Render the GanttView inside the rectangle target using the painter painter.

If drawRowLabels is true (the default), each row will have it's label printed on the left side. If drawColumnLabels is true (the default), each column will have it's label printed at the top side.

To print a certain range of a chart with a DateTimeGrid, use qreal DateTimeGrid::mapFromDateTime( const QDateTime& dt) const to figure out the values for start and end.

Definition at line 773 of file kdganttgraphicsview.cpp.

References d.

◆ print() [3/4]

void GraphicsView::print	(	QPrinter *	printer,
		bool	drawRowLabels = `true`,
		bool	drawColumnLabels = `true`
	)

Print the Gantt chart using printer.

If drawRowLabels is true (the default), each row will have it's label printed on the left side. If drawColumnLabels is true (the default), each column will have it's label printed at the top side.

This version of print() will print multiple pages.

Definition at line 730 of file kdganttgraphicsview.cpp.

References d.

Referenced by KDGantt::View::print().

◆ print() [4/4]

void GraphicsView::print	(	QPrinter *	printer,
		qreal	start,
		qreal	end,
		bool	drawRowLabels = `true`,
		bool	drawColumnLabels = `true`
	)

Print part of the Gantt chart from start to end using printer.

If drawRowLabels is true (the default), each row will have it's label printed on the left side. If drawColumnLabels is true (the default), each column will have it's label printed at the top side.

This version of print() will print multiple pages.

To print a certain range of a chart with a DateTimeGrid, use qreal DateTimeGrid::mapFromDateTime( const QDateTime& dt) const to figure out the values for start and end.

Definition at line 747 of file kdganttgraphicsview.cpp.

References d.

◆ qrealClicked

void GraphicsView::qrealClicked ( const QModelIndex & index )

signal

◆ resizeEvent()

void GraphicsView::resizeEvent ( QResizeEvent * ev )

overrideprotected

Definition at line 603 of file kdganttgraphicsview.cpp.

References d, rowController(), and KDGantt::AbstractRowController::totalHeight().

◆ rootIndex()

QModelIndex GraphicsView::rootIndex ( ) const

Returns: the rootindex for this view.

Definition at line 471 of file kdganttgraphicsview.cpp.

References d.

Referenced by updateScene().

◆ rowController()

AbstractRowController * GraphicsView::rowController ( ) const

Returns: the AbstractRowController for this view.

See also: setRowController

Definition at line 521 of file kdganttgraphicsview.cpp.

References d.

Referenced by resizeEvent(), updateScene(), and updateSceneRect().

◆ selectionModel()

QItemSelectionModel * GraphicsView::selectionModel ( ) const

Returns: the QItemSelectionModel used by this view

Definition at line 486 of file kdganttgraphicsview.cpp.

References d.

◆ setConstraintModel

void GraphicsView::setConstraintModel ( ConstraintModel * cmodel )

slot

Sets the constraintmodel displayed by this view.

See also: KDGantt::ConstraintModel.

Definition at line 442 of file kdganttgraphicsview.cpp.

References d.

◆ setGrid

void GraphicsView::setGrid ( AbstractGrid * grid )

slot

Sets the AbstractGrid for this view.

The grid is an object that controls how QModelIndexes are mapped to and from the view and how the background and header is rendered.

See also: AbstractGrid and DateTimeGrid.

Definition at line 531 of file kdganttgraphicsview.cpp.

References d, and grid().

◆ setHeaderContextMenuPolicy()

void GraphicsView::setHeaderContextMenuPolicy ( Qt::ContextMenuPolicy p )

Sets the context menu policy for the header.

The default value Qt::DefaultContextMenu results in a standard context menu on the header that allows the user to set the scale and zoom.

Setting this to Qt::CustomContextMenu will cause the signal headerContextMenuRequested(const QPoint& pt) to be emitted instead.

See also: QWidget::setContextMenuPolicy( Qt::ContextMenuPolicy )

Definition at line 568 of file kdganttgraphicsview.cpp.

References d.

◆ setItemDelegate

void GraphicsView::setItemDelegate ( ItemDelegate * delegate )

slot

Sets the KDGantt::ItemDelegate used for rendering items on this view.

See also: ItemDelegate and QAbstractItemDelegate.

Definition at line 494 of file kdganttgraphicsview.cpp.

References d.

◆ setModel

void GraphicsView::setModel ( QAbstractItemModel * model )

slot

Sets the model to be displayed in this view to model.

The view does not take ownership of the model.

To make a model work well with GraphicsView it must have a certain layout. Whether the model is flat or has a treestrucure is not important, as long as an AbstractRowController is provided that can navigate the model.

GraphicsView operates per row in the model. The data is always taken from the last item in the row. The ItemRoles used are Qt::DisplayRole and the roles defined in KDGantt::ItemDataRole.

Definition at line 377 of file kdganttgraphicsview.cpp.

References d, model(), updateScene(), and updateSceneRect().

Referenced by KDAB_SCOPED_UNITTEST_SIMPLE().

◆ setReadOnly

void GraphicsView::setReadOnly ( bool ro )

slot

Sets the view to read-only mode if to is true.

The default is read/write if the model permits it.

Definition at line 547 of file kdganttgraphicsview.cpp.

References d.

◆ setRootIndex

void GraphicsView::setRootIndex ( const QModelIndex & idx )

slot

Sets the root index of the model displayed by this view.

Similar to QAbstractItemView::setRootIndex, default is QModelIndex().

Definition at line 464 of file kdganttgraphicsview.cpp.

References d.

◆ setRowController

void GraphicsView::setRowController ( AbstractRowController * rowcontroller )

slot

Sets the AbstractRowController used by this view.

The AbstractRowController deals with the height and position of each row and with which parts of the model are displayed.

See also: AbstractRowController

Definition at line 511 of file kdganttgraphicsview.cpp.

References d, and updateScene().

Referenced by KDAB_SCOPED_UNITTEST_SIMPLE().

◆ setSelectionModel

void GraphicsView::setSelectionModel ( QItemSelectionModel * model )

slot

Sets the QItemSelectionModel used by this view to manage selections.

Similar to QAbstractItemView::setSelectionModel

Definition at line 479 of file kdganttgraphicsview.cpp.

References d, and model().

◆ setSummaryHandlingModel

void GraphicsView::setSummaryHandlingModel ( QAbstractProxyModel * model )

slot

Definition at line 395 of file kdganttgraphicsview.cpp.

References d, and updateScene().

Referenced by GraphicsView().

◆ summaryHandlingModel()

QAbstractProxyModel * GraphicsView::summaryHandlingModel ( ) const

Returns: the KDGantt::SummaryHandlingProxyModel used by this view.

Definition at line 456 of file kdganttgraphicsview.cpp.

References d.

◆ updateRow()

void GraphicsView::updateRow ( const QModelIndex & idx )

Definition at line 652 of file kdganttgraphicsview.cpp.

References d.

Referenced by updateScene().

◆ updateScene()

void GraphicsView::updateScene ( )

Definition at line 692 of file kdganttgraphicsview.cpp.

References clearItems(), model(), rootIndex(), rowController(), updateRow(), and updateSceneRect().

Referenced by KDAB_SCOPED_UNITTEST_SIMPLE(), setModel(), setRowController(), and setSummaryHandlingModel().

◆ updateSceneRect

void GraphicsView::updateSceneRect ( )

slot

Definition at line 660 of file kdganttgraphicsview.cpp.

References d, rowController(), and KDGantt::AbstractRowController::totalHeight().

Referenced by GraphicsView(), setModel(), and updateScene().

Property Documentation

◆ readOnly

bool KDGantt::GraphicsView::readOnly

readwrite

Definition at line 24 of file kdganttgraphicsview.h.

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ GraphicsView()

◆ ~GraphicsView()

Member Function Documentation

◆ activated

◆ addConstraint()

◆ clearItems()

◆ clicked

◆ constraintModel()

◆ deleteSubtree()

◆ entered

◆ grid()

◆ headerContextMenuPolicy()

◆ headerContextMenuRequested

◆ indexAt()

◆ isReadOnly()

◆ itemDelegate()

◆ model()

◆ pressed

◆ print() [1/4]

◆ print() [2/4]

◆ print() [3/4]

◆ print() [4/4]

◆ qrealClicked

◆ resizeEvent()

◆ rootIndex()

◆ rowController()

◆ selectionModel()

◆ setConstraintModel

◆ setGrid

◆ setHeaderContextMenuPolicy()

◆ setItemDelegate

◆ setModel

◆ setReadOnly

◆ setRootIndex

◆ setRowController

◆ setSelectionModel

◆ setSummaryHandlingModel

◆ summaryHandlingModel()

◆ updateRow()

◆ updateScene()

◆ updateSceneRect

Property Documentation

◆ readOnly