mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-29 00:07:54 -04:00
6c94bf493d
Adds QgsDateEdit and QgsTimeEdit subclasses. (All the heavy lifting with these is done by Qt itself, hence no extra unit tests!)
272 lines
6.7 KiB
Plaintext
272 lines
6.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/editorwidgets/qgsdatetimeedit.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsDateTimeEdit : QDateTimeEdit
|
|
{
|
|
%Docstring
|
|
The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times.
|
|
|
|
.. warning::
|
|
|
|
You should use the signal valueChanged of this subclass
|
|
rather than QDateTimeEdit.dateTimeChanged. (If you consequently connect parent's
|
|
dateTimeChanged signal and call dateTime() afterwards there is no guarantee that
|
|
NULL values will be correctly handled).
|
|
|
|
.. seealso:: :py:class:`QgsDateEdit`
|
|
|
|
.. seealso:: :py:class:`QgsTimeEdit`
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsdatetimeedit.h"
|
|
%End
|
|
public:
|
|
|
|
explicit QgsDateTimeEdit( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsDateTimeEdit.
|
|
The current date and time is used by default.
|
|
The widget is allowing null by default.
|
|
If allow null is disabled, you should check allowNull before getting values from the widget.
|
|
%End
|
|
|
|
void setAllowNull( bool allowNull );
|
|
%Docstring
|
|
Determines if the widget allows setting null date/time.
|
|
|
|
.. seealso:: :py:func:`allowNull`
|
|
%End
|
|
|
|
bool allowNull() const;
|
|
%Docstring
|
|
If the widget allows setting null date/time.
|
|
|
|
.. seealso:: :py:func:`setAllowNull`
|
|
%End
|
|
|
|
void setDateTime( const QDateTime &dateTime );
|
|
%Docstring
|
|
Set the date time in the widget and handles null date times.
|
|
|
|
.. note::
|
|
|
|
Since QDateTimeEdit.setDateTime() is not virtual, setDateTime must be called for QgsDateTimeEdit.
|
|
%End
|
|
|
|
QDateTime dateTime() const;
|
|
%Docstring
|
|
Returns the date time which can be a null date/time.
|
|
|
|
.. note::
|
|
|
|
Before QGIS 3.10, you mustn't call date() or time() because they can't return a NULL value.
|
|
|
|
.. note::
|
|
|
|
Since QDateTimeEdit.dateTime() is not virtual, dateTime must be called for QgsDateTimeEdit.
|
|
%End
|
|
|
|
QTime time() const;
|
|
%Docstring
|
|
Returns the time which can be a null time.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
QDate date() const;
|
|
%Docstring
|
|
Returns the date which can be a null date.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
virtual void clear();
|
|
|
|
%Docstring
|
|
Set the current date as NULL.
|
|
|
|
.. note::
|
|
|
|
If the widget is not configured to accept NULL dates, this will have no effect.
|
|
%End
|
|
|
|
void setEmpty();
|
|
%Docstring
|
|
Resets the widget to show no value (ie, an "unknown" state).
|
|
|
|
.. versionadded:: 2.16
|
|
%End
|
|
|
|
signals:
|
|
|
|
void valueChanged( const QDateTime &date );
|
|
%Docstring
|
|
Signal emitted whenever the value changes.
|
|
|
|
:param date: The new date/time value.
|
|
%End
|
|
|
|
protected:
|
|
virtual void mousePressEvent( QMouseEvent *event );
|
|
|
|
virtual void focusOutEvent( QFocusEvent *event );
|
|
|
|
virtual void focusInEvent( QFocusEvent *event );
|
|
|
|
virtual void wheelEvent( QWheelEvent *event );
|
|
|
|
virtual void showEvent( QShowEvent *event );
|
|
|
|
|
|
QgsDateTimeEdit( const QVariant &var, QVariant::Type parserType, QWidget *parent );
|
|
|
|
|
|
void displayNull( bool updateCalendar = false );
|
|
%Docstring
|
|
write the null value representation to the line edit without changing the value
|
|
|
|
:param updateCalendar: Flag if calendar is open and minimum date needs to be set
|
|
%End
|
|
|
|
virtual void emitValueChanged( const QVariant &value );
|
|
%Docstring
|
|
Emits the widget's correct value changed signal.
|
|
%End
|
|
|
|
bool isNull() const;
|
|
%Docstring
|
|
Returns ``True`` if the widget is currently set to a null value
|
|
%End
|
|
|
|
protected slots:
|
|
void changed( const QVariant &dateTime );
|
|
|
|
};
|
|
|
|
|
|
class QgsTimeEdit : QgsDateTimeEdit
|
|
{
|
|
%Docstring
|
|
The QgsTimeEdit class is a QTimeEdit widget with the capability of setting/reading null date/times.
|
|
|
|
.. warning::
|
|
|
|
You should use the signal valueChanged of this subclass
|
|
rather than QDateTimeEdit.timeChanged. (If you consequently connect parent's
|
|
timeChanged signal and call time() afterwards there is no guarantee that
|
|
NULL values will be correctly handled).
|
|
|
|
.. seealso:: :py:class:`QgsDateTimeEdit`
|
|
|
|
.. seealso:: :py:class:`QgsDateEdit`
|
|
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsdatetimeedit.h"
|
|
%End
|
|
public:
|
|
|
|
explicit QgsTimeEdit( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsTimeEdit.
|
|
The current time is used by default.
|
|
The widget is allowing null by default.
|
|
If allow null is disabled, you should check allowNull before getting values from the widget.
|
|
%End
|
|
|
|
void setTime( const QTime &time );
|
|
%Docstring
|
|
Sets the ``time`` for the widget and handles null times.
|
|
|
|
.. note::
|
|
|
|
Since QDateTimeEdit.setTime() is not virtual, setTime must be called for QgsTimeEdit.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void timeValueChanged( const QTime &time );
|
|
%Docstring
|
|
Signal emitted whenever the time changes.
|
|
%End
|
|
|
|
protected:
|
|
virtual void emitValueChanged( const QVariant &value );
|
|
|
|
|
|
};
|
|
|
|
class QgsDateEdit : QgsDateTimeEdit
|
|
{
|
|
%Docstring
|
|
The QgsDateEdit class is a QDateEdit widget with the capability of setting/reading null dates.
|
|
|
|
.. warning::
|
|
|
|
You should use the signal valueChanged of this subclass
|
|
rather than QDateTimeEdit.dateChanged. (If you consequently connect parent's
|
|
dateChanged signal and call date() afterwards there is no guarantee that
|
|
NULL values will be correctly handled).
|
|
|
|
.. seealso:: :py:class:`QgsDateTimeEdit`
|
|
|
|
.. seealso:: :py:class:`QgsTimeEdit`
|
|
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsdatetimeedit.h"
|
|
%End
|
|
public:
|
|
|
|
explicit QgsDateEdit( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsDateEdit.
|
|
The current time is used by default.
|
|
The widget is allowing null by default.
|
|
If allow null is disabled, you should check allowNull before getting values from the widget.
|
|
%End
|
|
|
|
void setDate( const QDate &date );
|
|
%Docstring
|
|
Sets the ``date`` for the widget and handles null dates.
|
|
|
|
.. note::
|
|
|
|
Since QDateTimeEdit.setDate() is not virtual, setDate must be called for QgsDateEdit.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void dateValueChanged( const QDate &date );
|
|
%Docstring
|
|
Signal emitted whenever the date changes.
|
|
%End
|
|
|
|
protected:
|
|
virtual void emitValueChanged( const QVariant &value );
|
|
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/editorwidgets/qgsdatetimeedit.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|