gz/gui/Plugin.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_PLUGIN_HH_
#define GZ_GUI_PLUGIN_HH_
 
#include <tinyxml2.h>
#include <memory>
#include <string>
 
#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
{
    class PluginPrivate;
 
    class GZ_GUI_VISIBLE Plugin : public QObject
    {
      Q_OBJECT
 
      public: Plugin();
 
      public: virtual ~Plugin();
 
      public: void Load(const tinyxml2::XMLElement *_pluginElem);
 
      public: virtual std::string ConfigStr();
 
      public: QQuickItem *CardItem() const;
 
      public: QQuickItem *PluginItem() const;
 
      public: QQmlContext *Context() const;
 
      public: void PostParentChanges();
 
      protected: virtual void LoadConfig(
          const tinyxml2::XMLElement *_pluginElem)
          {
            (void)_pluginElem;
          }
 
      public: virtual std::string Title() const {return this->title;}
 
      public: bool DeleteLaterRequested() const;
 
      protected: void DeleteLater();
 
      protected: std::string title = "";
 
      protected: std::string configStr;
 
      private: virtual void LoadCommonConfig(
          const tinyxml2::XMLElement *_gzGuiElem);
 
      private: void ApplyAnchors();
 
      private: std::unique_ptr<PluginPrivate> dataPtr;
    };
}  // namespace gz::gui
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif  // GZ_GUI_PLUGIN_HH_