KDE 4.2 API Reference kalarm/lib
SpinBox Class Reference
#include <spinbox.h>
Detailed Description
Spin box with accelerated shift key stepping and read-only option.The SpinBox class provides a QSpinBox with accelerated stepping using the shift key.
A separate step increment may optionally be specified for use when the shift key is held down. Typically this would be larger than the normal step. Then, when the user clicks the spin buttons, he/she can increment or decrement the value faster by holding the shift key down.
The widget may be set as read-only. This has the same effect as disabling it, except that its appearance is unchanged.
Definition at line 44 of file spinbox.h.
Signals | |
| void | stepped (int step) |
Public Member Functions | |
| void | addValue (int change) |
| int | bound (int val) const |
| QRect | downRect () const |
| void | initStyleOption (QStyleOptionSpinBox &) const |
| bool | isReadOnly () const |
| int | maximum () const |
| int | minimum () const |
| bool | selectOnStep () const |
| void | setMaximum (int val) |
| void | setMinimum (int val) |
| void | setRange (int minValue, int maxValue) |
| virtual void | setReadOnly (bool readOnly) |
| void | setSelectOnStep (bool sel) |
| void | setSingleShiftStep (int step) |
| void | setSingleStep (int step) |
| void | setUpDownOnly (bool only) |
| int | singleShiftStep () const |
| int | singleStep () const |
| SpinBox (int minValue, int maxValue, QWidget *parent=0) | |
| SpinBox (QWidget *parent=0) | |
| virtual void | stepBy (int steps) |
| QRect | upDownRect () const |
| QRect | upRect () const |
Protected Member Functions | |
| virtual bool | eventFilter (QObject *, QEvent *) |
| virtual void | focusOutEvent (QFocusEvent *) |
| virtual void | keyPressEvent (QKeyEvent *) |
| virtual void | keyReleaseEvent (QKeyEvent *) |
| virtual void | mouseDoubleClickEvent (QMouseEvent *) |
| virtual void | mouseMoveEvent (QMouseEvent *) |
| virtual void | mousePressEvent (QMouseEvent *) |
| virtual void | mouseReleaseEvent (QMouseEvent *) |
| virtual void | paintEvent (QPaintEvent *) |
| virtual int | shiftStepAdjustment (int oldValue, int shiftStep) |
Constructor & Destructor Documentation
| SpinBox::SpinBox | ( | QWidget * | parent = 0 |
) | [explicit] |
Constructor.
- Parameters:
-
parent The parent object of this widget.
Definition at line 37 of file spinbox.cpp.
| SpinBox::SpinBox | ( | int | minValue, | |
| int | maxValue, | |||
| QWidget * | parent = 0 | |||
| ) |
Constructor.
- Parameters:
-
minValue The minimum value which the spin box can have. maxValue The maximum value which the spin box can have. parent The parent object of this widget.
Definition at line 46 of file spinbox.cpp.
Member Function Documentation
| void SpinBox::addValue | ( | int | change | ) | [inline] |
| int SpinBox::bound | ( | int | val | ) | const |
Returns the specified value clamped to the range of the spin box.
Definition at line 88 of file spinbox.cpp.
| QRect SpinBox::downRect | ( | ) | const |
Receives events destined for the spin widget or for the edit field.
Definition at line 190 of file spinbox.cpp.
| void SpinBox::focusOutEvent | ( | QFocusEvent * | e | ) | [protected, virtual] |
Definition at line 223 of file spinbox.cpp.
| void SpinBox::initStyleOption | ( | QStyleOptionSpinBox & | so | ) | const |
Initialise a QStyleOptionSpinBox with this instance's details.
Definition at line 500 of file spinbox.cpp.
| bool SpinBox::isReadOnly | ( | ) | const [inline] |
| void SpinBox::keyPressEvent | ( | QKeyEvent * | e | ) | [protected, virtual] |
Definition at line 299 of file spinbox.cpp.
| void SpinBox::keyReleaseEvent | ( | QKeyEvent * | e | ) | [protected, virtual] |
Definition at line 305 of file spinbox.cpp.
| int SpinBox::maximum | ( | ) | const [inline] |
| int SpinBox::minimum | ( | ) | const [inline] |
| void SpinBox::mouseDoubleClickEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
Definition at line 239 of file spinbox.cpp.
| void SpinBox::mouseMoveEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
Definition at line 275 of file spinbox.cpp.
| void SpinBox::mousePressEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
Definition at line 233 of file spinbox.cpp.
| void SpinBox::mouseReleaseEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
Definition at line 268 of file spinbox.cpp.
| void SpinBox::paintEvent | ( | QPaintEvent * | pe | ) | [protected, virtual] |
| bool SpinBox::selectOnStep | ( | ) | const [inline] |
| void SpinBox::setMaximum | ( | int | val | ) |
| void SpinBox::setMinimum | ( | int | val | ) |
| void SpinBox::setRange | ( | int | minValue, | |
| int | maxValue | |||
| ) | [inline] |
| void SpinBox::setReadOnly | ( | bool | readOnly | ) | [virtual] |
Sets whether the spin box can be changed by the user.
- Parameters:
-
readOnly True to set the widget read-only, false to set it read-write.
Definition at line 77 of file spinbox.cpp.
| void SpinBox::setSelectOnStep | ( | bool | sel | ) | [inline] |
| void SpinBox::setSingleShiftStep | ( | int | step | ) |
Sets the shifted step increment, i.e.
the amount by which the spin box value changes when a spin button is clicked while the shift key is pressed.
Definition at line 114 of file spinbox.cpp.
| void SpinBox::setSingleStep | ( | int | step | ) |
Sets the unshifted step increment, i.e.
the amount by which the spin box value changes when a spin button is clicked without the shift key being pressed.
Definition at line 107 of file spinbox.cpp.
| void SpinBox::setUpDownOnly | ( | bool | only | ) | [inline] |
| int SpinBox::shiftStepAdjustment | ( | int | oldValue, | |
| int | shiftStep | |||
| ) | [protected, virtual] |
Returns the initial adjustment to the value for a shift step up or down.
The default is to step up or down to the nearest multiple of the shift increment, so the adjustment returned is for stepping up the decrement required to round down to a multiple of the shift increment <= current value, or for stepping down the increment required to round up to a multiple of the shift increment >= current value. This method's caller then adjusts the resultant value if necessary to cater for the widget's minimum/maximum value, and wrapping. This should really be a static method, but it needs to be virtual...
Definition at line 430 of file spinbox.cpp.
| int SpinBox::singleShiftStep | ( | ) | const [inline] |
| int SpinBox::singleStep | ( | ) | const [inline] |
| void SpinBox::stepBy | ( | int | steps | ) | [virtual] |
Called whenever the user triggers a step, to adjust the value of the spin box by the unshifted increment.
Definition at line 121 of file spinbox.cpp.
| void SpinBox::stepped | ( | int | step | ) | [signal] |
Signal emitted when the spin box's value is stepped (by the shifted or unshifted increment).
- Parameters:
-
step The requested step in the spin box's value. Note that the actual change in value may have been less than this.
| QRect SpinBox::upDownRect | ( | ) | const |
Returns the rectangle containing the up and down arrows.
Definition at line 479 of file spinbox.cpp.
| QRect SpinBox::upRect | ( | ) | const |
The documentation for this class was generated from the following files:
