MainWindow.h

/*
 * Copyright (C) 2020 Adrian Carpenter
 *
 * This file is part of a regex101.com offline application.
 *
 * https://github.com/fizzyade/regex101
 *
 * =====================================================================
 * The regex101 web content is owned and used with permission from
 * Firas Dib at regex101.com.  This application is an unofficial
 * tool to provide an offline application version of the website.
 * =====================================================================
 *
 * 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 MAINWINDOW_H
#define MAINWINDOW_H

#include <QMainWindow>

namespace Ui {
    class MainWindow;
}

namespace Nedrysoft {
    class RegExSplashScreen;
    class RegExWebEnginePage;
    class SettingsDialog;

    /**
     * @brief               The MainWindow class
     *
     * @details             Provides the main window for the application.
     */
    class MainWindow :
            public QMainWindow
    {
        private:
            Q_OBJECT

        public:
            /**
             * @brief           Constructs the main window.
             *
             * @param[in]       splashScreen is a pointer to the splashscreen that was created
             *                  by the main thread at startup.
             */
            MainWindow(Nedrysoft::RegExSplashScreen *splashScreen);

            /**
             * @brief           Destroys the main window.
             */
            ~MainWindow();

            /**
             * @brief           Handles opening links via URL.
             *
             * @param[in]       url is the requested url.
             */
            void handleOpenByUrl(const QUrl &url);

            /**
             * @brief           Returns the last instance of the class
             *
             * @returns         a pointer to the MainWindow instance.
             */
            static MainWindow *getInstance();

        protected:

            /**
             * @brief           Event handler for window close event
             *
             * @param[in]       closeEvent contains the information about the event including accpt/regect functions
             */
            virtual void closeEvent(QCloseEvent *closeEvent) override;

        private:
            /**
             * @brief           Event filter mathod
             *
             * @details         This event filter is using qApp as a target, this allows us to receive events from the
             *                  operating system such as opening registered file types or handling the regex101:// URL
             *                  scheme.
             *
             * @param[in]       obj is the object that has caused this event
             * @param[in]       event contains the details of the event, such as file name or the url path.
             *
             * @returns         true if the event is handled; otherwise false.
             */
            Q_SLOT bool eventFilter(QObject *obj, QEvent *event) override;

            /**
             * @brief           About slot function.
             *
             * @details         This slot is called when the About action is triggered, the about dialog is displayed.
             */
            Q_SLOT void on_actionAbout_triggered();

            /**
             * @brief           Exit slot function.
             *
             * @details         This slot is called when the Exit action is triggered, the application is closed.
             */
            Q_SLOT void on_actionExit_triggered();

            /**
             * @brief           Preferences action triggered function
             *
             * @details         This slot is called when the preferences action is triggered
             */
            Q_SLOT void on_actionPreferences_triggered();

    private:
            Ui::MainWindow *ui;                                     //! ui class for the main window
            Nedrysoft::RegExWebEnginePage *m_page;                  //! web page object set up for our scheme
            SettingsDialog *m_settingsDialog;                       //! the settings dialog
            static MainWindow *m_instance;                          //! instance of the main window
    };
}

#endif // MAINWINDOW_H