/usr/include/Wt/WSlider is in libwt-dev 3.3.4+dfsg-6ubuntu1.
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 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WSLIDER_H_
#define WSLIDER_H_
#include <Wt/WFormWidget>
#include <Wt/WJavaScript>
namespace Wt {
class PaintedSlider;
/*! \class WSlider Wt/WSlider Wt/WSlider
* \brief A horizontal or vertical slider control.
*
* A slider allows the user to specify an integer value within a particular
* range using a visual slider.
*
* The slider must be sized explicitly using resize() or by a layout
* manager. The default size is 150 x 50 pixels for a horizontal
* slider, and 50 x 150 pixels for a vertical slider.
*
* \if cpp
* Usage example:
* \code
* Wt::WSlider *scaleSlider = new Wt::WSlider(Wt::Horizontal);
* scaleSlider->setMinimum(0);
* scaleSlider->setMaximum(20);
* scaleSlider->setValue(10);
* scaleSlider->setTickInterval(5);
* scaleSlider->setTickPosition(Wt::WSlider::TicksBothSides);
* scaleSlider->resize(300, 50);
* scaleSlider->valueChanged().connect(this, &ThisClass::scaleShape);
* \endcode
* \endif
*
* \image html WSlider-1.png "Horizontal slider with ticks on both sides."
*
* <h3>CSS</h3>
*
* The non-native slider (HTML4, see setNativeControl()) is styled by
* the current CSS theme.
*/
class WT_API WSlider : public WFormWidget
{
public:
/*! \brief Enumeration that specifies the location of ticks.
*/
enum TickPosition {
TicksAbove = 0x1, //!< %Render ticks above (horizontal slider)
TicksBelow = 0x2 //!< %Render ticks below (horizontal slider)
#ifndef WT_TARGET_JAVA
,TicksLeft = 0x1, //!< %Render ticks on the left side (vertical slider)
TicksRight = 0x2 //!< %Render ticks on the right side (vertical slider)
#endif // WT_TARGET_JAVA
};
//! Do not render ticks.
static const Wt::WFlags<TickPosition> NoTicks;
//! %Render ticks on both sides.
static const Wt::WFlags<TickPosition> TicksBothSides;
/*! \brief Creates a default horizontal slider.
*
* The slider shows no ticks, has a range from 0 to 99, and has tickInterval
* of 0 (defaulting to three ticks over the whole range).
*
* The initial value is 0.
*/
WSlider(WContainerWidget *parent = 0);
/*! \brief Creates a default slider of the given orientation.
*
* The slider shows no ticks, has a range from 0 to 99, and has tickInterval
* of 0 (defaulting to three ticks over the whole range).
*
* The initial value is 0.
*/
WSlider(Orientation orientation, WContainerWidget *parent = 0);
/*! \brief Destructor.
*/
~WSlider();
/*! \brief Configures whether a native HTML5 control should be used.
*
* When \p native, the new "range" input element, specified by HTML5
* and when implemented by the browser, is used rather than the
* built-in element. A native control is styled by the browser
* (usually in sync with the OS) rather than through the theme
* chosen. Settings like tick interval and tick position are
* ignored.
*
* \note Vertically oriented sliders are in theory supported by the HTML5
* input element, but in practice are usually not rendered correctly
* by the browser.
*/
void setNativeControl(bool nativeControl);
/*! \brief Returns whether a native HTML5 control is used.
*
* Taking into account the preference for a native control,
* configured using setNativeControl(), this method returns whether
* a native control is actually being used.
*/
bool nativeControl() const;
/*! \brief Sets the slider orientation.
*
* \sa orientation()
*/
void setOrientation(Wt::Orientation orientation);
/*! \brief Returns the slider orientation.
*
* \sa setOrientation()
*/
Orientation orientation() const { return orientation_; }
/*! \brief Sets the tick interval.
*
* The tick interval specifies the interval for placing ticks along
* the slider. The interval is specified in value units (not pixel
* units). A value of 0 specifies an automatic tick interval, which
* defaults to 3 ticks spanning the whole range.
*
* \sa tickInterval(), setTickPosition()
*/
void setTickInterval(int tickInterval);
/*! \brief Returns the tick interval.
*
* \sa setTickInterval()
*/
int tickInterval() const { return tickInterval_; }
/*! \brief Sets the tick position.
*
* The tick position indicates if and where ticks are placed around the
* slider groove.
*
* \sa tickPosition(), setTickInterval()
*/
void setTickPosition(WFlags<TickPosition> tickPosition);
/*! \brief Returns the tick position.
*
* \sa setTickPosition(), setTickInterval()
*/
WFlags<TickPosition> tickPosition() const { return tickPosition_; }
/*! \brief Sets the slider value.
*
* The value is automatically trimmed to the valid range (minimum()
* to maximum()).
*
* \sa value()
*/
virtual void setValue(int value);
/*! \brief Returns the current slider value.
*
* \sa setValue()
*/
int value() const { return value_; }
/*! \brief Sets the maximum value.
*
* The maximum value defines the upper limit of the valid range. The
* lower limit and current value are automatically adjusted to
* remain valid.
*
* \sa maximum(), setMinimum(), setRange()
*/
void setMaximum(int maximum);
/*! \brief Returns the maximum value.
*
* \sa setMaximum(int)
*/
int maximum() const { return maximum_; }
/*! \brief Sets the minimum value.
*
* The minimum value defines the lower limit of the valid range. The
* upper limit and current value are automatically adjusted to
* remain valid.
*
* \sa minimum(), setMaximum(), setRange()
*/
void setMinimum(int minimum);
/*! \brief Returns the minimum value.
*
* \sa setMinimum(int)
*/
int minimum() const { return minimum_; }
/*! \brief Sets the value range.
*
* \sa setMinimum(), setMaximum()
*/
void setRange(int minimum, int maximum);
/*! \brief %Signal emitted when the user has changed the value of the
* slider.
*
* The new value is passed as the argument.
*
* \sa sliderMoved()
*/
Signal<int>& valueChanged() { return valueChanged_; }
/*! \brief %Signal emitted while the user drags the slider.
*
* The current dragged position is passed as the argument. Note that the
* slider value is not changed while dragging the slider, but only after
* the slider has been released.
*
* \sa valueChanged()
*/
JSignal<int>& sliderMoved() { return sliderMoved_; }
/*! \brief Sets the slider handle width.
*
* This sets the width for the handle, which is needed to accurately
* position the handle.
*
* The default value is 20 pixels.
*/
void setHandleWidth(int width);
/*! \brief Returns the handle width.
*
* \sa setHandleWidth()
*/
int handleWidth() const { return handleWidth_; }
virtual void setDisabled(bool disabled);
virtual void resize(const WLength& width, const WLength& height);
virtual WT_USTRING valueText() const;
virtual void setValueText(const WT_USTRING& value);
protected:
/*! \brief Paints a slider ticks (for a non-native widget)
*
* The default implementation draws ticks taking into account the
* the tickPosition.
*
* The mid point for the tick should be at position (x, y). The \p
* value that corresponds to the tick is also passed.
*/
virtual void paintTick(WPainter& painter, int value, int x, int y);
/*! \brief Creates the handle (for a non-native widget)
*
* The default implementation creates a container widget. You may
* want to specialize this function if you want to have more control
* on the handle appearance or if you want to associate with the
* handle a tooltip or other information (e.g. a popup balloon).
*/
virtual WInteractWidget *createHandle();
virtual void signalConnectionsChanged();
virtual void layoutSizeChanged(int width, int height);
virtual void render(WFlags<RenderFlag> flags);
virtual void updateDom(DomElement& element, bool all);
virtual DomElementType domElementType() const;
virtual void setFormData(const FormData& formData);
private:
Orientation orientation_;
int tickInterval_;
WFlags<TickPosition> tickPosition_;
bool preferNative_, changed_, changedConnected_;
int handleWidth_;
int minimum_, maximum_;
int value_;
Signal<int> valueChanged_;
JSignal<int> sliderMoved_;
PaintedSlider *paintedSlider_;
void update();
void onChange();
friend class PaintedSlider;
};
W_DECLARE_OPERATORS_FOR_FLAGS(WSlider::TickPosition)
}
#endif // WSLIDER_H_
|