qgsdatetimewithtimezonewidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsdatetimewithtimezonewidget.h
     --------------------------------------
    Date                 : October 2026
    Copyright            : (C) 2026 Nyall Dawson
    Email                : nyall.dawson@gmail.com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSDATETIMEWITHTIMEZONEWIDGET_H
#define QGSDATETIMEWITHTIMEZONEWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsguiutils.h"
#include "qgspanelwidget.h"
 
#include <QAbstractItemModel>
#include <QConcatenateTablesProxyModel>
#include <QDialog>
#include <QPointer>
#include <QSortFilterProxyModel>
#include <QWidget>
 
class QgsFilterLineEdit;
class QListView;
class QComboBox;
class QToolButton;
class StandardTimeZoneModel;
class StandardTimeZoneProxyModel;
class QDialogButtonBox;
class QgsDateTimeEdit;

class GUI_EXPORT QgsTimeZoneItemModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    enum class CustomRole : int
    {
      TimeZoneId = Qt::UserRole, 
      TimeZone,                  
      UtcOffset,                 
    };
    Q_ENUM( CustomRole )
 
    
    QgsTimeZoneItemModel( QObject *parent SIP_TRANSFER = nullptr );
 
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;

    QModelIndex indexFromTimeZone( const QTimeZone &timeZone ) const;

    static QString displayStringForTimeZone( const QTimeZone &timeZone, QTimeZone::NameType nameType = QTimeZone::NameType::DefaultName );
 
  private:
    struct TimeZoneItem
    {
        QString id;
        QString displayString;
        QTimeZone timeZone;
        int utcOffset = 0;
    };
    static std::vector< TimeZoneItem > sItems;
 
    static QString offsetToString( int seconds );
};

class GUI_EXPORT QgsTimeZoneSortFilterModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    QgsTimeZoneSortFilterModel( QgsTimeZoneItemModel *source, QObject *parent SIP_TRANSFER = nullptr );

    QString filterString() const { return mFilterString; }

    QModelIndex indexFromTimeZone( const QTimeZone &timeZone ) const;
 
  public slots:

    void setFilterString( const QString &filter );
 
  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
 
  private:
    QgsTimeZoneItemModel *mSourceModel = nullptr;
    QString mFilterString;
};

class GUI_EXPORT QgsTimeZoneWidget : public QgsPanelWidget
{
    Q_OBJECT
 
  public:
    explicit QgsTimeZoneWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QTimeZone timeZone() const;
 
  public slots:

    void setTimeZone( const QTimeZone &zone );
 
  signals:

    void timeZoneChanged( const QTimeZone &zone );

    void timeZoneDoubleClicked( const QTimeZone &zone );
 
  private slots:
 
    void itemDoubleClicked( const QModelIndex &index );
 
  private:
    QgsTimeZoneItemModel *mModel = nullptr;
    QgsTimeZoneSortFilterModel *mProxyModel = nullptr;
 
    QgsFilterLineEdit *mFilterEdit = nullptr;
    QListView *mListView = nullptr;
};
 

class GUI_EXPORT QgsTimeZoneDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsTimeZoneDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags );

    QTimeZone timeZone() const;
 
  public slots:

    void setTimeZone( const QTimeZone &zone );
 
 
  private:
    QgsTimeZoneWidget *mWidget = nullptr;
    QDialogButtonBox *mButtonBox = nullptr;
};

class GUI_EXPORT QgsTimeZoneComboBox : public QWidget
{
    Q_OBJECT
 
  public:
    enum class StandardItem SIP_ENUM_BASETYPE( IntFlag )
    {
      Invalid = 1 << 0, 
      Current = 1 << 1, 
      System = 1 << 2,  
    };

    Q_DECLARE_FLAGS( StandardItems, StandardItem )
 
    
    explicit QgsTimeZoneComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QTimeZone timeZone() const;

    void setDialogTitle( const QString &title );

    QString dialogTitle() const;
 
  public slots:

    void setTimeZone( const QTimeZone &zone );
 
  signals:

    void timeZoneChanged( const QTimeZone &zone );
 
  private slots:
 
    void selectTimeZone();
 
  private:
    QComboBox *mComboBox = nullptr;
    QToolButton *mButton = nullptr;
    StandardTimeZoneProxyModel *mTimeZoneModel = nullptr;
    int mBlockSignals = 0;
    QPointer< QgsTimeZoneWidget> mActivePanel;
    int mIgnorePanelSignals = 0;
    QString mDialogTitle;
};
 
SIP_SKIP Q_DECLARE_OPERATORS_FOR_FLAGS( QgsTimeZoneComboBox::StandardItems );

 
class StandardTimeZoneModel : public QAbstractItemModel SIP_SKIP
{
    Q_OBJECT
 
  public:
    enum class CustomRole : int
    {
      TimeZone = Qt::UserRole, 
    };
    StandardTimeZoneModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    QVariant data( const QModelIndex &index, int role ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex & = QModelIndex() ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;
 
    QgsTimeZoneComboBox::StandardItem itemForIndex( const QModelIndex &index ) const;
    QModelIndex indexForItem( QgsTimeZoneComboBox::StandardItem item ) const;
    void setCurrentTimeZone( const QTimeZone &timeZone );
 
  private:
    QString mNotSetText;
    QTimeZone mCurrentTimeZone;
};
 
class StandardTimeZoneProxyModel : public QSortFilterProxyModel SIP_SKIP
{
    Q_OBJECT
 
  public:
    StandardTimeZoneProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
    void setDisplayedItems( QgsTimeZoneComboBox::StandardItems items );
    void setCurrentTimeZone( const QTimeZone &timeZone );
    QModelIndex indexForItem( QgsTimeZoneComboBox::StandardItem item ) const;
 
  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
 
  private:
    StandardTimeZoneModel *mModel = nullptr;
    QgsTimeZoneComboBox::StandardItems mItems;
};
 


class GUI_EXPORT QgsDateTimeWithTimeZoneWidget : public QWidget
{
    Q_OBJECT
 
  public:
    explicit QgsDateTimeWithTimeZoneWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QgsDateTimeEdit *dateTimeEdit();

    QgsTimeZoneComboBox *timeZoneComboBox();

    void setDialogTitle( const QString &title );

    QString dialogTitle() const;

    QDateTime dateTime() const;
 
  public slots:

    void setDateTime( const QDateTime &dateTime );
 
  signals:

    void dateTimeChanged( const QDateTime &dateTime );
 
  private:
    QgsDateTimeEdit *mDateTimeEdit = nullptr;
    QgsTimeZoneComboBox *mTimeZoneCombo = nullptr;
    int mBlockSignals = false;
};
 
#endif // QGSDATETIMEWITHTIMEZONEWIDGET_H