/usr/include/cegui-0.8.4/CEGUI/widgets/ProgressBar.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 | /***********************************************************************
created: 13/4/2004
author: Paul D Turner
purpose: Interface to base class for ProgressBar widget
*************************************************************************/
/***************************************************************************
* 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 _CEGUIProgressBar_h_
#define _CEGUIProgressBar_h_
#include "../Base.h"
#include "../Window.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Base class for progress bars.
*/
class CEGUIEXPORT ProgressBar : public Window
{
public:
static const String EventNamespace; //!< Namespace for global events
static const String WidgetTypeName; //!< Window factory name
/*************************************************************************
Event name constants
*************************************************************************/
/** Event fired whenever the progress value is changed.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the ProgressBar whose value has been
* changed.
*/
static const String EventProgressChanged;
/** Event fired when the progress bar's value reaches 100%.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the ProgressBar whose progress value
* has reached 100%.
*/
static const String EventProgressDone;
/************************************************************************
Accessor Functions
************************************************************************/
/*!
\brief
return the current progress value
*/
float getProgress(void) const {return d_progress;}
/*!
\brief
return the current step size
*/
float getStepSize(void) const {return d_step;}
/*************************************************************************
Manipulator Functions
*************************************************************************/
/*!
\brief
set the current progress.
\param progress
The level of progress to set. If this value is >1.0f (100%) progress will be limited to 1.0f.
\return
Nothing.
*/
void setProgress(float progress);
/*!
\brief
set the size of the 'step' in percentage points (default is 0.01f or 1%).
\param step
Amount to increase the progress by each time the step method is called.
\return
Nothing.
*/
void setStepSize(float step_val) {d_step = step_val;}
/*!
\brief
cause the progress to step
The amount the progress bar will step can be changed by calling the setStepSize method. The
default step size is 0.01f which is equal to 1%.
\return
Nothing.
*/
void step(void) {setProgress(d_progress + d_step);}
/*!
\brief
Modify the progress level by a specified delta.
\param delta
amount to adjust the progress by. Whatever this value is, the progress of the bar will be kept
within the range: 0.0f <= progress <= 1.0f.
\return
Nothing.
*/
void adjustProgress(float delta) {setProgress(d_progress + delta);}
/*************************************************************************
Construction / Destruction
*************************************************************************/
/*!
\brief
Constructor for ProgressBar class
*/
ProgressBar(const String& type, const String& name);
/*!
\brief
Destructor for ProgressBar
*/
virtual ~ProgressBar(void);
protected:
/*************************************************************************
Event handlers for progress bar specific events
*************************************************************************/
/*!
\brief
event triggered when progress changes
*/
virtual void onProgressChanged(WindowEventArgs& e);
/*!
\brief
event triggered when progress reaches 100%
*/
virtual void onProgressDone(WindowEventArgs& e);
/*************************************************************************
Implementation Data
*************************************************************************/
float d_progress; //!< current progress (from 0.0f to 1.0f)
float d_step; //!< amount to 'step' progress by on a call to step()
private:
/*************************************************************************
Private methods
*************************************************************************/
void addProgressBarProperties(void);
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIProgressBar_h_
|