/usr/include/CEGUI/elements/CEGUISpinner.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 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 | /***********************************************************************
filename: CEGUISpinner.h
created: 3/2/2005
author: Paul D Turner
*************************************************************************/
/***************************************************************************
* 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 _CEGUISpinner_h_
#define _CEGUISpinner_h_
#include "../CEGUIBase.h"
#include "../CEGUIWindow.h"
#include "CEGUISpinnerProperties.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Base class for the Spinner widget.
The spinner widget has a text area where numbers may be entered
and two buttons which may be used to increase or decrease the
value in the text area by a user specified amount.
*/
class CEGUIEXPORT Spinner : public Window
{
public:
/*!
\brief
Enumerated type specifying possible input and/or display modes for the spinner.
*/
enum TextInputMode
{
FloatingPoint, //!< Floating point decimal.
Integer, //!< Integer decimal.
Hexadecimal, //!< Hexadecimal.
Octal //!< Octal
};
/*************************************************************************
Events system constants
*************************************************************************/
static const String WidgetTypeName; //!< Window factory name
static const String EventNamespace; //!< Namespace for global events
/** Event fired when the spinner current value changes.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Spinner whose current value has
* changed.
*/
static const String EventValueChanged;
/** Event fired when the spinner step value is changed.
* Handlers area passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Spinner whose step value has
* changed.
*/
static const String EventStepChanged;
/** Event fired when the maximum spinner value is changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Spinner whose maximum value has
* been changed.
*/
static const String EventMaximumValueChanged;
/** Event fired when the minimum spinner value is changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::windows set to the Spinner whose minimum value has
* been changed.
*/
static const String EventMinimumValueChanged;
/** Event fired when the spinner text input & display mode is changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Spinner whose text mode has been
* changed.
*/
static const String EventTextInputModeChanged;
/*************************************************************************
Component widget name suffix strings
*************************************************************************/
static const String EditboxNameSuffix; //!< Widget name suffix for the editbox thumb component.
static const String IncreaseButtonNameSuffix; //!< Widget name suffix for the increase button component.
static const String DecreaseButtonNameSuffix; //!< Widget name suffix for the decrease button component.
/*************************************************************************
Object Construction and Destruction
*************************************************************************/
/*!
\brief
Constructor for Spinner objects
*/
Spinner(const String& type, const String& name);
/*!
\brief
Destructor for Spinner objects
*/
virtual ~Spinner(void);
/*!
\brief
Initialises the Window based object ready for use.
\note
This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window type.
\return
Nothing
*/
void initialiseComponents(void);
/*************************************************************************
Accessors
*************************************************************************/
/*!
\brief
Return the current spinner value.
\return
current value of the Spinner.
*/
double getCurrentValue(void) const;
/*!
\brief
Return the current step value.
\return
Step value. This is the value added to the spinner vaue when the
up / down buttons are clicked.
*/
double getStepSize(void) const;
/*!
\brief
Return the current maximum limit value for the Spinner.
\return
Maximum value that is allowed for the spinner.
*/
double getMaximumValue(void) const;
/*!
\brief
Return the current minimum limit value for the Spinner.
\return
Minimum value that is allowed for the spinner.
*/
double getMinimumValue(void) const;
/*!
\brief
Return the current text input / display mode setting.
\return
One of the TextInputMode enumerated values indicating the current
text input and display mode.
*/
TextInputMode getTextInputMode(void) const;
/*************************************************************************
Manipulators
*************************************************************************/
/*!
\brief
Set the current spinner value.
\param value
value to be assigned to the Spinner.
\return
Nothing.
*/
void setCurrentValue(double value);
/*!
\brief
Set the current step value.
\param step
The value added to be the spinner value when the
up / down buttons are clicked.
\return
Nothing.
*/
void setStepSize(double step);
/*!
\brief
Set the spinner maximum value.
\param maxValue
The maximum value to be allowed by the spinner.
\return
Nothing.
*/
void setMaximumValue(double maxValue);
/*!
\brief
Set the spinner minimum value.
\param minVaue
The minimum value to be allowed by the spinner.
\return
Nothing.
*/
void setMinimumValue(double minVaue);
/*!
\brief
Set the spinner input / display mode.
\param mode
One of the TextInputMode enumerated values indicating the text
input / display mode to be used by the spinner.
\return
Nothing.
*/
void setTextInputMode(TextInputMode mode);
protected:
/*************************************************************************
Constants
*************************************************************************/
static const String FloatValidator; //!< Validator regex used for floating point mode.
static const String IntegerValidator; //!< Validator regex used for decimal integer mode.
static const String HexValidator; //!< Validator regex used for hexadecimal mode.
static const String OctalValidator; //!< Validator regex used for octal mode.
/*************************************************************************
Protected Implementation Methods
*************************************************************************/
/*!
\brief
Returns the numerical representation of the current editbox text.
\return
double value that is the numerical equivalent of the editbox text.
\exception InvalidRequestException thrown if the text can not be converted.
*/
virtual double getValueFromText(void) const;
/*!
\brief
Returns the textual representation of the current spinner value.
\return
String object that is equivalent to the the numerical value of the spinner.
*/
virtual String getTextFromValue(void) const;
/*!
\brief
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
\param class_name
The class name that is to be checked.
\return
true if this window was inherited from \a class_name. false if not.
*/
virtual bool testClassName_impl(const String& class_name) const
{
if (class_name=="Spinner") return true;
return Window::testClassName_impl(class_name);
}
/*!
\brief
Return a pointer to the 'increase' PushButtoncomponent widget for
this Spinner.
\return
Pointer to a PushButton object.
\exception UnknownObjectException
Thrown if the increase PushButton component does not exist.
*/
PushButton* getIncreaseButton() const;
/*!
\brief
Return a pointer to the 'decrease' PushButton component widget for
this Spinner.
\return
Pointer to a PushButton object.
\exception UnknownObjectException
Thrown if the 'decrease' PushButton component does not exist.
*/
PushButton* getDecreaseButton() const;
/*!
\brief
Return a pointer to the Editbox component widget for this Spinner.
\return
Pointer to a Editbox object.
\exception UnknownObjectException
Thrown if the Editbox component does not exist.
*/
Editbox* getEditbox() const;
/*************************************************************************
Overrides for Event handler methods
*************************************************************************/
virtual void onFontChanged(WindowEventArgs& e);
virtual void onTextChanged(WindowEventArgs& e);
virtual void onActivated(ActivationEventArgs& e);
/*************************************************************************
New Event handler methods
*************************************************************************/
/*!
\brief
Method called when the spinner value changes.
\param e
WindowEventArgs object containing any relevant data.
\return
Nothing.
*/
virtual void onValueChanged(WindowEventArgs& e);
/*!
\brief
Method called when the step value changes.
\param e
WindowEventArgs object containing any relevant data.
\return
Nothing.
*/
virtual void onStepChanged(WindowEventArgs& e);
/*!
\brief
Method called when the maximum value setting changes.
\param e
WindowEventArgs object containing any relevant data.
\return
Nothing.
*/
virtual void onMaximumValueChanged(WindowEventArgs& e);
/*!
\brief
Method called when the minimum value setting changes.
\param e
WindowEventArgs object containing any relevant data.
\return
Nothing.
*/
virtual void onMinimumValueChanged(WindowEventArgs& e);
/*!
\brief
Method called when the text input/display mode is changed.
\param e
WindowEventArgs object containing any relevant data.
\return
Nothing.
*/
virtual void onTextInputModeChanged(WindowEventArgs& e);
/*************************************************************************
Internal event listener methods
*************************************************************************/
bool handleIncreaseButton(const EventArgs& e);
bool handleDecreaseButton(const EventArgs& e);
bool handleEditTextChange(const EventArgs& e);
/*************************************************************************
Data Fields
*************************************************************************/
double d_stepSize; //!< Step size value used y the increase & decrease buttons.
double d_currentValue; //!< Numerical copy of the text in d_editbox.
double d_maxValue; //!< Maximum value for spinner.
double d_minValue; //!< Minimum value for spinner.
TextInputMode d_inputMode; //!< Current text display/input mode.
private:
/*************************************************************************
Static properties for the Spinner widget
*************************************************************************/
static SpinnerProperties::CurrentValue d_currentValueProperty;
static SpinnerProperties::StepSize d_stepSizeProperty;
static SpinnerProperties::MaximumValue d_maxValueProperty;
static SpinnerProperties::MinimumValue d_minValueProperty;
static SpinnerProperties::TextInputMode d_textInputModeProperty;
/*************************************************************************
Private Implementation Methods
*************************************************************************/
/*!
\brief
Adds properties supported by the Spinner class.
\return
Nothing.
*/
void addSpinnerProperties(void);
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUISpinner_h_
|