KGantt::DateTimeGrid

#include <kganttdatetimegrid.h>

Inheritance diagram for KGantt::DateTimeGrid:

[legend]

Public Types
enum	HeaderType { NoHeader , UpperHeader , LowerHeader }

enum	Scale { ScaleAuto , ScaleHour , ScaleDay , ScaleWeek , ScaleMonth , ScaleUserDefined }

Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
qreal	dayWidth () const

QSet< Qt::DayOfWeek >	freeDays () const

QBrush	freeDaysBrush () const

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

QVariant	mapFromChart (qreal x) const override

qreal	mapFromDateTime (const QDateTime &dt) const

Span	mapToChart (const QModelIndex &idx) const override

qreal	mapToChart (const QVariant &value) const override

QDateTime	mapToDateTime (qreal x) const

QBrush	noInformationBrush () const

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

void	paintHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, QWidget widget=nullptr) override

bool	rowSeparators () const

Scale	scale () const

HeaderType	sectionHandleAtPos (int x, int y, const QRect &headerRect) const

void	setDayWidth (qreal)

void	setFreeDays (const QSet< Qt::DayOfWeek > &fd)

void	setFreeDaysBrush (const QBrush brush)

void	setNoInformationBrush (const QBrush &brush)

void	setRowSeparators (bool enable)

void	setScale (Scale s)

void	setStartDateTime (const QDateTime &dt)

void	setUserDefinedLowerScale (DateTimeScaleFormatter *lower)

void	setUserDefinedUpperScale (DateTimeScaleFormatter *upper)

void	setWeekStart (Qt::DayOfWeek)

QDateTime	startDateTime () const

DateTimeTimeLine *	timeLine () const

DateTimeScaleFormatter *	userDefinedLowerScale () const

DateTimeScaleFormatter *	userDefinedUpperScale () const

Qt::DayOfWeek	weekStart () const

Public Member Functions inherited from KGantt::AbstractGrid
	AbstractGrid (QObject *parent=nullptr)

	~AbstractGrid () override

bool	isSatisfiedConstraint (const Constraint &c) const

QAbstractItemModel *	model () const

QModelIndex	rootIndex () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
QRectF	computeRect (const QDateTime &from, const QDateTime &to, const QRectF &rect) const

QPair< QDateTime, QDateTime >	dateTimeRange (const QRectF &rect) const

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

virtual void	drawDayBackground (QPainter *painter, const QRectF &rect, const QDate &date)

virtual void	drawDayForeground (QPainter *painter, const QRectF &rect, const QDate &date)

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

virtual void	paintDayScaleHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, QWidget widget=nullptr)

virtual void	paintHourScaleHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, QWidget widget=nullptr)

virtual void	paintMonthScaleHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, QWidget widget=nullptr)

virtual void	paintUserDefinedHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, const DateTimeScaleFormatter formatter, QWidget *widget=nullptr)

virtual void	paintWeekScaleHeader (QPainter painter, const QRectF &headerRect, const QRectF &exposedRect, qreal offset, QWidget widget=nullptr)

Protected Member Functions inherited from KGantt::AbstractGrid
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName

Signals inherited from KGantt::AbstractGrid
void	gridChanged ()

Public Slots inherited from KGantt::AbstractGrid
virtual void	setModel (QAbstractItemModel *model)

virtual void	setRootIndex (const QModelIndex &idx)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Detailed Description

This implementation of AbstractGrid works with QDateTime and shows days and week numbers in the header

Member Enumeration Documentation

◆ HeaderType

enum KGantt::DateTimeGrid::HeaderType

Definition at line 43 of file kganttdatetimegrid.h.

◆ Scale

enum KGantt::DateTimeGrid::Scale

Definition at line 35 of file kganttdatetimegrid.h.

Constructor & Destructor Documentation

◆ DateTimeGrid()

DateTimeGrid::DateTimeGrid ( )

Definition at line 240 of file kganttdatetimegrid.cpp.

◆ ~DateTimeGrid()

DateTimeGrid::~DateTimeGrid ( )

override

Definition at line 244 of file kganttdatetimegrid.cpp.

Member Function Documentation

◆ computeRect()

QRectF DateTimeGrid::computeRect	(	const QDateTime &	from,
		const QDateTime &	to,
		const QRectF &	rect ) const

protected

Return the rectangle that represents the date-range.

Definition at line 1103 of file kganttdatetimegrid.cpp.

◆ dateTimeRange()

QPair< QDateTime, QDateTime > DateTimeGrid::dateTimeRange ( const QRectF & rect ) const

protected

Return a date-range represented by the rectangle.

Definition at line 1112 of file kganttdatetimegrid.cpp.

◆ dayWidth()

qreal DateTimeGrid::dayWidth ( ) const

Returns: The width in pixels for each day in the grid.

The default is 100 pixels.

Definition at line 262 of file kganttdatetimegrid.cpp.

◆ drawBackground()

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

overrideprotectedvirtual

Todo: document this function

Reimplemented from KGantt::AbstractGrid.

Definition at line 1123 of file kganttdatetimegrid.cpp.

◆ drawDayBackground()

void DateTimeGrid::drawDayBackground	(	QPainter *	painter,
		const QRectF &	rect,
		const QDate &	date )

protectedvirtual

Draw the background for a day.

Definition at line 1085 of file kganttdatetimegrid.cpp.

◆ drawDayForeground()

void DateTimeGrid::drawDayForeground	(	QPainter *	painter,
		const QRectF &	rect,
		const QDate &	date )

protectedvirtual

Draw the foreground for a day.

Definition at line 1094 of file kganttdatetimegrid.cpp.

◆ drawForeground()

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

overrideprotectedvirtual

Todo: document this function

Reimplemented from KGantt::AbstractGrid.

Definition at line 1168 of file kganttdatetimegrid.cpp.

◆ freeDays()

QSet< Qt::DayOfWeek > DateTimeGrid::freeDays ( ) const

Returns: The days marked as free in the grid.

Definition at line 349 of file kganttdatetimegrid.cpp.

◆ freeDaysBrush()

QBrush DateTimeGrid::freeDaysBrush ( ) const

Returns: The brush used to paint free days.

Definition at line 361 of file kganttdatetimegrid.cpp.

◆ mapFromChart() [1/2]

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

overridevirtual

Maps the supplied Span to QDateTimes, and puts them as start time and end time for the supplied index.

Parameters

span	The span used to map from.
idx	The index used for setting the start time and end time in the model.
constraints	A list of hard constraints to match against the start time and end time mapped from the span.

Returns: true if the start time and time was successfully added to the model, or false if unsuccessful. Also returns false if any of the constraints isn't satisfied. That is, if the start time of the constrained index is before the end time of the dependency index, or the end time of the constrained index is before the start time of the dependency index.

Implements KGantt::AbstractGrid.

Definition at line 454 of file kganttdatetimegrid.cpp.

◆ mapFromChart() [2/2]

QVariant DateTimeGrid::mapFromChart ( qreal x ) const

overridevirtual

Parameters

x	The x value to get the datetime for.

Returns: The datetime corresponding to x or an invalid datetime if x cannot be mapped.

Reimplemented from KGantt::AbstractGrid.

Definition at line 402 of file kganttdatetimegrid.cpp.

◆ mapFromDateTime()

qreal DateTimeGrid::mapFromDateTime ( const QDateTime & dt ) const

Maps a given point in time dt to an X value in the scene.

Definition at line 268 of file kganttdatetimegrid.cpp.

◆ mapToChart() [1/2]

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

overridevirtual

Parameters

idx	The index to get the Span for.

Returns: The start and end pixels, in a Span, of the specified index.

Implements KGantt::AbstractGrid.

Definition at line 408 of file kganttdatetimegrid.cpp.

◆ mapToChart() [2/2]

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

overridevirtual

Parameters

value The datetime to get the x value for.

Returns: The x value corresponding to value or -1.0 if value is not a datetime variant.

Reimplemented from KGantt::AbstractGrid.

Definition at line 391 of file kganttdatetimegrid.cpp.

◆ mapToDateTime()

QDateTime DateTimeGrid::mapToDateTime ( qreal x ) const

Maps a given X value x in scene coordinates to a point in time.

Definition at line 274 of file kganttdatetimegrid.cpp.

◆ noInformationBrush()

QBrush DateTimeGrid::noInformationBrush ( ) const

Returns: the brush used to mark rows with no information.

Definition at line 385 of file kganttdatetimegrid.cpp.

◆ paintDayScaleHeader()

void DateTimeGrid::paintDayScaleHeader	(	QPainter *	painter,
		const QRectF &	headerRect,
		const QRectF &	exposedRect,
		qreal	offset,
		QWidget *	widget = nullptr )

protectedvirtual

Paints the day scale header.

See also: paintHeader()

Definition at line 975 of file kganttdatetimegrid.cpp.

◆ paintGrid()

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

overridevirtual

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.

Implements KGantt::AbstractGrid.

Definition at line 665 of file kganttdatetimegrid.cpp.

◆ paintHeader()

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

overridevirtual

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.

Implements KGantt::AbstractGrid.

Definition at line 799 of file kganttdatetimegrid.cpp.

◆ paintHourScaleHeader()

void DateTimeGrid::paintHourScaleHeader	(	QPainter *	painter,
		const QRectF &	headerRect,
		const QRectF &	exposedRect,
		qreal	offset,
		QWidget *	widget = nullptr )

protectedvirtual

Paints the hour scale header.

See also: paintHeader()

Definition at line 936 of file kganttdatetimegrid.cpp.

◆ paintMonthScaleHeader()

void DateTimeGrid::paintMonthScaleHeader	(	QPainter *	painter,
		const QRectF &	headerRect,
		const QRectF &	exposedRect,
		qreal	offset,
		QWidget *	widget = nullptr )

protectedvirtual

Paints the week scale header.

See also: paintHeader()

Definition at line 1050 of file kganttdatetimegrid.cpp.

◆ paintUserDefinedHeader()

void DateTimeGrid::paintUserDefinedHeader	(	QPainter *	painter,
		const QRectF &	headerRect,
		const QRectF &	exposedRect,
		qreal	offset,
		const DateTimeScaleFormatter *	formatter,
		QWidget *	widget = nullptr )

protectedvirtual

Definition at line 852 of file kganttdatetimegrid.cpp.

◆ paintWeekScaleHeader()

void DateTimeGrid::paintWeekScaleHeader	(	QPainter *	painter,
		const QRectF &	headerRect,
		const QRectF &	exposedRect,
		qreal	offset,
		QWidget *	widget = nullptr )

protectedvirtual

Paints the week scale header.

See also: paintHeader()

Definition at line 1013 of file kganttdatetimegrid.cpp.

◆ rowSeparators()

bool DateTimeGrid::rowSeparators ( ) const

Returns: true if row separators are used.

Definition at line 367 of file kganttdatetimegrid.cpp.

◆ scale()

DateTimeGrid::Scale DateTimeGrid::scale ( ) const

Returns: The scale used to paint the grid.

The default is ScaleAuto, which means the day scale will be used as long as the day width is less or equal to 500.

See also: Scale

Definition at line 295 of file kganttdatetimegrid.cpp.

◆ sectionHandleAtPos()

DateTimeGrid::HeaderType DateTimeGrid::sectionHandleAtPos	(	int	x,
		int	y,
		const QRect &	headerRect ) const

Definition at line 776 of file kganttdatetimegrid.cpp.

◆ setDayWidth()

void DateTimeGrid::setDayWidth ( qreal w )

Parameters

w	The width in pixels for each day in the grid.

The signal gridChanged() is emitted after the day width is changed.

Definition at line 280 of file kganttdatetimegrid.cpp.

◆ setFreeDays()

void DateTimeGrid::setFreeDays ( const QSet< Qt::DayOfWeek > & fd )

Parameters

fd	A set of days to mark as free in the grid.

Free days are filled with the alternate base brush of the palette used by the view. The signal gridChanged() is emitted after the free days are changed.

Definition at line 342 of file kganttdatetimegrid.cpp.

◆ setFreeDaysBrush()

void DateTimeGrid::setFreeDaysBrush ( const QBrush brush )

Sets the brush to use to paint free days.

Definition at line 355 of file kganttdatetimegrid.cpp.

◆ setNoInformationBrush()

void DateTimeGrid::setNoInformationBrush ( const QBrush & brush )

Sets the brush used to display rows where no data is found. Default is a red pattern. If set to QBrush() rows with no information will not be marked.

Definition at line 378 of file kganttdatetimegrid.cpp.

◆ setRowSeparators()

void DateTimeGrid::setRowSeparators ( bool enable )

Parameters

enable Whether to use row separators or not.

Definition at line 372 of file kganttdatetimegrid.cpp.

◆ setScale()

void DateTimeGrid::setScale ( Scale s )

Parameters

s	The scale to be used to paint the grid.

The signal gridChanged() is emitted after the scale has changed.

See also: Scale

Following example demonstrates how to change the format of the header to use a date-scaling with the header-label displayed with the ISO date-notation.

DateTimeScaleFormatter* formatter = new DateTimeScaleFormatter(DateTimeScaleFormatter::Day, QString::fromLatin1("yyyy-MMMM-dddd"));
grid->setUserDefinedUpperScale( formatter );
grid->setUserDefinedLowerScale( formatter );
grid->setScale( DateTimeGrid::ScaleUserDefined );

Definition at line 288 of file kganttdatetimegrid.cpp.

◆ setStartDateTime()

void DateTimeGrid::setStartDateTime ( const QDateTime & dt )

Parameters

dt	The start date of the grid. It is used as the beginning of the horizontal scrollbar in the view.

Emits gridChanged() after the start date has changed.

Definition at line 255 of file kganttdatetimegrid.cpp.

◆ setUserDefinedLowerScale()

void DateTimeGrid::setUserDefinedLowerScale ( DateTimeScaleFormatter * lower )

Sets the scale formatter for the lower part of the header to the user defined formatter to lower. The DateTimeGrid object takes ownership of the formatter, which has to be allocated with new.

You have to set the scale to ScaleUserDefined for this setting to take effect.

See also: DateTimeScaleFormatter

Definition at line 301 of file kganttdatetimegrid.cpp.

◆ setUserDefinedUpperScale()

void DateTimeGrid::setUserDefinedUpperScale ( DateTimeScaleFormatter * upper )

Sets the scale formatter for the upper part of the header to the user defined formatter to upper. The DateTimeGrid object takes ownership of the formatter, which has to be allocated with new.

You have to set the scale to ScaleUserDefined for this setting to take effect.

See also: DateTimeScaleFormatter

Definition at line 309 of file kganttdatetimegrid.cpp.

◆ setWeekStart()

void DateTimeGrid::setWeekStart ( Qt::DayOfWeek ws )

Parameters

ws	The start day of the week.

A solid line is drawn on the grid to mark the beginning of a new week. Emits gridChanged() after the start day has changed.

Definition at line 329 of file kganttdatetimegrid.cpp.

◆ startDateTime()

QDateTime DateTimeGrid::startDateTime ( ) const

Returns: The QDateTime used as start date for the grid.

The default is three days before the current date.

Definition at line 249 of file kganttdatetimegrid.cpp.

◆ timeLine()

DateTimeTimeLine * DateTimeGrid::timeLine ( ) const

Returns: the timeline control object

Definition at line 1212 of file kganttdatetimegrid.cpp.

◆ userDefinedLowerScale()

DateTimeScaleFormatter * DateTimeGrid::userDefinedLowerScale ( ) const

Returns: The DateTimeScaleFormatter being used to render the lower scale.

Definition at line 317 of file kganttdatetimegrid.cpp.

◆ userDefinedUpperScale()

DateTimeScaleFormatter * DateTimeGrid::userDefinedUpperScale ( ) const

Returns: The DateTimeScaleFormatter being used to render the upper scale.

Definition at line 323 of file kganttdatetimegrid.cpp.

◆ weekStart()

Qt::DayOfWeek DateTimeGrid::weekStart ( ) const

Returns: The start day of the week

Definition at line 336 of file kganttdatetimegrid.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KGantt

KGantt::DateTimeGrid

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HeaderType

◆ Scale

Constructor & Destructor Documentation

◆ DateTimeGrid()

◆ ~DateTimeGrid()

Member Function Documentation

◆ computeRect()

◆ dateTimeRange()

◆ dayWidth()

◆ drawBackground()

◆ drawDayBackground()

◆ drawDayForeground()

◆ drawForeground()

◆ freeDays()

◆ freeDaysBrush()

◆ mapFromChart() [1/2]

◆ mapFromChart() [2/2]

◆ mapFromDateTime()

◆ mapToChart() [1/2]

◆ mapToChart() [2/2]

◆ mapToDateTime()

◆ noInformationBrush()

◆ paintDayScaleHeader()

◆ paintGrid()

◆ paintHeader()

◆ paintHourScaleHeader()

◆ paintMonthScaleHeader()

◆ paintUserDefinedHeader()

◆ paintWeekScaleHeader()

◆ rowSeparators()

◆ scale()

◆ sectionHandleAtPos()

◆ setDayWidth()

◆ setFreeDays()

◆ setFreeDaysBrush()

◆ setNoInformationBrush()

◆ setRowSeparators()

◆ setScale()

◆ setStartDateTime()

◆ setUserDefinedLowerScale()

◆ setUserDefinedUpperScale()

◆ setWeekStart()

◆ startDateTime()

◆ timeLine()

◆ userDefinedLowerScale()

◆ userDefinedUpperScale()

◆ weekStart()