GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Public Member Functions | List of all members
gd::PropertyDescriptor Class Reference

Used to describe a property shown in a property grid. More...

#include <PropertyDescriptor.h>

Inherited by gd::NamedPropertyDescriptor.

Public Member Functions

 PropertyDescriptor (gd::String propertyValue)
 Create a property being a simple gd::String with the specified value. More...
 
 PropertyDescriptor ()
 Empty constructor creating an empty property to be displayed.
 
virtual ~PropertyDescriptor ()
 Destructor.
 
PropertyDescriptorSetValue (gd::String value)
 Change the value displayed in the property grid.
 
PropertyDescriptorSetType (gd::String type_)
 Change the type of the value displayed in the property grid. More...
 
PropertyDescriptorSetLabel (gd::String label_)
 Change the label displayed in the property grid.
 
PropertyDescriptorSetDescription (gd::String description_)
 Change the description displayed to the user, if any.
 
PropertyDescriptorAddExtraInfo (const gd::String &info)
 Add an information about the property. More...
 
const gd::StringGetValue () const
 
const gd::StringGetType () const
 
const gd::StringGetLabel () const
 
const gd::StringGetDescription () const
 
const std::vector< gd::String > & GetExtraInfo () const
 
PropertyDescriptorSetHidden (bool enable=true)
 Set if the property should be shown or hidden in the editor.
 
bool IsHidden () const
 Check if the property should be shown or hidden in the editor.
 
Serialization
virtual void SerializeTo (SerializerElement &element) const
 Serialize the PropertyDescriptor.
 
virtual void UnserializeFrom (const SerializerElement &element)
 Unserialize the PropertyDescriptor.
 

Detailed Description

Used to describe a property shown in a property grid.

See also
gd::Object
gd::EffectMetadata

Constructor & Destructor Documentation

gd::PropertyDescriptor::PropertyDescriptor ( gd::String  propertyValue)
inline

Create a property being a simple gd::String with the specified value.

Parameters
propertyValueThe value of the property.

Member Function Documentation

PropertyDescriptor& gd::PropertyDescriptor::AddExtraInfo ( const gd::String info)
inline

Add an information about the property.

Note
The information are arbitrary and are interpreted by the class updating the property grid: Refer to it or to the documentation of the class which is returning the PropertyDescriptor to learn more about valid values for the extra information.
PropertyDescriptor& gd::PropertyDescriptor::SetType ( gd::String  type_)
inline

Change the type of the value displayed in the property grid.

Note
The type is arbitrary and is interpreted by the class updating the property grid: Refer to it or to the documentation of the class which is returning the PropertyDescriptor to learn more about valid values for the type.

The documentation for this class was generated from the following files: