kalarm/lib
DateTime Class Reference
#include <datetime.h>
Detailed Description
A QDateTime with date-only option.The DateTime class holds a date, with or without a time.
DateTime is very similar to the QDateTime class, with the additional option to hold a date-only value. This allows a single date-time representation to be used for both an event having a specific date and time, and an all-day event.
The time assumed for date-only values is the start-of-day time set by setStartOfDay().
- Author:
- David Jarvie <software@astrojar.org.uk>
Definition at line 39 of file datetime.h.
Public Member Functions | |
| DateTime () | |
| DateTime (const QDate &d) | |
| DateTime (const QDate &d, const QTime &t) | |
| DateTime (const QDateTime &dt, bool dateOnly=false) | |
| DateTime & | operator= (const DateTime &dt) |
| DateTime & | operator= (const QDateTime &dt) |
| DateTime & | operator= (const QDate &d) |
| bool | isNull () const |
| bool | isValid () const |
| bool | isDateOnly () const |
| void | setDateOnly (bool d) |
| QDate | date () const |
| QTime | time () const |
| QDateTime | dateTime () const |
| void | set (const QDateTime &dt, bool dateOnly=false) |
| void | set (const QDate &d, const QTime &t) |
| void | setTime (const QTime &t) |
| void | setTime_t (uint secs) |
| DateTime | addSecs (int n) const |
| DateTime | addMins (int n) const |
| DateTime | addDays (int n) const |
| DateTime | addMonths (int n) const |
| DateTime | addYears (int n) const |
| int | daysTo (const DateTime &dt) const |
| int | minsTo (const DateTime &dt) const |
| int | secsTo (const DateTime &dt) const |
| QString | toString (Qt::DateFormat f=Qt::TextDate) const |
| QString | toString (const QString &format) const |
| QString | formatLocale (bool shortFormat=true) const |
Static Public Member Functions | |
| static void | setStartOfDay (const QTime &sod) |
| static QTime | startOfDay () |
Friends | |
| bool | operator== (const DateTime &dt1, const DateTime &dt2) |
| bool | operator< (const DateTime &dt1, const DateTime &dt2) |
Constructor & Destructor Documentation
| DateTime::DateTime | ( | ) | [inline] |
| DateTime::DateTime | ( | const QDate & | d | ) | [inline] |
| DateTime::DateTime | ( | const QDate & | d, | |
| const QTime & | t | |||
| ) | [inline] |
| DateTime::DateTime | ( | const QDateTime & | dt, | |
| bool | dateOnly = false | |||
| ) | [inline] |
Constructor for a date-time or date-only value.
- Parameters:
-
dt the date and time to use. dateOnly True to construct a date-only value; false to construct a date-time value.
Definition at line 55 of file datetime.h.
Member Function Documentation
| DateTime DateTime::addDays | ( | int | n | ) | const [inline] |
Returns a DateTime value n days later than the value of this object.
Definition at line 144 of file datetime.h.
| DateTime DateTime::addMins | ( | int | n | ) | const [inline] |
Returns a DateTime value mins minutes later than the value of this object.
If this object is date-only, mins is first rounded down to a whole number of days before adding the value.
Definition at line 136 of file datetime.h.
| DateTime DateTime::addMonths | ( | int | n | ) | const [inline] |
Returns a DateTime value n months later than the value of this object.
Definition at line 146 of file datetime.h.
| DateTime DateTime::addSecs | ( | int | n | ) | const [inline] |
Returns a DateTime value secs seconds later than the value of this object.
If this object is date-only, secs is first rounded down to a whole number of days before adding the value.
Definition at line 125 of file datetime.h.
| DateTime DateTime::addYears | ( | int | n | ) | const [inline] |
Returns a DateTime value n years later than the value of this object.
Definition at line 148 of file datetime.h.
| QDate DateTime::date | ( | ) | const [inline] |
| QDateTime DateTime::dateTime | ( | ) | const |
Returns the date and time of the value.
If the value is date-only, the time part returned is equal to the start-of-day time set by setStartOfDay().
Definition at line 34 of file datetime.cpp.
| int DateTime::daysTo | ( | const DateTime & | dt | ) | const [inline] |
Returns the number of days from this date or date-time to dt.
Definition at line 150 of file datetime.h.
| QString DateTime::formatLocale | ( | bool | shortFormat = true |
) | const |
Returns the value as a string, formatted according to the user's locale.
If it is a date-time, both time and date are included in the output. If it is date-only, only the date is included in the output.
Definition at line 39 of file datetime.cpp.
| bool DateTime::isDateOnly | ( | ) | const [inline] |
| bool DateTime::isNull | ( | ) | const [inline] |
Returns true if the date is null and, if it is a date-time value, the time is also null.
Definition at line 74 of file datetime.h.
| bool DateTime::isValid | ( | ) | const [inline] |
Returns true if the date is valid and, if it is a date-time value, the time is also valid.
Definition at line 76 of file datetime.h.
| int DateTime::minsTo | ( | const DateTime & | dt | ) | const [inline] |
Returns the number of minutes from this date or date-time to dt.
If either of the values is date-only, the result is calculated by simply taking the difference in dates and ignoring the times.
Definition at line 156 of file datetime.h.
| DateTime& DateTime::operator= | ( | const QDate & | d | ) | [inline] |
Assignment operator.
Sets the value to a specified date-only value.
Definition at line 71 of file datetime.h.
| DateTime& DateTime::operator= | ( | const QDateTime & | dt | ) | [inline] |
Assignment operator.
Sets the value to a specified date-time.
Definition at line 66 of file datetime.h.
Assignment operator.
Sets the value to a specified date-time or date-only value.
Definition at line 61 of file datetime.h.
| int DateTime::secsTo | ( | const DateTime & | dt | ) | const [inline] |
Returns the number of seconds from this date or date-time to dt.
If either of the values is date-only, the result is calculated by simply taking the difference in dates and ignoring the times.
Definition at line 162 of file datetime.h.
| void DateTime::set | ( | const QDate & | d, | |
| const QTime & | t | |||
| ) | [inline] |
| void DateTime::set | ( | const QDateTime & | dt, | |
| bool | dateOnly = false | |||
| ) | [inline] |
Sets a date-time or date-only value.
- Parameters:
-
dt the date-time to use. dateOnly True to set a date-only value; false to set a date-time value.
Definition at line 101 of file datetime.h.
| void DateTime::setDateOnly | ( | bool | d | ) | [inline] |
Sets the value to be either date-only or date-time.
- Parameters:
-
d True to set the value to be date-only; false to set it to a date-time value.
Definition at line 82 of file datetime.h.
| static void DateTime::setStartOfDay | ( | const QTime & | sod | ) | [inline, static] |
Sets the start-of-day time.
The default value is midnight (0000 hrs).
Definition at line 198 of file datetime.h.
| void DateTime::setTime | ( | const QTime & | t | ) | [inline] |
Sets the time component of the value.
The value is converted if necessary to be a date-time value.
Definition at line 115 of file datetime.h.
| void DateTime::setTime_t | ( | uint | secs | ) | [inline] |
Sets the value to a specified date-time value.
- Parameters:
-
secs The time_t date-time value, expressed as the number of seconds elapsed since 1970-01-01 00:00:00 UTC.
Definition at line 120 of file datetime.h.
| static QTime DateTime::startOfDay | ( | ) | [inline, static] |
| QTime DateTime::time | ( | ) | const |
Returns the time part of the value.
If the value is date-only, the time returned is the start-of-day time set by setStartOfDay().
Definition at line 29 of file datetime.cpp.
| QString DateTime::toString | ( | const QString & | format | ) | const [inline] |
Returns the value as a string.
If it is a date-time, both time and date are included in the output. If it is date-only, only the date is included in the output.
Definition at line 181 of file datetime.h.
| QString DateTime::toString | ( | Qt::DateFormat | f = Qt::TextDate |
) | const [inline] |
Returns the value as a string.
If it is a date-time, both time and date are included in the output. If it is date-only, only the date is included in the output.
Definition at line 168 of file datetime.h.
Friends And Related Function Documentation
Returns true if the dt1 is earlier than dt2.
If the two values have the same date, and one value is date-only while the other is a date-time, the time used for the date-only value is the start-of-day time set in the KAlarm Preferences dialogue.
Definition at line 68 of file datetime.cpp.
The documentation for this class was generated from the following files:
