forked from NatronGitHub/Natron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ChoiceOption.h
87 lines (67 loc) · 2.35 KB
/
ChoiceOption.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/* ***** BEGIN LICENSE BLOCK *****
* This file is part of Natron <https://natrongithub.github.io/>,
* (C) 2018-2021 The Natron developers
* (C) 2013-2018 INRIA and Alexandre Gauthier-Foichat
*
* Natron is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Natron is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Natron. If not, see <http://www.gnu.org/licenses/gpl-2.0.html>
* ***** END LICENSE BLOCK ***** */
#ifndef Engine_ChoiceOption_h
#define Engine_ChoiceOption_h
// ***** BEGIN PYTHON BLOCK *****
// from <https://docs.python.org/3/c-api/intro.html#include-files>:
// "Since Python may define some pre-processor definitions which affect the standard headers on some systems, you must include Python.h before any standard headers are included."
#include <Python.h>
// ***** END PYTHON BLOCK *****
#include "Global/Macros.h"
#include <string>
#include "Engine/EngineFwd.h"
NATRON_NAMESPACE_ENTER
struct ChoiceOption
{
// Must necessarily be set, this uniquely identifies the option
std::string id;
// Can be set to something different than the ID. This is what will be displayed in the option in the GUI
// If empty this will be set to the ID.
std::string label;
// Can be set to display a tooltip when the user hovers the entry in the choice menu
std::string tooltip;
ChoiceOption()
: id()
, label()
, tooltip()
{
}
explicit ChoiceOption(const std::string& id_)
: id(id_)
, label()
, tooltip()
{
}
ChoiceOption(const std::string& id_, const std::string& label_, const std::string& tooltip_)
: id(id_)
, label(label_)
, tooltip(tooltip_)
{
}
bool operator==(const ChoiceOption& other) const
{
return id == other.id;
}
bool operator!=(const ChoiceOption& other) const
{
return id != other.id;
}
};
NATRON_NAMESPACE_EXIT
#endif // Engine_ChoiceOption_h