gz/gui/MainWindow.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_GUI_MAINWINDOW_HH_
#define GZ_GUI_MAINWINDOW_HH_
 
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
 
#include <gz/common/Console.hh>
 
#include "gz/gui/qt.h"
#include "gz/gui/Export.hh"
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
 
namespace gz::gui
{
    Q_NAMESPACE
    class MainWindowPrivate;
    struct WindowConfig;
 
    enum class ExitAction
    {
      CLOSE_GUI,
      SHUTDOWN_SERVER,
    };
    Q_ENUM_NS(ExitAction)
 
    class GZ_GUI_VISIBLE MainWindow : public QObject
    {
      Q_OBJECT
 
      Q_PROPERTY(
        int pluginCount
        READ PluginCount
        WRITE SetPluginCount
        NOTIFY PluginCountChanged
      )
 
      
      Q_PROPERTY(
        QString materialTheme
        READ MaterialTheme
        WRITE SetMaterialTheme
        NOTIFY MaterialThemeChanged
      )
 
      Q_PROPERTY(
        QString materialPrimary
        READ MaterialPrimary
        WRITE SetMaterialPrimary
        NOTIFY MaterialPrimaryChanged
      )
 
      Q_PROPERTY(
        QString materialAccent
        READ MaterialAccent
        WRITE SetMaterialAccent
        NOTIFY MaterialAccentChanged
      )
 
      Q_PROPERTY(
        QString toolBarColorLight
        READ ToolBarColorLight
        WRITE SetToolBarColorLight
        NOTIFY ToolBarColorLightChanged
      )
 
      Q_PROPERTY(
        QString toolBarTextColorLight
        READ ToolBarTextColorLight
        WRITE SetToolBarTextColorLight
        NOTIFY ToolBarTextColorLightChanged
      )
 
      Q_PROPERTY(
        QString toolBarColorDark
        READ ToolBarColorDark
        WRITE SetToolBarColorDark
        NOTIFY ToolBarColorDarkChanged
      )
 
      Q_PROPERTY(
        QString toolBarTextColorDark
        READ ToolBarTextColorDark
        WRITE SetToolBarTextColorDark
        NOTIFY ToolBarTextColorDarkChanged
      )
 
      Q_PROPERTY(
        QString pluginToolBarColorLight
        READ PluginToolBarColorLight
        WRITE SetPluginToolBarColorLight
        NOTIFY PluginToolBarColorLightChanged
      )
 
      Q_PROPERTY(
        QString pluginToolBarTextColorLight
        READ PluginToolBarTextColorLight
        WRITE SetPluginToolBarTextColorLight
        NOTIFY PluginToolBarTextColorLightChanged
      )
 
      Q_PROPERTY(
        QString pluginToolBarColorDark
        READ PluginToolBarColorDark
        WRITE SetPluginToolBarColorDark
        NOTIFY PluginToolBarColorDarkChanged
      )
 
      Q_PROPERTY(
        QString pluginToolBarTextColorDark
        READ PluginToolBarTextColorDark
        WRITE SetPluginToolBarTextColorDark
        NOTIFY PluginToolBarTextColorDarkChanged
      )
 
      Q_PROPERTY(
        bool showDrawer
        READ ShowDrawer
        WRITE SetShowDrawer
        NOTIFY ShowDrawerChanged
      )
 
      Q_PROPERTY(
        bool showDefaultDrawerOpts
        READ ShowDefaultDrawerOpts
        WRITE SetShowDefaultDrawerOpts
        NOTIFY ShowDefaultDrawerOptsChanged
      )
 
      Q_PROPERTY(
        bool showPluginMenu
        READ ShowPluginMenu
        WRITE SetShowPluginMenu
        NOTIFY ShowPluginMenuChanged
      )
 
      Q_PROPERTY(
        ExitAction defaultExitAction
        READ DefaultExitAction
        WRITE SetDefaultExitAction
        NOTIFY DefaultExitActionChanged
      )
 
      Q_PROPERTY(
        bool showDialogOnExit
        READ ShowDialogOnExit
        WRITE SetShowDialogOnExit
        NOTIFY ShowDialogOnExitChanged
      )
 
      Q_PROPERTY(
        QString dialogOnExitText
        READ DialogOnExitText
        WRITE SetDialogOnExitText
        NOTIFY DialogOnExitTextChanged
      )
 
      Q_PROPERTY(
        bool exitDialogShowShutdown
        READ ExitDialogShowShutdown
        WRITE SetExitDialogShowShutdown
        NOTIFY ExitDialogShowShutdownChanged
      )
 
      Q_PROPERTY(
        bool exitDialogShowCloseGui
        READ ExitDialogShowCloseGui
        WRITE SetExitDialogShowCloseGui
        NOTIFY ExitDialogShowCloseGuiChanged
      )
 
      Q_PROPERTY(
        QString exitDialogShutdownText
        READ ExitDialogShutdownText
        WRITE SetExitDialogShutdownText
        NOTIFY ExitDialogShutdownTextChanged
      )
 
      Q_PROPERTY(
        QString exitDialogCloseGuiText
        READ ExitDialogCloseGuiText
        WRITE SetExitDialogCloseGuiText
        NOTIFY ExitDialogCloseGuiTextChanged
      )
 
      public: MainWindow();
 
      public: virtual ~MainWindow();
 
      public: QQuickWindow *QuickWindow() const;
 
      public: void SaveConfig(const std::string &_path);
 
      public: bool ApplyConfig(const WindowConfig &_config);
 
      public: WindowConfig CurrentWindowConfig() const;
 
      public: void SetRenderEngine(const std::string &_renderEngine);
 
      public slots: void OnAddPlugin(QString _plugin);
 
      public: Q_INVOKABLE QStringList PluginListModel() const;
 
      public: Q_INVOKABLE int PluginCount() const;
 
      public: Q_INVOKABLE void SetPluginCount(const int _pluginCount);
 
      public: Q_INVOKABLE QString MaterialTheme() const;
 
      public: Q_INVOKABLE void SetMaterialTheme(
          const QString &_materialTheme);
 
      public: Q_INVOKABLE QString MaterialPrimary() const;
 
      public: Q_INVOKABLE void SetMaterialPrimary(
          const QString &_materialPrimary);
 
      public: Q_INVOKABLE QString MaterialAccent() const;
 
      public: Q_INVOKABLE void SetMaterialAccent(
          const QString &_materialAccent);
 
      public: Q_INVOKABLE QString ToolBarColorLight() const;
 
      public: Q_INVOKABLE void SetToolBarColorLight(
          const QString &_toolBarColorLight);
 
      public: Q_INVOKABLE QString ToolBarTextColorLight() const;
 
      public: Q_INVOKABLE void SetToolBarTextColorLight(
          const QString &_toolBarTextColorLight);
 
      public: Q_INVOKABLE QString ToolBarColorDark() const;
 
      public: Q_INVOKABLE void SetToolBarColorDark(
          const QString &_toolBarColorDark);
 
      public: Q_INVOKABLE QString ToolBarTextColorDark() const;
 
      public: Q_INVOKABLE void SetToolBarTextColorDark(
          const QString &_toolBarTextColorDark);
 
      public: Q_INVOKABLE QString PluginToolBarColorLight() const;
 
      public: Q_INVOKABLE void SetPluginToolBarColorLight(
          const QString &_pluginPluginToolBarColorLight);
 
      public: Q_INVOKABLE QString PluginToolBarTextColorLight() const;
 
      public: Q_INVOKABLE void SetPluginToolBarTextColorLight(
          const QString &_pluginPluginToolBarTextColorLight);
 
      public: Q_INVOKABLE QString PluginToolBarColorDark() const;
 
      public: Q_INVOKABLE void SetPluginToolBarColorDark(
          const QString &_pluginPluginToolBarColorDark);
 
      public: Q_INVOKABLE QString PluginToolBarTextColorDark() const;
 
      public: Q_INVOKABLE void SetPluginToolBarTextColorDark(
          const QString &_pluginPluginToolBarTextColorDark);
 
      public: Q_INVOKABLE bool ShowDrawer() const;
 
      public: Q_INVOKABLE void SetShowDrawer(const bool _showDrawer);
 
      public: Q_INVOKABLE bool ShowDefaultDrawerOpts() const;
 
      public: Q_INVOKABLE void SetShowDefaultDrawerOpts(
          const bool _showDefaultDrawerOpts);
 
      public: Q_INVOKABLE bool ShowPluginMenu() const;
 
      public: Q_INVOKABLE void SetShowPluginMenu(const bool _showPluginMenu);
 
      public: Q_INVOKABLE ExitAction DefaultExitAction() const;
 
      public: Q_INVOKABLE void SetDefaultExitAction(
        enum ExitAction _defaultExitAction);
 
      public: Q_INVOKABLE bool ShowDialogOnExit() const;
 
      public: Q_INVOKABLE void SetShowDialogOnExit(bool _showDialogOnExit);
 
      public: Q_INVOKABLE QString DialogOnExitText() const;
 
      public: Q_INVOKABLE void SetDialogOnExitText(
        const QString &_dialogOnExitText);
 
      public: Q_INVOKABLE bool ExitDialogShowShutdown() const;
 
      public: Q_INVOKABLE void SetExitDialogShowShutdown(
        bool _exitDialogShowShutdown);
 
      public: Q_INVOKABLE bool ExitDialogShowCloseGui() const;
 
      public: Q_INVOKABLE void SetExitDialogShowCloseGui(
        bool _exitDialogShowCloseGui);
 
      public: Q_INVOKABLE QString ExitDialogShutdownText() const;
 
      public: Q_INVOKABLE void SetExitDialogShutdownText(
        const QString &_exitDialogShutdownText);
 
      public: Q_INVOKABLE QString ExitDialogCloseGuiText() const;
 
      public: Q_INVOKABLE void SetExitDialogCloseGuiText(
        const QString &_exitDialogCloseGuiText);
 
      public: Q_INVOKABLE std::string ServerControlService() const;
 
      public: Q_INVOKABLE void SetServerControlService(
        const std::string &_service);
 
      public slots: void OnLoadConfig(const QString &_path);
 
      public slots: void OnSaveConfig();
 
      public slots: void OnSaveConfigAs(const QString &_path);
 
      public slots: void OnStopServer();
 
      signals: void PluginCountChanged();
 
      signals: void MaterialThemeChanged();
 
      signals: void MaterialPrimaryChanged();
 
      signals: void MaterialAccentChanged();
 
      signals: void ToolBarColorLightChanged();
 
      signals: void ToolBarTextColorLightChanged();
 
      signals: void ToolBarColorDarkChanged();
 
      signals: void ToolBarTextColorDarkChanged();
 
      signals: void PluginToolBarColorLightChanged();
 
      signals: void PluginToolBarTextColorLightChanged();
 
      signals: void PluginToolBarColorDarkChanged();
 
      signals: void PluginToolBarTextColorDarkChanged();
 
      signals: void ShowDrawerChanged();
 
      signals: void ShowDefaultDrawerOptsChanged();
 
      signals: void ShowPluginMenuChanged();
 
      signals: void DefaultExitActionChanged();
 
      signals: void ShowDialogOnExitChanged();
 
      signals: void DialogOnExitTextChanged();
 
      signals: void ExitDialogShowShutdownChanged();
 
      signals: void ExitDialogShowCloseGuiChanged();
 
      signals: void ExitDialogShutdownTextChanged();
 
      signals: void ExitDialogCloseGuiTextChanged();
 
      signals: void configChanged();
 
      signals: void notify(const QString &_message);
 
      signals: void notifyWithDuration(const QString &_message, int _duration);
 
      private: std::unique_ptr<MainWindowPrivate> dataPtr;
    };
 
    struct GZ_GUI_VISIBLE WindowConfig
    {
      bool MergeFromXML(const std::string &_xml);
 
      std::string XMLString() const;
 
      bool IsIgnoring(const std::string &_prop) const;
 
      int posX{-1};
 
      int posY{-1};
 
      int width{-1};
 
      int height{-1};
 
      QByteArray state;
 
      std::string materialTheme{""};
 
      std::string materialPrimary{""};
 
      std::string materialAccent{""};
 
      std::string toolBarColorLight{""};
 
      std::string toolBarTextColorLight{""};
 
      std::string toolBarColorDark{""};
 
      std::string toolBarTextColorDark{""};
 
      std::string pluginToolBarColorLight{""};
 
      std::string pluginToolBarTextColorLight{""};
 
      std::string pluginToolBarColorDark{""};
 
      std::string pluginToolBarTextColorDark{""};
 
      bool showDrawer{true};
 
      bool showDefaultDrawerOpts{true};
 
      bool showPluginMenu{true};
 
      bool pluginsFromPaths{true};
 
      std::vector<std::string> showPlugins;
 
      std::set<std::string> ignoredProps;
 
      std::string plugins{""};
    };
}  // namespace gz::gui
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif  // GZ_GUI_MAINWINDOW_HH_