/usr/include/CEGUI/falagard/CEGUIFalWidgetLookFeel.h is in libcegui-mk2-dev 0.7.5-8.
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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | /***********************************************************************
filename: CEGUIFalWidgetLookFeel.h
created: Mon Jun 13 2005
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* 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 _CEGUIFalWidgetLookFeel_h_
#define _CEGUIFalWidgetLookFeel_h_
#include "CEGUIFalStateImagery.h"
#include "CEGUIFalWidgetComponent.h"
#include "CEGUIFalImagerySection.h"
#include "CEGUIFalPropertyInitialiser.h"
#include "CEGUIFalPropertyDefinition.h"
#include "CEGUIFalPropertyLinkDefinition.h"
#include "CEGUIFalNamedArea.h"
#include <map>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Class that encapsulates look & feel information for a particular widget type.
*/
class CEGUIEXPORT WidgetLookFeel
{
public:
WidgetLookFeel(const String& name);
WidgetLookFeel() {}
/*!
\brief
Return a const reference to the StateImagery object for the specified state.
\return
StateImagery object for the requested state.
*/
const StateImagery& getStateImagery(const CEGUI::String& state) const;
/*!
\brief
Return a const reference to the ImagerySection object with the specified name.
\return
ImagerySection object with the specified name.
*/
const ImagerySection& getImagerySection(const CEGUI::String& section) const;
/*!
\brief
Return the name of the widget look.
\return
String object holding the name of the WidgetLookFeel.
*/
const String& getName() const;
/*!
\brief
Add an ImagerySection to the WidgetLookFeel.
\param section
ImagerySection object to be added.
\return Nothing.
*/
void addImagerySection(const ImagerySection& section);
/*!
\brief
Add a WidgetComponent to the WidgetLookFeel.
\param widget
WidgetComponent object to be added.
\return Nothing.
*/
void addWidgetComponent(const WidgetComponent& widget);
/*!
\brief
Add a state specification (StateImagery object) to the WidgetLookFeel.
\param section
StateImagery object to be added.
\return Nothing.
*/
void addStateSpecification(const StateImagery& state);
/*!
\brief
Add a property initialiser to the WidgetLookFeel.
\param initialiser
PropertyInitialiser object to be added.
\return Nothing.
*/
void addPropertyInitialiser(const PropertyInitialiser& initialiser);
/*!
\brief
Clear all ImagerySections from the WidgetLookFeel.
\return
Nothing.
*/
void clearImagerySections();
/*!
\brief
Clear all WidgetComponents from the WidgetLookFeel.
\return
Nothing.
*/
void clearWidgetComponents();
/*!
\brief
Clear all StateImagery objects from the WidgetLookFeel.
\return
Nothing.
*/
void clearStateSpecifications();
/*!
\brief
Clear all PropertyInitialiser objects from the WidgetLookFeel.
\return
Nothing.
*/
void clearPropertyInitialisers();
/*!
\brief
Initialise the given window using PropertyInitialsers and component widgets
specified for this WidgetLookFeel.
\param widget
Window based object to be initialised.
\return
Nothing.
*/
void initialiseWidget(Window& widget) const;
/*!
\brief
Clean up the given window from all properties and component widgets created by this WidgetLookFeel
\param widget
Window based object to be cleaned up.
\return
Nothing.
*/
void cleanUpWidget(Window& widget) const;
/*!
\brief
Return whether imagery is defined for the given state.
\param state
String object containing name of state to look for.
\return
- true if imagery exists for the specified state,
- false if no imagery exists for the specified state.
*/
bool isStateImageryPresent(const String& state) const;
/*!
\brief
Adds a named area to the WidgetLookFeel.
\param area
NamedArea to be added.
\return
Nothing.
*/
void addNamedArea(const NamedArea& area);
/*!
\brief
Clear all defined named areas from the WidgetLookFeel
\return
Nothing.
*/
void clearNamedAreas();
/*!
\brief
Return the NamedArea with the specified name.
\param name
String object holding the name of the NamedArea to be returned.
\return
The requested NamedArea object.
*/
const NamedArea& getNamedArea(const String& name) const;
/*!
\brief
return whether a NamedArea object with the specified name exists for this WidgetLookFeel.
\param name
String holding the name of the NamedArea to check for.
\return
- true if a named area with the requested name is defined for this WidgetLookFeel.
- false if no such named area is defined for this WidgetLookFeel.
*/
bool isNamedAreaDefined(const String& name) const;
/*!
\brief
Layout the child widgets defined for this WidgetLookFeel which are attached to the given window.
\param owner
Window object that has the child widgets that require laying out.
\return
Nothing.
*/
void layoutChildWidgets(const Window& owner) const;
/*!
\brief
Adds a property definition to the WidgetLookFeel.
\param propdef
PropertyDefinition object to be added.
\return
Nothing.
*/
void addPropertyDefinition(const PropertyDefinition& propdef);
/*!
\brief
Adds a property link definition to the WidgetLookFeel.
\param propdef
PropertyLinkDefinition object to be added.
\return
Nothing.
*/
void addPropertyLinkDefinition(const PropertyLinkDefinition& propdef);
/*!
\brief
Clear all defined property definitions from the WidgetLookFeel
\return
Nothing.
*/
void clearPropertyDefinitions();
/*!
\brief
Clear all defined property link definitions from the WidgetLookFeel
\return
Nothing.
*/
void clearPropertyLinkDefinitions();
/*!
\brief
Add the name of an animation that is associated with the
WidgetLookFeel.
\param anim_name
Reference to a String object that contains the name of the animation
to be associated with this WidgetLookFeel.
*/
void addAnimationName(const String& anim_name);
/*!
\brief
Writes an xml representation of this WidgetLookFeel to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
/*!
\brief
Uses the WindowManager to rename the child windows that are
created for this WidgetLookFeel.
\param widget
The target Window containing the child windows that are to be
renamed.
\param newBaseName
String object holding the new base name that will be used when
constructing new names for the child windows.
*/
void renameChildren(const Window& widget, const String& newBaseName) const;
/*!
\brief
Takes the name of a property and returns a pointer to the last
PropertyInitialiser for this property or 0 if the is no
PropertyInitialiser for this property in the WidgetLookFeel
\param propertyName
The name of the property to look for.
*/
const PropertyInitialiser* findPropertyInitialiser(const String& propertyName) const;
/*!
\brief
Takes the namesuffix for a widget component and returns a pointer to
it if it exists or 0 if it does'nt.
\param nameSuffix
The name suffix of the Child component to look for.
*/
const WidgetComponent* findWidgetComponent(const String& nameSuffix) const;
/** Typedefs for property related lists. */
typedef std::vector<PropertyInitialiser> PropertyList;
typedef std::vector<PropertyDefinition> PropertyDefinitionList;
typedef std::vector<PropertyLinkDefinition> PropertyLinkDefinitionList;
/** Obtains list of properties definitions.
* @access public
* @return CEGUI::WidgetLookFeel::PropertyDefinitionList List of properties definitions
*/
const PropertyDefinitionList& getPropertyDefinitions() const { return d_propertyDefinitions; }
/** Obtains list of properties link definitions.
* @access public
* @return CEGUI::WidgetLookFeel::PropertyLinkDefinitionList List of properties link definitions
*/
const PropertyLinkDefinitionList& getPropertyLinkDefinitions() const { return d_propertyLinkDefinitions; }
/** Obtains list of properties.
* @access public
* @return CEGUI::WidgetLookFeel::PropertyList List of properties
*/
const PropertyList& getProperties() const { return d_properties; }
private:
typedef std::map<String, StateImagery, String::FastLessCompare> StateList;
typedef std::map<String, ImagerySection, String::FastLessCompare> ImageryList;
typedef std::map<String, NamedArea, String::FastLessCompare> NamedAreaList;
typedef std::vector<WidgetComponent> WidgetList;
typedef std::vector<String> AnimationList;
typedef std::multimap<Window*, AnimationInstance*> AnimationInstanceMap;
CEGUI::String d_lookName; //!< Name of this WidgetLookFeel.
ImageryList d_imagerySections; //!< Collection of ImagerySection objects.
WidgetList d_childWidgets; //!< Collection of WidgetComponent objects.
StateList d_stateImagery; //!< Collection of StateImagery objects.
PropertyList d_properties; //!< Collection of PropertyInitialser objects.
NamedAreaList d_namedAreas; //!< Collection of NamedArea objects.
mutable PropertyDefinitionList d_propertyDefinitions; //!< Collection of PropertyDefinition objects.
mutable PropertyLinkDefinitionList d_propertyLinkDefinitions; //!< Collection of PropertyLinkDefinition objects.
//! Collection of animation names associated with this WidgetLookFeel.
AnimationList d_animations;
//! map of windows and their associated animation instances
mutable AnimationInstanceMap d_animationInstances;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIFalWidgetLookFeel_h_
|