Gazebo Gui

API Reference

8.3.0
Dialog.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef GZ_GUI_DIALOG_HH_
19 #define GZ_GUI_DIALOG_HH_
20 
21 #include <memory>
22 #include <string>
23 
24 #include "gz/gui/qt.h"
25 #include "gz/gui/Export.hh"
26 
27 #ifdef _WIN32
28 // Disable warning C4251 which is triggered by
29 // std::unique_ptr
30 #pragma warning(push)
31 #pragma warning(disable: 4251)
32 #endif
33 
34 namespace gz::gui
35 {
36  class DialogPrivate;
37 
39  class GZ_GUI_VISIBLE Dialog : public QObject
40  {
41  Q_OBJECT
42 
44  public: Dialog();
45 
47  public: virtual ~Dialog();
48 
51  public: QQuickWindow *QuickWindow() const;
52 
55  public: QQuickItem *RootItem() const;
56 
60  public: void SetDefaultConfig(const std::string &_config);
61 
76  public: bool UpdateConfigAttribute(
77  const std::string &_path, const std::string &_attribute,
78  const bool _value) const;
79 
89  const std::string &_attribute) const;
90 
93  private: std::unique_ptr<DialogPrivate> dataPtr;
94  };
95 } // namespace gz::gui
96 
97 #ifdef _MSC_VER
98 #pragma warning(pop)
99 #endif
100 
101 #endif // GZ_GUI_DIALOG_HH_