/usr/include/CEGUI/falagard/CEGUIFalSectionSpecification.h is in libcegui-mk2-dev 0.7.6-3.3.
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 | /***********************************************************************
filename: CEGUIFalSectionSpecification.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 _CEGUIFalSectionSpecification_h_
#define _CEGUIFalSectionSpecification_h_
#include "../CEGUIWindow.h"
#include "../CEGUIColourRect.h"
// Start of CEGUI namespace section
namespace CEGUI
{
// forward refs
class WidgetLookFeel;
/*!
\brief
Class that represents a simple 'link' to an ImagerySection.
This class enables sections to be easily re-used, by different states and/or layers, by allowing
sections to be specified by name rather than having mutiple copies of the same thing all over the place.
*/
class CEGUIEXPORT SectionSpecification
{
public:
/*!
\brief
Constructor
\param owner
String holding the name of the WidgetLookFeel object that contains the target section.
\param sectionName
String holding the name of the target section.
\param controlPropertySource
String holding the name of a property that will control whether
rendering for this secion will actually occur or not.
\param controlPropertyValue
String holding the value to be tested for from the property named in
controlPropertySource. If this is empty, then controlPropertySource
will be accessed as a boolean property, otherwise rendering will
only occur when the value returned via controlPropertySource matches
the value specified here.
\param controlPropertyWidget
String holding either a widget name suffix or the special value of
'__parent__' indicating the window upon which the property named
in controlPropertySource should be accessed. If this is empty then
the window itself is used as the source, rather than a child or the
parent.
*/
SectionSpecification(const String& owner, const String& sectionName,
const String& controlPropertySource,
const String& controlPropertyValue,
const String& controlPropertyWidget);
/*!
\brief
Constructor
\param owner
String holding the name of the WidgetLookFeel object that contains the target section.
\param sectionName
String holding the name of the target section.
\param controlPropertySource
String holding the name of a property that will control whether
rendering for this secion will actually occur or not.
\param controlPropertyValue
String holding the value to be tested for from the property named in
controlPropertySource. If this is empty, then controlPropertySource
will be accessed as a boolean property, otherwise rendering will
only occur when the value returned via controlPropertySource matches
the value specified here.
\param controlPropertyWidget
String holding either a widget name suffix or the special value of
'__parent__' indicating the window upon which the property named
in controlPropertySource should be accessed. If this is empty then
the window itself is used as the source, rather than a child or the
parent.
\param cols
Override colours to be used (modulates sections master colours).
*/
SectionSpecification(const String& owner, const String& sectionName,
const String& controlPropertySource,
const String& controlPropertyValue,
const String& controlPropertyWidget,
const ColourRect& cols);
/*!
\brief
Render the section specified by this SectionSpecification.
\param srcWindow
Window object to be used when calculating pixel values from BaseDim values.
\return
Nothing.
*/
void render(Window& srcWindow, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Render the section specified by this SectionSpecification.
\param srcWindow
Window object to be used when calculating pixel values from BaseDim values.
\param baseRect
Rect object to be used when calculating pixel values from BaseDim values.
\return
Nothing.
*/
void render(Window& srcWindow, const Rect& baseRect, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
/*!
\brief
Return the name of the WidgetLookFeel object containing the target section.
\return
String object holding the name of the WidgetLookFeel that contains the target ImagerySection.
*/
const String& getOwnerWidgetLookFeel() const;
/*!
\brief
Return the name of the target ImagerySection.
\return
String object holding the name of the target ImagerySection.
*/
const String& getSectionName() const;
/*!
\brief
Return the current override colours.
\return
ColourRect holding the colours that will be modulated with the sections master colours if
colour override is enabled on this SectionSpecification.
*/
const ColourRect& getOverrideColours() const;
/*!
\brief
Set the override colours to be used by this SectionSpecification.
\param cols
ColourRect describing the override colours to set for this SectionSpecification.
\return
Nothing.
*/
void setOverrideColours(const ColourRect& cols);
/*!
\brief
return whether the use of override colours is enabled on this SectionSpecification.
\return
- true if override colours will be used for this SectionSpecification.
- false if override colours will not be used for this SectionSpecification.
*/
bool isUsingOverrideColours() const;
/*!
\brief
Enable or disable the use of override colours for this section.
\param setting
- true if override colours should be used for this SectionSpecification.
- false if override colours should not be used for this SectionSpecification.
\return
Nothing.
*/
void setUsingOverrideColours(bool setting = true);
/*!
\brief
Set the name of the property where override colour values can be obtained.
\param property
String containing the name of the property.
\return
Nothing.
*/
void setOverrideColoursPropertySource(const String& property);
/*!
\brief
Set whether the override colours property source represents a full ColourRect.
\param setting
- true if the override colours property will access a ColourRect object.
- false if the override colours property will access a colour object.
\return
Nothing.
*/
void setOverrideColoursPropertyIsColourRect(bool setting = true);
/*!
\brief
Set the name of the property that controls whether to actually
render this section.
\param property
String containing the name of the property.
\return
Nothing.
*/
void setRenderControlPropertySource(const String& property);
/*!
\brief
Set the test value used when determining whether to render this
section.
The value set here will be compared to the current value of the
property named as the render control property, if they match the
secion will be drawn, otherwise the section will not be drawn. If
this value is set to the empty string, the control property will
instead be treated as a boolean property.
*/
void setRenderControlValue(const String& value);
/*!
\brief
Set the widget what will be used as the source of the property
named as the control property.
The value of this setting will be interpreted as follows:
- empty string: The target widget being drawn will be the source of
the property value.
- '__parent__': The parent of the widget being drawn will be the
source of the property value.
- any other value: The value will be taken as a name suffix and
a window with the name of the widget being drawn with the
specified suffix will be the source of the property value.
*/
void setRenderControlWidget(const String& widget);
/*!
\brief
Writes an xml representation of this SectionSpecification to \a out_stream.
\param xml_stream
Stream where xml data should be output.
\return
Nothing.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
protected:
/*!
\brief
Helper method to initialise a ColourRect with appropriate values according to the way the
section sepcification is set up.
This will try and get values from multiple places:
- a property attached to \a wnd
- the integral d_coloursOverride values.
- or default to colour(1,1,1,1);
*/
void initColourRectForOverride(const Window& wnd, ColourRect& cr) const;
/** return whether the section should be drawn, based upon the
* render control property and associated items.
*/
bool shouldBeDrawn(const Window& wnd) const;
private:
String d_owner; //!< Name of the WidgetLookFeel containing the required section.
String d_sectionName; //!< Name of the required section within the specified WidgetLookFeel.
ColourRect d_coloursOverride; //!< Colours to use when override is enabled.
bool d_usingColourOverride; //!< true if colour override is enabled.
String d_colourPropertyName; //!< name of property to fetch colours from.
bool d_colourProperyIsRect; //!< true if the colour property will fetch a full ColourRect.
//! Name of a property to control whether to draw this section.
String d_renderControlProperty;
//! Comparison value to test against d_renderControlProperty.
String d_renderControlValue;
//! Widget upon which d_renderControlProperty is to be accessed.
String d_renderControlWidget;
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUIFalSectionSpecification_h_
|