Application.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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 IGNITION_GUI_APPLICATION_HH_
#define IGNITION_GUI_APPLICATION_HH_

#include <memory>
#include <string>
#include <utility>
#include <vector>

#include "ignition/gui/qt.h"
#include "ignition/gui/Export.hh"

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif

namespace tinyxml2
{
  class XMLElement;
}

namespace ignition
{
  namespace gui
  {
    class ApplicationPrivate;
    class Dialog;
    class MainWindow;
    class Plugin;

    enum class WindowType : int
    {
      kMainWindow = 0,

      kDialog = 1
    };

    class IGNITION_GUI_VISIBLE Application : public QApplication
    {
      Q_OBJECT

      public: Application(int &_argc, char **_argv,
          const WindowType _type = WindowType::kMainWindow);

      public: virtual ~Application();

      public: QQmlApplicationEngine *Engine() const;

      public: bool LoadPlugin(const std::string &_filename,
          const tinyxml2::XMLElement *_pluginElem = nullptr);

      public: bool LoadConfig(const std::string &_config);

      public: bool LoadDefaultConfig();

      public: void SetDefaultConfigPath(const std::string &_path);

      public: std::string DefaultConfigPath();

      public: void SetPluginPathEnv(const std::string &_env);

      public: void AddPluginPath(const std::string &_path);

      public: std::vector<std::pair<std::string, std::vector<std::string>>>
          PluginList();

      public: bool RemovePlugin(const std::string &_pluginName);

      public: std::shared_ptr<Plugin> PluginByName(
          const std::string &_pluginName) const;

      signals: void PluginAdded(const QString &_objectName);

      public slots: void OnPluginClose();

      private: bool InitializeMainWindow();

      private: bool InitializeDialogs();

      private: void RemovePlugin(std::shared_ptr<Plugin> _plugin);

      private: bool AddPluginsToWindow();

      private: bool ApplyConfig();

      private: std::unique_ptr<ApplicationPrivate> dataPtr;
    };

    IGNITION_GUI_VISIBLE
    Application *App();
  }
}

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#endif