TrayWeather.h

/*
 File: TrayWeather.h
 Created on: 13/11/2016
 Author: Felix de las Pozas Alvarez

 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef TRAYWEATHER_H_
#define TRAYWEATHER_H_

// Project
#include <ConfigurationDialog.h>
#include <Utils.h>
#include <WeatherDialog.h>

// Qt
#include <QSystemTrayIcon>
#include <QTimer>

class QNetworkReply;
class QNetworkAccessManager;
class AboutDialog;

/** \class TrayWeather
 * \brief Implements the tray icon and application logic.
 *
 */
class TrayWeather
: public QSystemTrayIcon
{
    Q_OBJECT
  public:
    /** \brief TrayWeather class constructor.
     * \param[in] configuration application configuration values, assumed to be valid.
     * \param[in] parent pointer to the object parent of this one.
     *
     */
    TrayWeather(Configuration &configuration, QObject *parent = nullptr);

    /** \brief TrayWeather class virtual destructor.
     *
     */
    virtual ~TrayWeather();

  private slots:
    /** \brief Handles network replies.
     * \param[in] reply network reply object pointer.
     *
     */
    void replyFinished(QNetworkReply *reply);

    /** \brief Exits the application.
     *
     */
    void exitApplication();

    /** \brief Shows the "About" dialog.
     *
     */
    void showAboutDialog();

    /** \brief Shows the weather forecast.
     *
     */
    void showForecast();

    /** \brief Shows the configuration dialog.
     *
     */
    void showConfiguration();

    /** \brief Handles icon activation.
     * \param[in] reason activation reason.
     *
     */
    void onActivation(QSystemTrayIcon::ActivationReason reason);

    /** \brief Makes a network request for weather forecast data or geolocation.
     *
     */
    void requestData();

  private:
    /** \brief Updates the tray icon tooltip.
     *
     */
    void updateTooltip();

    /** \brief Helper method to connect all the signals and slots.
     *
     */
    void connectSignals();

    /** \brief Helper method to disconnect all the signals and slots.
     *
     */
    void disconnectSignals();

    /** \brief Creates the tray icon menu.
     *
     */
    void createMenuEntries();

    /** \brief Returns true if the data is valid.
     *
     */
    bool validData() const;

    /** \brief Invalidates all weather data.
     *
     */
    void invalidateData();

    /** \brief Request geolocation information, can ask for DNS IP first if enabled on configuration.
     *
     */
    void requestGeolocation();

    /** \brief Request weather data from network.
     *
     */
    void requestForecastData();

    Configuration                         &m_configuration; /** application configuration.                        */
    std::shared_ptr<QNetworkAccessManager> m_netManager;    /** network manager.                                  */
    Forecast                               m_data;          /** list of forecast data.                            */
    ForecastData                           m_current;       /** weather conditions now.                           */
    QTimer                                 m_timer;         /** timer for updates and retries.                    */
    WeatherDialog                         *m_weatherDialog; /** dialog to show weather and forecast data.         */
    AboutDialog                           *m_aboutDialog;   /** pointer to current (if any) about dialog.         */
    ConfigurationDialog                   *m_configDialog;  /** pointer to current (if any) configuration dialog. */
    QString                                m_DNSIP;         /** DNS IP used for geolocation.                      */
};


#endif // TRAYWEATHER_H_