/usr/include/Wt/WProgressBar is in libwt-dev 3.3.0-1build1.
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 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2010 Thomas Suckow.
* Copyright (C) 2010 Emweb bvba, Kessel-Lo, Belgium
*
* See the LICENSE file for terms of use.
*/
#ifndef WPROGRESSBAR_H_
#define WPROGRESSBAR_H_
#include <Wt/WInteractWidget>
namespace Wt {
/*! \brief A progress bar.
*
* The progress bar can be used to indicate the progress of a certain
* operation. The text displayed in the progress bar can be customized
* by specializing text().
*
* To use the progress bar, you need to give it a range (minimum and maximum
* value), and update the progress using setValue().
*
* %WProgressBar is an \link WWidget::setInline(bool) inline \endlink widget.
*
* \note With the advent of HTML5, this widget will be implemented using
* the native HTML5 control when available.
*/
class WT_API WProgressBar : public WInteractWidget
{
public:
/*! \brief Creates a progress bar.
*/
WProgressBar(WContainerWidget *parent = 0);
/*! \brief Sets the minimum value.
*
* The minimum value is the value that corresponds to 0%.
*
* The default value is 0.
*/
void setMinimum(double minimum);
/*! \brief Returns the minimum value.
*
* \sa setMinimum()
*/
double minimum() const { return min_; }
/*! \brief Sets the maximum value.
*
* The maximum value is the value that corresponds to 100%.
*
* The default value is 100.
*/
void setMaximum(double maximum);
/*! \brief Returns the maximum value.
*
* \sa setMaximum()
*/
double maximum() const { return max_; }
/*! \brief Sets the range.
*
* \sa setMinimum(), setMaximum()
*/
void setRange(double minimum, double maximum);
/*! \brief Sets the current progress.
*
* \p value must be a value between minimum() and maximum().
*/
void setValue(double value);
/*! \brief Returns the current progress.
*/
double value() const { return value_; }
/*! \brief Sets the progress format string.
*
* The format is used by text() to indicate the progress value.
*
* The default value is "%.0f %%"
*/
void setFormat(const WString& format);
/*! \brief Returns the progress format string.
*
* \sa setFormat()
*/
const WString& format() const { return format_; }
/*! \brief Returns the text displayed inside the progress bar.
*
* This text must be an XHTML formatted text fragment. The default
* text prints the current progress using format(). You may want to
* reimplement this method to display a different text corresponding
* to the current value().
*/
virtual WString text() const;
/*! \brief A %signal that indicates when the value has changed.
*
* This signal is emitted when setValue() is called.
*
* \sa setValue()
*/
Signal<double>& valueChanged() { return valueChanged_; }
/*! \brief A %signal that indicates when 100% is reached.
*
* This signal is emitted when setValue(maximum()) is called.
*
* \sa setValue()
*/
Signal<>& progressCompleted() { return progressCompleted_; }
virtual void resize(const WLength& width, const WLength& height);
void setValueStyleClass(const std::string& valueClass);
void setState(double minimum, double maximum, double value);
protected:
virtual void updateDom(DomElement& element, bool all);
virtual DomElementType domElementType() const;
virtual void propagateRenderOk(bool deep);
private:
double min_, max_, value_;
WString format_;
bool changed_;
std::string valueStyleClass_;
void onChange();
Signal<double> valueChanged_;
Signal<> progressCompleted_;
double percentage() const;
};
}
#endif // WPROGRESSBAR_H_
|