Clock.h

/***************************************************************************
 *   Copyright (C) 2020-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@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 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QDateTime>
#include <QGeoCoordinate>
#include <QObject>
#include <QQmlEngine>
 
#include "GlobalObject.h"
 
 
namespace Navigation {

 
class Clock : public GlobalObject {
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
 
 
    //
    // Constructors and destructors
    //

    explicit Clock(QObject *parent = nullptr);
 
    // Standard destructor
    ~Clock() override = default;
 
    // No default constructor, important for QML singleton
    explicit Clock() = delete;
 
    // factory function for QML singleton
    static Navigation::Clock *create(QQmlEngine * /*unused*/, QJSEngine * /*unused*/)
    {
        return GlobalObject::clock();
    }
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(QDate date READ date NOTIFY dateChanged)
 
    
    Q_PROPERTY(QString timeAsUTCString READ timeAsUTCString NOTIFY timeChanged)

    Q_PROPERTY(QDateTime time READ time NOTIFY timeChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] static QDate date()
    {
        return QDateTime::currentDateTime().date();
    }

    [[nodiscard]] static QString timeAsUTCString();

    [[nodiscard]] static QDateTime time()
    {
        return QDateTime::currentDateTime();
    }
 
 
    //
    // Getter Methods
    //

    Q_INVOKABLE static QString describeTimeDifference(const QDateTime& pointInTime);

    Q_INVOKABLE static QString describeTimeDifference(const QDateTime& pointInTime, const QDateTime& currentTime);

    Q_INVOKABLE static QString describePointInTime(const QDateTime& pointInTime, const QDateTime& now);

    Q_INVOKABLE static QString describePointInTime(const QDateTime& pointInTime);
 
signals:
    void dateChanged();

    void timeChanged();
 
private:
    // Sets a single shot timer to emit timeChanged just after the full minute
    void setSingleShotTimer();
};
 
} // namespace Navigation