gz/gui/Dialog.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_DIALOG_HH_
#define GZ_GUI_DIALOG_HH_
 
#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 DialogPrivate;
 
    class GZ_GUI_VISIBLE Dialog : public QObject
    {
      Q_OBJECT
 
      public: Dialog();
 
      public: virtual ~Dialog();
 
      public: QQuickWindow *QuickWindow() const;
 
      public: QQuickItem *RootItem() const;
 
      public: void SetDefaultConfig(const std::string &_config);
 
      public: bool UpdateConfigAttribute(
        const std::string &_path, const std::string &_attribute,
        const bool _value) const;
 
      public: std::string ReadConfigAttribute(const std::string &_path,
        const std::string &_attribute) const;
 
      private: std::unique_ptr<DialogPrivate> dataPtr;
    };
}  // namespace gz::gui
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif  // GZ_GUI_DIALOG_HH_