GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
PropertyDescriptor.h
1 /*
2  * GDevelop Core
3  * Copyright 2008-present Florian Rival ([email protected]). All rights
4  * reserved. This project is released under the MIT License.
5  */
6 #ifndef GDCORE_PROPERTYDESCRIPTOR
7 #define GDCORE_PROPERTYDESCRIPTOR
8 #include <vector>
9 
10 #include "GDCore/Project/MeasurementUnit.h"
11 #include "GDCore/Project/QuickCustomization.h"
12 #include "GDCore/String.h"
13 
14 namespace gd {
15 class SerializerElement;
16 }
17 
18 namespace gd {
19 
20 class GD_CORE_API PropertyDescriptorChoice {
21  public:
22  PropertyDescriptorChoice(const gd::String& value, const gd::String& label)
23  : value(value), label(label) {}
24 
25  const gd::String& GetValue() const { return value; }
26  const gd::String& GetLabel() const { return label; }
27 
28  private:
29  gd::String value;
30  gd::String label;
31 };
32 
38 class GD_CORE_API PropertyDescriptor {
39  public:
47  : currentValue(propertyValue),
48  type("string"),
49  label(""),
50  hidden(false),
51  deprecated(false),
52  advanced(false),
53  hasImpactOnOtherProperties(false),
54  measurementUnit(gd::MeasurementUnit::GetUndefined()),
55  quickCustomizationVisibility(QuickCustomization::Visibility::Default) {}
56 
61  : hidden(false),
62  deprecated(false),
63  advanced(false),
64  hasImpactOnOtherProperties(false),
65  measurementUnit(gd::MeasurementUnit::GetUndefined()),
66  quickCustomizationVisibility(QuickCustomization::Visibility::Default) {
67  };
68 
72  virtual ~PropertyDescriptor();
73 
78  currentValue = value;
79  return *this;
80  }
81 
90  type = type_;
91  return *this;
92  }
93 
98  label = label_;
99  return *this;
100  }
101 
106  description = description_;
107  return *this;
108  }
109 
115  group = group_;
116  return *this;
117  }
118 
119  PropertyDescriptor& AddChoice(const gd::String& value,
120  const gd::String& label) {
121  choices.push_back(PropertyDescriptorChoice(value, label));
122  return *this;
123  }
124 
128  PropertyDescriptor& SetExtraInfo(const std::vector<gd::String>& info) {
129  extraInformation = info;
130  return *this;
131  }
132 
141  extraInformation.push_back(info);
142  return *this;
143  }
144 
149  const gd::MeasurementUnit& measurementUnit_) {
150  measurementUnit = measurementUnit_;
151  return *this;
152  }
153 
154  const gd::String& GetValue() const { return currentValue; }
155  const gd::String& GetType() const { return type; }
156  const gd::String& GetLabel() const { return label; }
157  const gd::String& GetDescription() const { return description; }
158  const gd::String& GetGroup() const { return group; }
159  const gd::MeasurementUnit& GetMeasurementUnit() const {
160  return measurementUnit;
161  }
162 
163  const std::vector<gd::String>& GetExtraInfo() const {
164  return extraInformation;
165  }
166 
167  std::vector<gd::String>& GetExtraInfo() { return extraInformation; }
168 
169  const std::vector<PropertyDescriptorChoice>& GetChoices() const {
170  return choices;
171  }
172 
176  PropertyDescriptor& SetHidden(bool enable = true) {
177  hidden = enable;
178  return *this;
179  }
180 
184  bool IsHidden() const { return hidden; }
185 
189  PropertyDescriptor& SetDeprecated(bool enable = true) {
190  deprecated = enable;
191  return *this;
192  }
193 
197  bool IsDeprecated() const { return deprecated; }
198 
202  PropertyDescriptor& SetAdvanced(bool enable = true) {
203  advanced = enable;
204  return *this;
205  }
206 
210  bool IsAdvanced() const { return advanced; }
211 
216  bool HasImpactOnOtherProperties() const { return hasImpactOnOtherProperties; }
217 
223  hasImpactOnOtherProperties = enable;
224  return *this;
225  }
226 
227  QuickCustomization::Visibility GetQuickCustomizationVisibility() const {
228  return quickCustomizationVisibility;
229  }
230 
231  PropertyDescriptor& SetQuickCustomizationVisibility(
232  QuickCustomization::Visibility visibility) {
233  quickCustomizationVisibility = visibility;
234  return *this;
235  }
236 
240 
243  virtual void SerializeTo(SerializerElement& element) const;
244 
248  virtual void UnserializeFrom(const SerializerElement& element);
249 
253  virtual void SerializeValuesTo(SerializerElement& element) const;
254 
258  virtual void UnserializeValuesFrom(const SerializerElement& element);
260 
261  private:
262  gd::String currentValue;
263  gd::String
264  type;
266  gd::String label; //< The user-friendly property name
267  gd::String description; //< The user-friendly property description
268  gd::String group; //< The user-friendly property group
269  std::vector<PropertyDescriptorChoice>
270  choices; //< The optional choices for the property.
271  std::vector<gd::String>
272  extraInformation;
274  bool hidden;
275  bool deprecated;
276  bool advanced;
277  bool hasImpactOnOtherProperties;
279  measurementUnit; //< The unit of measurement of the property vale.
280  QuickCustomization::Visibility quickCustomizationVisibility;
281 };
282 
283 } // namespace gd
284 
285 #endif
A unit of measurement.
Definition: MeasurementUnit.h:24
Definition: PropertyDescriptor.h:20
Used to describe a property shown in a property grid.
Definition: PropertyDescriptor.h:38
PropertyDescriptor & SetValue(gd::String value)
Change the value displayed in the property grid.
Definition: PropertyDescriptor.h:77
bool IsHidden() const
Check if the property should be shown or hidden in the editor.
Definition: PropertyDescriptor.h:184
PropertyDescriptor & SetHasImpactOnOtherProperties(bool enable)
Set if the property has impact on other properties - which means a change must re-render other proper...
Definition: PropertyDescriptor.h:222
bool IsDeprecated() const
Check if the property is deprecated.
Definition: PropertyDescriptor.h:197
PropertyDescriptor & SetHidden(bool enable=true)
Set if the property should be shown or hidden in the editor.
Definition: PropertyDescriptor.h:176
PropertyDescriptor & SetExtraInfo(const std::vector< gd::String > &info)
Set and replace the additional information for the property.
Definition: PropertyDescriptor.h:128
PropertyDescriptor & SetGroup(gd::String group_)
Change the group where this property is displayed to the user, if any.
Definition: PropertyDescriptor.h:114
PropertyDescriptor & SetDeprecated(bool enable=true)
Set if the property is deprecated.
Definition: PropertyDescriptor.h:189
bool HasImpactOnOtherProperties() const
Check if the property has impact on other properties - which means a change must re-render other prop...
Definition: PropertyDescriptor.h:216
bool IsAdvanced() const
Check if the property is marked as advanced.
Definition: PropertyDescriptor.h:210
PropertyDescriptor()
Empty constructor creating an empty property to be displayed.
Definition: PropertyDescriptor.h:60
PropertyDescriptor & SetMeasurementUnit(const gd::MeasurementUnit &measurementUnit_)
Change the unit of measurement of the property value.
Definition: PropertyDescriptor.h:148
PropertyDescriptor & SetAdvanced(bool enable=true)
Set if the property is marked as advanced.
Definition: PropertyDescriptor.h:202
PropertyDescriptor(gd::String propertyValue)
Create a property being a simple gd::String with the specified value.
Definition: PropertyDescriptor.h:46
PropertyDescriptor & SetType(gd::String type_)
Change the type of the value displayed in the property grid.
Definition: PropertyDescriptor.h:89
PropertyDescriptor & AddExtraInfo(const gd::String &info)
Add an information about the property.
Definition: PropertyDescriptor.h:140
PropertyDescriptor & SetDescription(gd::String description_)
Change the description displayed to the user, if any.
Definition: PropertyDescriptor.h:105
PropertyDescriptor & SetLabel(gd::String label_)
Change the label displayed in the property grid.
Definition: PropertyDescriptor.h:97
Definition: QuickCustomization.h:6
Visibility
Definition: QuickCustomization.h:8
String represents an UTF8 encoded string.
Definition: String.h:33
Definition: CommonTools.h:24