/usr/include/cegui-0.8.4/CEGUI/widgets/Thumb.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
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 | /***********************************************************************
created: 25/4/2004
author: Paul D Turner
purpose: Interface for a 'Thumb' widget. Intended to be used as
part of other widgets such as scrollers and sliders.
*************************************************************************/
/***************************************************************************
* 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 _CEGUIThumb_h_
#define _CEGUIThumb_h_
#include "./PushButton.h"
#include <utility>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
# pragma warning(disable : 4996)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Base class for Thumb widget.
The thumb widget is used to compose other widgets (like sliders and scroll bars). You would
not normally need to use this widget directly unless you are making a new widget of some type.
*/
class CEGUIEXPORT Thumb : public PushButton
{
public:
static const String EventNamespace; //!< Namespace for global events
static const String WidgetTypeName; //!< Window factory name
/*************************************************************************
Event name constants
*************************************************************************/
// generated internally by Window
/** Event fired when the position of the thumb widget has changed (this
* event is only fired when hot tracking is enabled).
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Thumb whose position has changed.
*/
static const String EventThumbPositionChanged;
/** Event fired when the user begins dragging the thumb.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Thumb that has started to be dragged
* by the user.
*/
static const String EventThumbTrackStarted;
/** Event fired when the user releases the thumb.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the Thumb that has been released.
*/
static const String EventThumbTrackEnded;
/*************************************************************************
Accessor Functions
*************************************************************************/
/*!
\brief
return whether hot-tracking is enabled or not.
\return
true if hot-tracking is enabled. false if hot-tracking is disabled.
*/
bool isHotTracked(void) const {return d_hotTrack;}
/*!
\brief
return whether the thumb is movable on the vertical axis.
\return
true if the thumb is movable along the vertical axis.
false if the thumb is fixed on the vertical axis.
*/
bool isVertFree(void) const {return d_vertFree;}
/*!
\brief
return whether the thumb is movable on the horizontal axis.
\return
true if the thumb is movable along the horizontal axis.
false if the thumb is fixed on the horizontal axis.
*/
bool isHorzFree(void) const {return d_horzFree;}
/*!
\brief
Return a std::pair that describes the current range set for the vertical movement.
\return
a std::pair describing the current vertical range. The first element is the minimum value,
the second element is the maximum value.
*/
std::pair<float, float> getVertRange(void) const;
/*!
\brief
Return a std::pair that describes the current range set for the horizontal movement.
\return
a std::pair describing the current horizontal range. The first element is the minimum value,
the second element is the maximum value.
*/
std::pair<float, float> getHorzRange(void) const;
/*************************************************************************
Manipulator Functions
*************************************************************************/
/*!
\brief
set whether the thumb uses hot-tracking.
\param setting
true to enable hot-tracking. false to disable hot-tracking.
\return
Nothing.
*/
void setHotTracked(bool setting) {d_hotTrack = setting;}
/*!
\brief
set whether thumb is movable on the vertical axis.
\param setting
true to allow movement of thumb along the vertical axis. false to fix thumb on the vertical axis.
\return
nothing.
*/
void setVertFree(bool setting) {d_vertFree = setting;}
/*!
\brief
set whether thumb is movable on the horizontal axis.
\param setting
true to allow movement of thumb along the horizontal axis. false to fix thumb on the horizontal axis.
\return
nothing.
*/
void setHorzFree(bool setting) {d_horzFree = setting;}
/*!
\brief
set the movement range of the thumb for the vertical axis.
The values specified here are relative to the parent window for the thumb, and are specified in whichever
metrics mode is active for the widget.
\param min
the minimum setting for the thumb on the vertical axis.
\param max
the maximum setting for the thumb on the vertical axis.
\return
Nothing.
*/
void setVertRange(float min, float max);
/*!
\brief
set the movement range of the thumb for the vertical axis.
The values specified here are relative to the parent window for the thumb, and are specified in whichever
metrics mode is active for the widget.
\param range
the setting for the thumb on the vertical axis.
\return
Nothing.
*/
void setVertRange(const std::pair<float, float> &range);
/*!
\brief
set the movement range of the thumb for the horizontal axis.
The values specified here are relative to the parent window for the thumb, and are specified in whichever
metrics mode is active for the widget.
\param min
the minimum setting for the thumb on the horizontal axis.
\param max
the maximum setting for the thumb on the horizontal axis.
\return
Nothing.
*/
void setHorzRange(float min, float max);
/*!
\brief
set the movement range of the thumb for the horizontal axis.
The values specified here are relative to the parent window for the thumb, and are specified in whichever
metrics mode is active for the widget.
\param range
the setting for the thumb on the horizontal axis.
\return
Nothing.
*/
void setHorzRange(const std::pair<float, float> &range);
/*************************************************************************
Construction / Destruction
*************************************************************************/
/*!
\brief
Constructor for Thumb objects
*/
Thumb(const String& type, const String& name);
/*!
\brief
Destructor for Thumb objects
*/
virtual ~Thumb(void);
protected:
// overridden from base class
void banPropertiesForAutoWindow();
/*************************************************************************
New Thumb Events
*************************************************************************/
/*!
\brief
event triggered internally when the position of the thumb
*/
virtual void onThumbPositionChanged(WindowEventArgs& e);
/*!
\brief
Handler triggered when the user begins to drag the thumb.
*/
virtual void onThumbTrackStarted(WindowEventArgs& e);
/*!
\brief
Handler triggered when the thumb is released
*/
virtual void onThumbTrackEnded(WindowEventArgs& e);
/*************************************************************************
Overridden event handling routines
*************************************************************************/
virtual void onMouseMove(MouseEventArgs& e);
virtual void onMouseButtonDown(MouseEventArgs& e);
virtual void onCaptureLost(WindowEventArgs& e);
/*************************************************************************
Implementation Data
*************************************************************************/
// general settings
bool d_hotTrack; //!< true if events are to be sent real-time, else just when thumb is released
bool d_vertFree; //!< true if thumb is movable vertically
bool d_horzFree; //!< true if thumb is movable horizontally
// operational limits
float d_vertMin, d_vertMax; //!< vertical range
float d_horzMin, d_horzMax; //!< horizontal range
// internal state
bool d_beingDragged; //!< true if thumb is being dragged
Vector2f d_dragPoint; //!< point where we are being dragged at.
private:
/*************************************************************************
Private methods
*************************************************************************/
void addThumbProperties(void);
};
/*
TODO: This is horrible, PropertyHelper for std::pair<float, float> would be fine but enforcing min: %f max: %f is just horrible
*/
template<>
class PropertyHelper<std::pair<float,float> >
{
public:
typedef std::pair<float,float> return_type;
typedef return_type safe_method_return_type;
typedef const std::pair<float,float>& pass_type;
typedef String string_return_type;
static const String& getDataTypeName()
{
static String type("std::pair<float,float>");
return type;
}
static return_type fromString(const String& str)
{
float rangeMin = 0, rangeMax = 0;
sscanf(str.c_str(), " min:%f max:%f", &rangeMin, &rangeMax);
return std::pair<float,float>(rangeMin,rangeMax);
}
static string_return_type toString(pass_type val)
{
char buff[64];
sprintf(buff, "min:%f max:%f", val.first, val.second);
return buff;
}
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIThumb_h_
|