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::NamedPropertyDescriptor Class Reference

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

#include <NamedPropertyDescriptor.h>

Inherits gd::PropertyDescriptor.

Public Member Functions

 NamedPropertyDescriptor ()
 Empty constructor creating an empty property to be displayed.
 
virtual NamedPropertyDescriptorClone () const
 
NamedPropertyDescriptorSetName (gd::String newName)
 Change the name of the property. More...
 
const gd::StringGetName () const
 Get the name of the property.
 
PropertyDescriptor ToPropertyDescriptor ()
 
Serialization
void SerializeTo (SerializerElement &element) const
 Serialize the NamedPropertyDescriptor.
 
void UnserializeFrom (const SerializerElement &element)
 Unserialize the NamedPropertyDescriptor.
 
- Public Member Functions inherited from gd::PropertyDescriptor
 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.
 

Detailed Description

Used to describe a property shown in a property grid.

See also
gd::Object

Member Function Documentation

NamedPropertyDescriptor& gd::NamedPropertyDescriptor::SetName ( gd::String  newName)
inline

Change the name of the property.

Note
If the property is used in a list/vector, it's better to use any rename method provided by it (as it can ensure uniqueness).
PropertyDescriptor gd::NamedPropertyDescriptor::ToPropertyDescriptor ( )
inline

Return a PropertyDescriptor from this NamedPropertyDescriptor, slicing the name.


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