/usr/include/cegui-0.8.7/CEGUI/PropertySet.h is in libcegui-mk2-dev 0.8.7-1.3+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 | /***********************************************************************
created: 21/2/2004
author: Paul D Turner
purpose: Defines interface for the PropertySet class
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIPropertySet_h_
#define _CEGUIPropertySet_h_
#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/IteratorBase.h"
#include "CEGUI/Property.h"
#include "CEGUI/PropertyHelper.h"
#include "CEGUI/TypedProperty.h"
// not needed in this header but you are likely to use it if you include this,
// we also define the CEGUI_DEFINE_PROPERTY macro that relies on this here
#include "CEGUI/TplWindowProperty.h"
#include "CEGUI/Exceptions.h"
#include <map>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Interface providing introspection capabilities
CEGUI uses this interface for introspection and serialisation, especially in
CEGUI::Window and classes that inherit it.
If you are just a user of an existing PropertySet class there are just 2 methods
that you should be aware of - PropertySet::setProperty and PropertySet::getProperty.
Both methods are available in 2 variants - string fallback mode and templated
native mode. It is recommended to use the native mode. Code example:
\code{.cpp}
CEGUI::Window* wnd = ...;
// native mode property set
wnd->setProperty<float>("Alpha", 0.5f); // set Alpha to 50%
// string fallback mode
wnd->setProperty("Alpha", "0.5"); // set Alpha to 50%
// native mode property get
const float alpha = wnd->getProperty<float>("Alpha");
// string fallback mode
const String alphaString = wnd->getProperty("Alpha");
\endcode
If you use native mode with the wrong type CEGUI will resort to string fallback
and will try to convert the type to whatever you requested.
\code{.cpp}
CEGUI::Window* wnd = ...;
// will set Alpha to 100% but is slower due to the casts
wnd->setProperty<int>("Alpha", 1);
// retrieves Alpha as string, then proceeds to convert that to int
// beware of rounding errors!
wnd->getProperty<int>("Alpha");
\endcode
We will always offer string fallback mode because it is necessary for serialisation
and scripting. Scripting languages are often duck typed and cannot use C++
templated code.
The CEGUI::Property instances hold pointers to getter and setter of
a given property. They are designed in such a way that multiple PropertySets
(multiple widgets) can share the Property instances to save memory. This means
that PropertySets don't own the Properties themselves. The Property instances
are usually static members of the PropertySet classes or static local
variables in the scope of the constructor or a method called from there.
It's unusual but multiple instances of the same class can have different
Properties added to them.
It is recommended to use the \a CEGUI_DEFINE_PROPERTY macro instead of using
PropertySet::addProperty directly. This takes care of property initialisation
as well as it's addition to the PropertySet instance.
*/
class CEGUIEXPORT PropertySet : public PropertyReceiver
{
public:
/*!
\brief
Constructs a new PropertySet object
*/
PropertySet(void) {}
/*!
\brief
Destructor for PropertySet objects.
*/
virtual ~PropertySet(void) {}
/*!
\brief
Adds a new Property to the PropertySet
\param property
Pointer to the Property object to be added to the PropertySet.
\exception NullObjectException Thrown if \a property is NULL.
\exception AlreadyExistsException Thrown if a Property with the same name as \a property already exists in the PropertySet
\note
You most likely don't want to use this method unless you are implementing
a custom Property class. Please see CEGUI_DEFINE_PROPERTY instead.
*/
void addProperty(Property* property);
/*!
\brief
Removes a Property from the PropertySet.
\param name
String containing the name of the Property to be removed. If Property \a name is not in the set, nothing happens.
*/
void removeProperty(const String& name);
/*!
\brief
Retrieves a property instance (that was previously added)
\param name
String containing the name of the Property to be retrieved. If Property \a name is not in the set, exception is thrown.
\return
Pointer to the property instance
*/
Property* getPropertyInstance(const String& name) const;
/*!
\brief
Removes all Property objects from the PropertySet.
*/
void clearProperties(void);
/*!
\brief
Checks to see if a Property with the given name is in the PropertySet
\param name
String containing the name of the Property to check for.
\return
true if a Property named \a name is in the PropertySet. false if no Property named \a name is in the PropertySet.
*/
bool isPropertyPresent(const String& name) const;
/*!
\brief
Return the help text for the specified Property.
\param name
String holding the name of the Property who's help text is to be returned.
\return
String object containing the help text for the Property \a name.
\exception UnknownObjectException Thrown if no Property named \a name is in the PropertySet.
*/
const String& getPropertyHelp(const String& name) const;
/*!
\brief
Gets the current value of the specified Property.
\param name
String containing the name of the Property who's value is to be returned.
\return
String object containing a textual representation of the requested Property.
\exception UnknownObjectException Thrown if no Property named \a name is in the PropertySet.
*/
String getProperty(const String& name) const;
/*!
\copydoc PropertySet::getProperty
This method tries to do a native type get without string conversion if possible,
if that is not possible, it gracefully falls back to string conversion
*/
template<typename T>
typename PropertyHelper<T>::return_type getProperty(const String& name) const
{
PropertyRegistry::const_iterator pos = d_properties.find(name);
if (pos == d_properties.end())
{
CEGUI_THROW(UnknownObjectException("There is no Property named '" + name + "' available in the set."));
}
Property* baseProperty = pos->second;
TypedProperty<T>* typedProperty = dynamic_cast<TypedProperty<T>* >(baseProperty);
if (typedProperty)
{
// yay, we can get native!
return typedProperty->getNative(this);
}
else
{
// fall back to string get
return PropertyHelper<T>::fromString(baseProperty->get(this));
}
}
/*!
\brief
Sets the current value of a Property.
\param name
String containing the name of the Property who's value is to be set.
\param value
String containing a textual representation of the new value for the Property
\exception UnknownObjectException Thrown if no Property named \a name is in the PropertySet.
\exception InvalidRequestException Thrown when the Property was unable to interpret the content of \a value.
*/
void setProperty(const String& name, const String& value);
/*!
\copydoc PropertySet::setProperty
This method tries to do a native type set without string conversion if possible,
if that is not possible, it gracefully falls back to string conversion
*/
template<typename T>
void setProperty(const String& name, typename PropertyHelper<T>::pass_type value)
{
PropertyRegistry::iterator pos = d_properties.find(name);
if (pos == d_properties.end())
{
CEGUI_THROW(UnknownObjectException("There is no Property named '" + name + "' available in the set."));
}
Property* baseProperty = pos->second;
TypedProperty<T>* typedProperty = dynamic_cast<TypedProperty<T>* >(baseProperty);
if (typedProperty)
{
// yay, we can set native!
typedProperty->setNative(this, value);
}
else
{
// fall back to string set
baseProperty->set(this, PropertyHelper<T>::toString(value));
}
}
/*!
\brief
Returns whether a Property is at it's default value.
\param name
String containing the name of the Property who's default state is to be tested.
\return
- true if the property has it's default value.
- false if the property has been modified from it's default value.
*/
bool isPropertyDefault(const String& name) const;
/*!
\brief
Returns the default value of a Property as a String.
\param name
String containing the name of the Property who's default string is to be returned.
\return
String object containing a textual representation of the default value for this property.
*/
String getPropertyDefault(const String& name) const;
private:
typedef std::map<String, Property*, StringFastLessCompare
CEGUI_MAP_ALLOC(String, Property*)> PropertyRegistry;
PropertyRegistry d_properties;
public:
/*************************************************************************
Iterator stuff
*************************************************************************/
typedef ConstMapIterator<PropertyRegistry> PropertyIterator;
/*!
\brief
Return a PropertySet::PropertyIterator object to iterate over the available
Properties.
*/
PropertyIterator getPropertyIterator(void) const;
};
/*!
\brief
The prefered way to define properties inside class that inherit CEGUI::Window
Example of usage inside addStandardProperties or a similar method:
\code{.cpp}
{
const String propertyOrigin("MyAwesomeClass"); // this is automatically used by the macro
// you can also reference WidgetTypeName or any other string if applicable
CEGUI_DEFINE_PROPERTY(Window, float, "Alpha",
"Property to get/set the alpha value of the Window. Value is floating point number.",
&Window::setAlpha, &Window::getAlpha, 1.0f)
};
\endcode
*/
#define CEGUI_DEFINE_PROPERTY(class_type, property_native_type, name, help, setter, getter, default_value)\
{\
static ::CEGUI::TplWindowProperty<class_type, property_native_type> sProperty(\
name, help, propertyOrigin, setter, getter, default_value);\
\
this->addProperty(&sProperty);\
}
/*!
\brief
Similar to CEGUI_DEFINE_PROPERTY but writeXML is set to false
\note
Properties that have no setter (null pointer is passed as setter) are automatically
banned from XML, there is no need to use this macro for them. Doing so will cause
CEGUI to output a warning.
Example of usage inside addStandardProperties or similar method:
\code{.cpp}
{
const String propertyOrigin("MyAwesomeClass"); // this is automatically used by the macro
// you can also reference WidgetTypeName or any other string if applicable
CEGUI_DEFINE_PROPERTY_NO_XML(Window, float, "Alpha",
"Property to get/set the alpha value of the Window. Value is floating point number.",
&Window::setAlpha, &Window::getAlpha, 1.0f)
};
\endcode
*/
#define CEGUI_DEFINE_PROPERTY_NO_XML(class_type, property_native_type, name, help, setter, getter, default_value)\
{\
static ::CEGUI::TplWindowProperty<class_type, property_native_type> sProperty(\
name, help, propertyOrigin, setter, getter, default_value, false);\
\
this->addProperty(&sProperty);\
}
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIPropertySet_h_
|