From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qdateedit.html | 296 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 296 insertions(+) create mode 100644 doc/html/qdateedit.html (limited to 'doc/html/qdateedit.html') diff --git a/doc/html/qdateedit.html b/doc/html/qdateedit.html new file mode 100644 index 0000000..625d55e --- /dev/null +++ b/doc/html/qdateedit.html @@ -0,0 +1,296 @@ + + + + + +QDateEdit Class + + + + + + + +

QDateEdit Class Reference

+ +

The QDateEdit class provides a date editor. +More... +

#include <qdatetimeedit.h> +

Inherits QDateTimeEditBase. +

List of all member functions. +

Public Members

QDateEdit ( QWidget * parent = 0, const char * name = 0 )
QDateEdit ( const QDate & date, QWidget * parent = 0, const char * name = 0 )
~QDateEdit ()
enum Order { DMY, MDY, YMD, YDM }
QDate date () const
virtual void setOrder ( Order order )
Order order () const
virtual void setAutoAdvance ( bool advance )
bool autoAdvance () const
virtual void setMinValue ( const QDate & d )
QDate minValue () const
virtual void setMaxValue ( const QDate & d )
QDate maxValue () const
virtual void setRange ( const QDate & min, const QDate & max )
QString separator () const
virtual void setSeparator ( const QString & s )

Public Slots

virtual void setDate ( const QDate & date )

Signals

void valueChanged ( const QDate & date )

Properties

bool autoAdvance - whether the editor automatically advances to the next section
QDate date - the editor's date value
QDate maxValue - the editor's maximum value
QDate minValue - the editor's minimum value
Order order - the order in which the year, month and day appear

Protected Members

virtual QString sectionFormattedText ( int sec )
virtual void setYear ( int year )
virtual void setMonth ( int month )
virtual void setDay ( int day )
virtual void fix ()

Protected Slots

void updateButtons ()

Detailed Description

+ + +The QDateEdit class provides a date editor. +

+ + +

QDateEdit allows the user to edit dates by using the keyboard or +the arrow keys to increase/decrease date values. The arrow keys +can be used to move from section to section within the QDateEdit +box. Dates appear in accordance with the local date/time settings +or in year, month, day order if the system doesn't provide this +information. It is recommended that the QDateEdit be initialised +with a date, e.g. +

+    QDateEdit *dateEdit = new QDateEdit( QDate::currentDate(), this );
+    dateEdit->setRange( QDate::currentDate().addDays( -365 ),
+                        QDate::currentDate().addDays(  365 ) );
+    dateEdit->setOrder( QDateEdit::MDY );
+    dateEdit->setAutoAdvance( TRUE );
+

+ +

Here we've created a new QDateEdit object initialised with today's +date and restricted the valid date range to today plus or minus +365 days. We've set the order to month, day, year. If the auto +advance property is TRUE (as we've set it here) when the user +completes a section of the date, e.g. enters two digits for the +month, they are automatically taken to the next section. +

The maximum and minimum values for a date value in the date editor +default to the maximum and minimum values for a QDate. You can +change this by calling setMinValue(), setMaxValue() or setRange(). +

Terminology: A QDateEdit widget comprises three 'sections', one +each for the year, month and day. You can change the separator +character using QDateTimeEditor::setSeparator(), by default the +separator will be taken from the systems settings. If that is +not possible, it defaults to "-". +

See also QDate, QTimeEdit, QDateTimeEdit, Advanced Widgets, and Time and Date. + +

Member Type Documentation

QDateEdit::Order

+ +

This enum defines the order in which the sections that comprise a +date appear. +

QDateEdit::MDY - month-day-year +
QDateEdit::DMY - day-month-year +
QDateEdit::YMD - year-month-day (the default) +
QDateEdit::YDM - year-day-month (included for completeness; but should +not be used) +

Member Function Documentation

QDateEdit::QDateEdit ( QWidget * parent = 0, const char * name = 0 ) +

+Constructs an empty date editor which is a child of parent and +called name name. + +

QDateEdit::QDateEdit ( const QDate & date, QWidget * parent = 0, const char * name = 0 ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Constructs a date editor with the initial value date, parent parent and called name. +

The date editor is initialized with date. + +

QDateEdit::~QDateEdit () +

+Destroys the object and frees any allocated resources. + +

bool QDateEdit::autoAdvance () const +

Returns TRUE if the editor automatically advances to the next section; otherwise returns FALSE. +See the "autoAdvance" property for details. +

QDate QDateEdit::date () const +

Returns the editor's date value. +See the "date" property for details. +

void QDateEdit::fix () `[virtual protected]` +

+Attempts to fix any invalid date entries. +

The rules applied are as follows: +

If the year has four digits it is left unchanged. +
If the year has two digits, the year will be changed to four +digits in the range current year - 70 to current year + 29. +
If the year has three digits in the range 100..999, the +current millennium, i.e. 2000, will be added giving a year +in the range 2100..2999. +
If the day or month is 0 then it will be set to 1 or the +minimum valid day\month in the range. +

QDate QDateEdit::maxValue () const +

Returns the editor's maximum value. +See the "maxValue" property for details. +

QDate QDateEdit::minValue () const +

Returns the editor's minimum value. +See the "minValue" property for details. +

Order QDateEdit::order () const +

Returns the order in which the year, month and day appear. +See the "order" property for details. +

QString QDateEdit::sectionFormattedText ( int sec ) `[virtual protected]` +

+Returns the formatted number for section sec. This will +correspond to either the year, month or day section, depending on +the current display order. +

QString QDateEdit::separator () const +

+Returns the editor's separator. + +

void QDateEdit::setAutoAdvance ( bool advance ) `[virtual]` +

Sets whether the editor automatically advances to the next section to advance. +See the "autoAdvance" property for details. +

void QDateEdit::setDate ( const QDate & date ) `[virtual slot]` +

Sets the editor's date value to date. +See the "date" property for details. +

void QDateEdit::setDay ( int day ) `[virtual protected]` +

+Sets the day to day, which must be a valid day. The function +will ensure that the day set is valid for the month and year. + +

void QDateEdit::setMaxValue ( const QDate & d ) `[virtual]` +

Sets the editor's maximum value to d. +See the "maxValue" property for details. +

void QDateEdit::setMinValue ( const QDate & d ) `[virtual]` +

Sets the editor's minimum value to d. +See the "minValue" property for details. +

void QDateEdit::setMonth ( int month ) `[virtual protected]` +

+Sets the month to month, which must be a valid month, i.e. +between 1 and 12. + +

void QDateEdit::setOrder ( Order order ) `[virtual]` +

Sets the order in which the year, month and day appear to order. +See the "order" property for details. +

void QDateEdit::setRange ( const QDate & min, const QDate & max ) `[virtual]` +

+Sets the valid input range for the editor to be from min to max inclusive. If min is invalid no minimum date will be set. +Similarly, if max is invalid no maximum date will be set. + +

void QDateEdit::setSeparator ( const QString & s ) `[virtual]` +

+Sets the separator to s. Note that currently only the first +character of s is used. + +

void QDateEdit::setYear ( int year ) `[virtual protected]` +

+Sets the year to year, which must be a valid year. The range +currently supported is from 1752 to 8000. +

void QDateEdit::updateButtons () `[protected slot]` +

+Enables/disables the push buttons according to the min/max date +for this widget. + +

void QDateEdit::valueChanged ( const QDate & date ) `[signal]` +

+ +

This signal is emitted whenever the editor's value changes. The date parameter is the new value. + +

Property Documentation

bool autoAdvance

This property holds whether the editor automatically advances to the next section. +

If autoAdvance is TRUE, the editor will automatically advance +focus to the next date section if a user has completed a section. +The default is FALSE. + +

Set this property's value with setAutoAdvance() and get this property's value with autoAdvance(). +

QDate date

This property holds the editor's date value. +

If the date property is not valid, the editor displays all zeroes +and QDateEdit::date() will return an invalid date. It is strongly +recommended that the editor is given a default date value (e.g. +currentDate()). That way, attempts to set the date property to an +invalid date will fail. +

When changing the date property, if the date is less than +minValue(), or is greater than maxValue(), nothing happens. + +

Set this property's value with setDate() and get this property's value with date(). +

QDate maxValue

This property holds the editor's maximum value. +

Setting the maximum date value for the editor is equivalent to +calling QDateEdit::setRange( minValue(), d ), where d is the +maximum date. The default maximum date is 8000-12-31. +

QDate minValue

This property holds the editor's minimum value. +

Setting the minimum date value is equivalent to calling +QDateEdit::setRange( d, maxValue() ), where d is the minimum +date. The default minimum date is 1752-09-14. +

Order order

This property holds the order in which the year, month and day appear. +

The default order is locale dependent. +