KDE PIM / Developers / API Docs / libkdepim

KDateEdit Class Reference

A date editing widget that consists of an editable combo box. More...

#include <kdateedit.h>

Inherits QComboBox.

List of all members.

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions


Detailed Description

A date editing widget that consists of an editable combo box.

The combo box contains the date in text form, and clicking the combo box arrow will display a 'popup' style date picker.

This widget also supports advanced features like allowing the user to type in the day name to get the date. The following keywords are supported (in the native language): tomorrow, yesturday, today, monday, tuesday, wednesday, thursday, friday, saturday, sunday.

Author:
Cornelius Schumacher <schumacher@kde.org>

Mike Pilone <mpilone@slac.com>

David Jarvie <software@astrojar.org.uk>

Tobias Koenig <tokoe@kde.org>


Member Function Documentation

QDate KDateEdit::date  )  const
 

Returns:
The date entered. This date could be invalid, you have to check validity yourself.

void KDateEdit::setReadOnly bool  readOnly  ) 
 

Sets whether the widget is read-only for the user.

If read-only, the date picker pop-up is inactive, and the displayed date cannot be edited.

Parameters:
readOnly True to set the widget read-only, false to set it read-write.

bool KDateEdit::isReadOnly  )  const
 

Returns:
True if the widget is read-only, false if read-write.

void KDateEdit::dateChanged const QDate &  date  )  [signal]
 

This signal is emitted whenever the user modifies the date.

The passed date can be invalid.

void KDateEdit::setDate const QDate &  date  )  [slot]
 

Sets the date.

Parameters:
date The new date to display. This date must be valid or it will not be set

bool KDateEdit::assignDate const QDate &  date  )  [protected, virtual]
 

Sets the date, without altering the display.

This method is used internally to set the widget's date value. As a virtual method, it allows derived classes to perform additional validation on the date value before it is set. Derived classes should return true if QDate::isValid(date) returns false.

Parameters:
date The new date to set.
Returns:
True if the date was set, false if it was considered invalid and remains unchanged.

void KDateEdit::setupKeywords  )  [protected]
 

Fills the keyword map.

Reimplement it if you want additional keywords.


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