KDateTimeEdit
#include <KDateTimeEdit>
Public Types | |
enum | Option { ShowCalendar = 0x00001 , ShowDate = 0x00002 , ShowTime = 0x00004 , ShowTimeZone = 0x00008 , EditDate = 0x00020 , EditTime = 0x00040 , SelectCalendar = 0x00100 , SelectDate = 0x00200 , SelectTime = 0x00400 , SelectTimeZone = 0x00800 , DatePicker = 0x01000 , DateKeywords = 0x02000 , ForceTime = 0x04000 , WarnOnInvalid = 0x08000 } |
typedef QFlags< Option > | Options |
Public Types inherited from QWidget | |
enum | RenderFlag |
Public Types inherited from QPaintDevice | |
enum | PaintDeviceMetric |
Signals | |
void | calendarChanged (const QLocale &calendarLocale) |
void | calendarEntered (const QLocale &calendarLocale) |
void | dateChanged (const QDate &date) |
void | dateEdited (const QDate &date) |
void | dateEntered (const QDate &date) |
void | dateTimeChanged (const QDateTime &dateTime) |
void | dateTimeEdited (const QDateTime &dateTime) |
void | dateTimeEntered (const QDateTime &dateTime) |
void | timeChanged (const QTime &time) |
void | timeEdited (const QTime &time) |
void | timeEntered (const QTime &time) |
void | timeZoneChanged (const QTimeZone &zone) |
void | timeZoneEntered (const QTimeZone &zone) |
Detailed Description
A widget for editing date and time.
Definition at line 22 of file kdatetimeedit.h.
Member Typedef Documentation
◆ Options
typedef QFlags< Option > KDateTimeEdit::Options |
Stores a combination of Option values.
Definition at line 59 of file kdatetimeedit.h.
Member Enumeration Documentation
◆ Option
Options provided by the widget.
- See also
- options
- setOptions
- Options
Definition at line 38 of file kdatetimeedit.h.
Property Documentation
◆ date
|
readwrite |
Definition at line 26 of file kdatetimeedit.h.
◆ options
|
readwrite |
Definition at line 29 of file kdatetimeedit.h.
◆ time
|
readwrite |
Definition at line 27 of file kdatetimeedit.h.
◆ timeListInterval
|
readwrite |
Definition at line 28 of file kdatetimeedit.h.
Constructor & Destructor Documentation
◆ KDateTimeEdit()
Create a new KDateTimeEdit widget.
Definition at line 231 of file kdatetimeedit.cpp.
◆ ~KDateTimeEdit()
|
overridedefault |
Destroy the widget.
Member Function Documentation
◆ assignDate()
Assign the date for the widget.
Virtual to allow sub-classes to apply extra validation rules, but reimplementations must call the parent method at the end.
- Parameters
-
date the new date
Definition at line 349 of file kdatetimeedit.cpp.
◆ assignDateTime()
Assign the date, time and time zone for the widget.
Virtual to allow sub-classes to apply extra validation rules, but reimplementations must call the parent method at the end.
- Parameters
-
dateTime the new date and time
Definition at line 333 of file kdatetimeedit.cpp.
◆ assignTime()
Assign the time for the widget.
Virtual to allow sub-classes to apply extra validation rules, but reimplementations must call the parent method at the end.
- Parameters
-
time the new time
Definition at line 364 of file kdatetimeedit.cpp.
◆ assignTimeZone()
Assign the time zone for the widget.
Virtual to allow sub-classes to apply extra validation rules, but reimplementations must call the parent method at the end.
- Parameters
-
zone the new time zone
Definition at line 381 of file kdatetimeedit.cpp.
◆ calendarChanged
Signal if the Calendar Locale has been changed either manually by the user or programmatically.
- Parameters
-
calendarLocale the new calendar locale
◆ calendarEntered
Signal if the Calendar Locale has been manually entered by the user.
- Parameters
-
calendarLocale the new calendar locale
◆ calendarLocalesList()
Returns the list of Calendar Locales displayed.
- Returns
- the list of calendar locales displayed
Definition at line 440 of file kdatetimeedit.cpp.
◆ date()
QDate KDateTimeEdit::date | ( | ) | const |
Return the currently selected date.
- Returns
- the currently selected date
Definition at line 263 of file kdatetimeedit.cpp.
◆ dateChanged
Signal if the date has been changed either manually by the user or programmatically.
The returned date may be invalid.
- Parameters
-
date the new date
◆ dateDisplayFormat()
QLocale::FormatType KDateTimeEdit::dateDisplayFormat | ( | ) | const |
Return the currently set date display format.
By default this is the Short Format
- Returns
- the currently set date format
Definition at line 450 of file kdatetimeedit.cpp.
◆ dateEdited
Signal if the date is being manually edited by the user.
The returned date may be invalid.
- Parameters
-
date the new date
◆ dateEntered
Signal if the date has been manually entered by the user.
The returned date may be invalid.
- Parameters
-
date the new date
◆ dateMap()
Return the map of dates listed in the drop-down and their displayed string forms.
- Returns
- the select date map
- See also
- setDateMap()
Definition at line 460 of file kdatetimeedit.cpp.
◆ dateTime()
QDateTime KDateTimeEdit::dateTime | ( | ) | const |
Return the currently selected date, time and time zone.
- Returns
- the currently selected date, time and time zone
Definition at line 258 of file kdatetimeedit.cpp.
◆ dateTimeChanged
Signal if the date or time has been changed either manually by the user or programmatically.
The returned date and time may be invalid.
- Parameters
-
dateTime the new date, time and time zone
◆ dateTimeEdited
Signal if the date or time is being manually edited by the user.
The returned date and time may be invalid.
- Parameters
-
dateTime the new date, time and time zone
◆ dateTimeEntered
Signal if the date or time has been manually entered by the user.
The returned date and time may be invalid.
- Parameters
-
dateTime the new date, time and time zone
◆ eventFilter()
Reimplemented from QObject.
Definition at line 508 of file kdatetimeedit.cpp.
◆ focusInEvent()
|
overrideprotectedvirtual |
Reimplemented from QWidget.
Definition at line 513 of file kdatetimeedit.cpp.
◆ focusOutEvent()
|
overrideprotectedvirtual |
Reimplemented from QWidget.
Definition at line 518 of file kdatetimeedit.cpp.
◆ isNull()
bool KDateTimeEdit::isNull | ( | ) | const |
Return if the current user input is null.
- Returns
- if the current user input is null
- See also
- isValid()
Definition at line 285 of file kdatetimeedit.cpp.
◆ isNullDate()
bool KDateTimeEdit::isNullDate | ( | ) | const |
Return if the current user input date is null.
- Returns
- if the current user input date is null
- See also
- isValidDate()
Definition at line 295 of file kdatetimeedit.cpp.
◆ isNullTime()
bool KDateTimeEdit::isNullTime | ( | ) | const |
Return if the current user input time is null.
- Returns
- if the current user input time is null
- See also
- isValidTime()
Definition at line 305 of file kdatetimeedit.cpp.
◆ isValid()
bool KDateTimeEdit::isValid | ( | ) | const |
Return if the current user input is valid.
If the user input is null then it is not valid
- Returns
- if the current user input is valid
- See also
- isNull()
Definition at line 278 of file kdatetimeedit.cpp.
◆ isValidDate()
bool KDateTimeEdit::isValidDate | ( | ) | const |
Return if the current user input date is valid.
If the user input date is null then it is not valid
- Returns
- if the current user input date is valid
- See also
- isNullDate()
Definition at line 290 of file kdatetimeedit.cpp.
◆ isValidTime()
bool KDateTimeEdit::isValidTime | ( | ) | const |
Return if the current user input time is valid.
If the user input time is null then it is not valid
- Returns
- if the current user input time is valid
- See also
- isNullTime()
Definition at line 300 of file kdatetimeedit.cpp.
◆ maximumDateTime()
QDateTime KDateTimeEdit::maximumDateTime | ( | ) | const |
Return the current maximum date and time.
- Returns
- the current maximum date and time
Definition at line 407 of file kdatetimeedit.cpp.
◆ minimumDateTime()
QDateTime KDateTimeEdit::minimumDateTime | ( | ) | const |
Return the current minimum date and time.
- Returns
- the current minimum date and time
Definition at line 392 of file kdatetimeedit.cpp.
◆ options()
KDateTimeEdit::Options KDateTimeEdit::options | ( | ) | const |
Return the currently set widget options.
- Returns
- the currently set widget options
Definition at line 318 of file kdatetimeedit.cpp.
◆ resetDateTimeRange
|
slot |
Reset the minimum and maximum date and time to the default.
Definition at line 427 of file kdatetimeedit.cpp.
◆ resetMaximumDateTime
|
slot |
Reset the minimum date and time to the default.
Definition at line 412 of file kdatetimeedit.cpp.
◆ resetMinimumDateTime
|
slot |
Reset the minimum date and time to the default.
Definition at line 397 of file kdatetimeedit.cpp.
◆ resizeEvent()
|
overrideprotectedvirtual |
Reimplemented from QWidget.
Definition at line 524 of file kdatetimeedit.cpp.
◆ setCalendarLocalesList
Set the list of Calendar Locales to display.
- Parameters
-
calendarLocales the list of calendar locales to display
Definition at line 432 of file kdatetimeedit.cpp.
◆ setDate
Set the currently selected date.
- Parameters
-
date the new date
Definition at line 340 of file kdatetimeedit.cpp.
◆ setDateDisplayFormat
|
slot |
Sets the date format to display.
By default is the Short Format.
- Parameters
-
format the date format to use
Definition at line 445 of file kdatetimeedit.cpp.
◆ setDateMap
Set the list of dates able to be selected from the drop-down and the string form to display for those dates, e.g.
"2010-01-01" and "Yesterday".
Any invalid or duplicate dates will be used, the list will NOT be sorted, and the minimum and maximum date will not be affected.
The dateMap
is keyed by the date to be listed and the value is the string to be displayed. If you want the date to be displayed in the default date format then the string should be null. If you want a separator to be displayed then set the string to "separator".
- Parameters
-
dateMap the map of dates able to be selected
- See also
- dateMap()
Definition at line 455 of file kdatetimeedit.cpp.
◆ setDateTime
Set the currently selected date, time and time zone.
- Parameters
-
dateTime the new date, time and time zone
Definition at line 323 of file kdatetimeedit.cpp.
◆ setDateTimeRange
|
slot |
Set the minimum and maximum date and time range.
To enable range checking provide two valid dates. To disable range checking provide two invalid dates, or call clearDateRange;
- Parameters
-
minDateTime the minimum date and time maxDateTime the maximum date and time minWarnMsg the minimum warning message maxWarnMsg the maximum warning message
Definition at line 417 of file kdatetimeedit.cpp.
◆ setMaximumDateTime
|
slot |
Set the maximum allowed date.
If the date is invalid, or less than current minimum, then the maximum will not be set.
- Parameters
-
maxDateTime the maximum date maxWarnMsg the maximum warning message
- See also
- setMinimumDateTime()
- setDateRange()
Definition at line 402 of file kdatetimeedit.cpp.
◆ setMinimumDateTime
|
slot |
Set the minimum allowed date.
If the date is invalid, or more than current maximum, then the minimum will not be set.
- Parameters
-
minDateTime the minimum date minWarnMsg the minimum warning message
- See also
- setMaximumDateTime()
- setDateRange()
Definition at line 387 of file kdatetimeedit.cpp.
◆ setOptions
Set the new widget options.
- Parameters
-
options the new widget options
Definition at line 310 of file kdatetimeedit.cpp.
◆ setTime
Set the currently selected time.
- Parameters
-
time the new time
Definition at line 355 of file kdatetimeedit.cpp.
◆ setTimeDisplayFormat
|
slot |
Sets the time format to display.
By default is the Short Format.
- Parameters
-
format the time format to use
Definition at line 465 of file kdatetimeedit.cpp.
◆ setTimeList
|
slot |
Set the list of times able to be selected from the drop-down.
Setting the time list will override any time interval previously set via setTimeListInterval().
Any invalid or duplicate times will be ignored, and the list will be sorted.
The minimum and maximum time will automatically be set to the earliest and latest value in the list.
- Parameters
-
timeList the list of times able to be selected minWarnMsg the minimum warning message maxWarnMsg the maximum warning message
- See also
- timeList()
Definition at line 485 of file kdatetimeedit.cpp.
◆ setTimeListInterval
|
slot |
Set the interval between times able to be selected from the drop-down.
The combo drop-down will be populated with times every minutes
apart, starting from the minimumTime() and ending at maximumTime().
If the ForceInterval option is set then any time manually typed into the combo line edit will be forced to the nearest interval.
This interval must be an exact divisor of the valid time range hours. For example with the default 24 hour range interval
must divide 1440 minutes exactly, meaning 1, 6 and 90 are valid but 7, 31 and 91 are not.
Setting the time list interval will override any time list previously set via setTimeList().
- Parameters
-
minutes the time list interval to display
- See also
- timeListInterval()
Definition at line 475 of file kdatetimeedit.cpp.
◆ setTimeZone
Set the current time zone.
- Parameters
-
zone the new zone
Definition at line 370 of file kdatetimeedit.cpp.
◆ setTimeZones
Set the time zones able to be selected.
- Parameters
-
zones the time zones to display
Definition at line 495 of file kdatetimeedit.cpp.
◆ time()
QTime KDateTimeEdit::time | ( | ) | const |
Return the currently selected time.
- Returns
- the currently selected time
Definition at line 268 of file kdatetimeedit.cpp.
◆ timeChanged
Signal if the time has been changed either manually by the user or programmatically.
The returned time may be invalid.
- Parameters
-
time the new time
◆ timeDisplayFormat()
QLocale::FormatType KDateTimeEdit::timeDisplayFormat | ( | ) | const |
Return the currently set time format.
By default this is the Short Format
- Returns
- the currently set time format
Definition at line 470 of file kdatetimeedit.cpp.
◆ timeEdited
Signal if the time is being manually edited by the user.
The returned time may be invalid.
- Parameters
-
time the new time
◆ timeEntered
Signal if the time has been manually entered by the user.
The returned time may be invalid.
- Parameters
-
time the new time
◆ timeList()
Return the list of times able to be selected in the drop-down.
- Returns
- the select time list
- See also
- setTimeList()
- timeListInterval()
- setTimeListInterval()
Definition at line 490 of file kdatetimeedit.cpp.
◆ timeListInterval()
int KDateTimeEdit::timeListInterval | ( | ) | const |
Return the time list interval able to be selected.
- Returns
- the select time intervals in minutes
Definition at line 480 of file kdatetimeedit.cpp.
◆ timeZone()
QTimeZone KDateTimeEdit::timeZone | ( | ) | const |
Return the currently selected time zone.
- Returns
- the currently selected time zone
Definition at line 273 of file kdatetimeedit.cpp.
◆ timeZoneChanged
Signal if the time zone has been changed either manually by the user or programmatically.
- Parameters
-
zone the new time zone
◆ timeZoneEntered
Signal if the time zone has been changed manually by the user.
- Parameters
-
zone the new time zone
◆ timeZones()
Return the list of time zones able to be selected.
- Returns
- the list of time zones displayed
Definition at line 503 of file kdatetimeedit.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:14:43 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.