KDGantt::DateTimeScaleFormatter Class Reference

#include <kdganttdatetimegrid.h>

List of all members.

---

Detailed Description

This class formats dates and times used in DateTimeGrid follawing a given format.

The format follows the format of QDateTime::toString(), with one addition: "w" is replaced with the week number of the date as number without a leading zero (1-53) "ww" is replaced with the week number of the date as number with a leading zero (01-53)

For example:

  // formatter to print the complete date over the current week
  // This leads to the first day of the week being printed
  DateTimeScaleFormatter formatter = DateTimeScaleFormatter( DateTimeScaleFormatter::Week, "yyyy-MM-dd" );

Optionally, you can set an user defined text alignment flag. The default value is Qt::AlignCenter.

See also:

DateTimeScaleFormatter::DateTimeScaleFormatter

This class even controls the range of the grid sections.

See also:

KDGanttDateTimeScaleFormatter::Range

Definition at line 34 of file kdganttdatetimegrid.h.

Public Types
enum	Range {   Second,   Minute,   Hour,   Day,   Week,   Month,   Year }
Public Member Functions
Qt::Alignment	alignment () const
virtual QDateTime	currentRangeBegin (const QDateTime &datetime) const
	DateTimeScaleFormatter (const DateTimeScaleFormatter &other)
	DateTimeScaleFormatter (Range range, const QString &formatString, const QString &templ, Qt::Alignment alignment=Qt::AlignCenter)
	DateTimeScaleFormatter (Range range, const QString &formatString, Qt::Alignment alignment=Qt::AlignCenter)
QString	format (const QDateTime &datetime) const
QString	format () const
virtual QDateTime	nextRangeBegin (const QDateTime &datetime) const
DateTimeScaleFormatter &	operator= (const DateTimeScaleFormatter &other)
Range	range () const
virtual QString	text (const QDateTime &datetime) const
virtual	~DateTimeScaleFormatter ()

---

Member Enumeration Documentation

enum KDGantt::DateTimeScaleFormatter::Range

Enumerator:

Second
Minute
Hour
Day
Week
Month
Year

Definition at line 38 of file kdganttdatetimegrid.h.

        {
            Second,
            Minute,
            Hour,
            Day,
            Week,
            Month,
            Year
        };

---

Constructor & Destructor Documentation

DateTimeScaleFormatter::DateTimeScaleFormatter	(	Range	range,
		const QString &	formatString,
		Qt::Alignment	alignment = Qt::AlignCenter
	)

Definition at line 124 of file kdganttdatetimegrid.cpp.

    : _d( new Private( range, format, QString::fromLatin1( "%1" ), alignment ) )
{
}

DateTimeScaleFormatter::DateTimeScaleFormatter	(	Range	range,
		const QString &	format,
		const QString &	templ,
		Qt::Alignment	alignment = Qt::AlignCenter
	)

Creates a DateTimeScaleFormatter using range and format. The text on the header is aligned following alignment.

Definition at line 118 of file kdganttdatetimegrid.cpp.

    : _d( new Private( range, format, templ, alignment ) )
{
}

DateTimeScaleFormatter::DateTimeScaleFormatter

(

const DateTimeScaleFormatter &

other

)

Definition at line 129 of file kdganttdatetimegrid.cpp.

    : _d( new Private( other.range(), other.format(), other.d->templ, other.alignment() ) )
{
}

DateTimeScaleFormatter::~DateTimeScaleFormatter

(

)

[virtual]

Definition at line 134 of file kdganttdatetimegrid.cpp.

{
    delete _d;
}

---

Member Function Documentation

Qt::Alignment DateTimeScaleFormatter::alignment

(

)

const

Definition at line 179 of file kdganttdatetimegrid.cpp.

References d.

Referenced by operator=(), and KDGantt::DateTimeGrid::paintUserDefinedHeader().

{
    return d->alignment;
}

QDateTime DateTimeScaleFormatter::currentRangeBegin

(

const QDateTime &

datetime

)

const [virtual]

Returns:

the QDateTime being the begin of the range containing datetime

See also:

nextRangeBegin

Definition at line 242 of file kdganttdatetimegrid.cpp.

References d, Day, Hour, Minute, Month, Second, Week, and Year.

Referenced by KDGantt::DateTimeGrid::paintUserDefinedHeader().

{
    QDateTime result = datetime;
    switch( d->range )
    {
    case Second:
        break; // nothing
    case Minute:
        // set it to the begin of the current minute
        result.setTime( QTime( result.time().hour(), result.time().minute() ) );
        break;
    case Hour:
        // set it to the begin of the current hour
        result.setTime( QTime( result.time().hour(), 0 ) );
        break;
    case Day:
        // set it to midnight the current day
        result.setTime( QTime( 0, 0 ) );
        break;
    case Week:
        // set it to midnight
        result.setTime( QTime( 0, 0 ) );
        // iterate day-wise, as long weekNumber is the same
        {
            const int weekNumber = result.date().weekNumber();
            while( weekNumber == result.date().addDays( -1 ).weekNumber() )
                result = result.addDays( -1 );
        }
        break;
    case Month:
        // set it to midnight
        result.setTime( QTime( 0, 0 ) );
        // set it to the first of the current month
        result.setDate( QDate( result.date().year(), result.date().month(), 1 ) );
        break;
    case Year:
        // set it to midnight
        result.setTime( QTime( 0, 0 ) );
        // set it to the first of the current year
        result.setDate( QDate( result.date().year(), 1, 1 ) );
        break;
    }
    return result;
}

QString DateTimeScaleFormatter::format

(

const QDateTime &

datetime

)

const

Returns:

The datetime as string respecting the format.

Definition at line 155 of file kdganttdatetimegrid.cpp.

References d.

{
    QString result = d->format;
    // additional feature: Weeknumber
    const QString shortWeekNumber = QString::number( datetime.date().weekNumber() );
    const QString longWeekNumber = ( shortWeekNumber.length() == 1 ? QString::fromLatin1( "0" ) : QString() ) + shortWeekNumber;
    result.replace( QString::fromLatin1( "ww" ), longWeekNumber );
    result.replace( QString::fromLatin1( "w" ), shortWeekNumber );
    result = datetime.toLocalTime().toString( result );
    return result;
}

QString DateTimeScaleFormatter::format

(

)

const

Returns:

The format being used for formatting dates and times.

Definition at line 148 of file kdganttdatetimegrid.cpp.

References d.

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

{
    return d->format;
}

QDateTime DateTimeScaleFormatter::nextRangeBegin

(

const QDateTime &

datetime

)

const [virtual]

Returns:

the QDateTime being the begin of the range after the one containing datetime

See also:

currentRangeBegin

Definition at line 187 of file kdganttdatetimegrid.cpp.

References d, Day, Hour, Minute, Month, Second, Week, and Year.

Referenced by KDGantt::DateTimeGrid::paintUserDefinedHeader().

{
    QDateTime result = datetime;
    switch( d->range )
    {
    case Second:
        result = result.addSecs( 60 );
        break;
    case Minute:
        // set it to the begin of the next minute
        result.setTime( QTime( result.time().hour(), result.time().minute() ) );
        result = result.addSecs( 60 );
        break;
    case Hour:
        // set it to the begin of the next hour
        result.setTime( QTime( result.time().hour(), 0 ) );
        result = result.addSecs( 60 * 60 );
        break;
    case Day:
        // set it to midnight the next day
        result.setTime( QTime( 0, 0 ) );
        result = result.addDays( 1 );
        break;
    case Week:
        // set it to midnight
        result.setTime( QTime( 0, 0 ) );
        // iterate day-wise, until weekNumber changes
        {
            const int weekNumber = result.date().weekNumber();
            while( weekNumber == result.date().weekNumber() )
                result = result.addDays( 1 );
        }
        break;
    case Month:
        // set it to midnight
        result.setTime( QTime( 0, 0 ) );
        // set it to the first of the next month
        result.setDate( QDate( result.date().year(), result.date().month(), 1 ).addMonths( 1 ) );
        break;
    case Year:
        // set it to midnight
        result.setTime( QTime( 0, 0 ) );
        // set it to the first of the next year
        result.setDate( QDate( result.date().year(), 1, 1 ).addYears( 1 ) );
        break;
    }
    //result = result.toLocalTime();
    assert(  result != datetime );
    //qDebug() << "DateTimeScaleFormatter::nextRangeBegin("<<datetime<<")="<<d->range<<result;
    return result;
}

DateTimeScaleFormatter & DateTimeScaleFormatter::operator=

(

const DateTimeScaleFormatter &

other

)

Definition at line 139 of file kdganttdatetimegrid.cpp.

References alignment(), format(), StockDiagram::Private::Private(), and range().

{
    delete _d;
    _d = new Private( other.range(), other.format(), other.d->templ, other.alignment() );
    return *this;
}

DateTimeScaleFormatter::Range DateTimeScaleFormatter::range

(

)

const

Returns:

The range of each item on a DateTimeGrid header.

See also:

DateTimeScaleFormatter::Range

Definition at line 174 of file kdganttdatetimegrid.cpp.

References d.

Referenced by operator=().

{
    return d->range;
}

QString DateTimeScaleFormatter::text

(

const QDateTime &

datetime

)

const [virtual]

Definition at line 167 of file kdganttdatetimegrid.cpp.

References d, and format().

Referenced by KDGantt::DateTimeGrid::paintHeader(), and KDGantt::DateTimeGrid::paintUserDefinedHeader().

{
    return d->templ.arg( format( datetime ) );
}

---

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

• kdganttdatetimegrid.h
• kdganttdatetimegrid.cpp

---