|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QWidget
com.trolltech.qt.gui.QAbstractSpinBox
com.trolltech.qt.gui.QSpinBox
public class QSpinBox
The QSpinBox class provides a spin box widget.
QSpinBox is designed to handle integers and discrete sets of values (e.g., month names); use QDoubleSpinBox for floating point values.
QSpinBox allows the user to choose a value by clicking the up/down buttons or pressing up/down on the keyboard to increase/decrease the value currently displayed. The user can also type the value in manually. The spin box supports integer values but can be extended to use different strings with validate, textFromValue and valueFromText.
Every time the value changes QSpinBox emits the valueChanged signals. The current value can be fetched with value and set with setValue.
Clicking the up/down buttons or using the keyboard accelerator's up and down arrows will increase or decrease the current value in steps of size singleStep. If you want to change this behaviour you can reimplement the virtual function stepBy. The minimum and maximum value and the step size can be set using one of the constructors, and can be changed later with setMinimum, setMaximum and setSingleStep.
Most spin boxes are directional, but QSpinBox can also operate as a circular spin box, i.e. if the range is 0-99 and the current value is 99, clicking "up" will give 0 if wrapping is set to true. Use setWrapping if you want circular behavior.
The displayed value can be prepended and appended with arbitrary strings indicating, for example, currency or the unit of measurement. See setPrefix and setSuffix. The text in the spin box is retrieved with text (which includes any prefix and suffix), or with cleanText (which has no prefix, no suffix and no leading or trailing whitespace).
It is often desirable to give the user a special (often default) choice in addition to the range of numeric values. See setSpecialValueText for how to do this with QSpinBox.
![]() | A spin box shown in the Windows XP widget style. |
![]() | A spin box shown in the Plastique widget style. |
![]() | A spin box shown in the Macintosh widget style. |
If using prefix, suffix, and specialValueText don't provide enough control, you subclass QSpinBox and reimplement valueFromText and textFromValue. For example, here's the code for a custom spin box that allows the user to enter icon sizes (e.g., "32 x 32"):
int IconSizeSpinBox::valueFromText(const QString &text) const { QRegExp regExp(tr("(\\d+)(\\s*[xx]\\s\*\d+)?")); if (regExp.exactMatch(text)) { return regExp.cap(1).toInt(); } else { return 0; } } QString IconSizeSpinBox::textFromValue(int value) const { return tr("%1 x %1").arg(value); }
See the Icons example for the full source code.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QAbstractSpinBox |
---|
QAbstractSpinBox.ButtonSymbols, QAbstractSpinBox.CorrectionMode, QAbstractSpinBox.StepEnabled, QAbstractSpinBox.StepEnabledFlag |
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QWidget |
---|
QWidget.RenderFlag, QWidget.RenderFlags |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
Field Summary | |
---|---|
QSignalEmitter.Signal1<java.lang.Integer> |
valueChanged
This signal is emitted whenever the spin box's value is changed. |
QSignalEmitter.Signal1<java.lang.String> |
valueStringChanged
The new value is passed literally in arg__1 with no prefix or suffix. |
Fields inherited from class com.trolltech.qt.gui.QAbstractSpinBox |
---|
editingFinished |
Fields inherited from class com.trolltech.qt.gui.QWidget |
---|
customContextMenuRequested |
Constructor Summary | |
---|---|
QSpinBox()
Equivalent to QSpinBox(0). |
|
QSpinBox(QWidget parent)
Constructs a spin box with 0 as minimum value and 99 as maximum value, a step value of 1. |
Method Summary | |
---|---|
java.lang.String |
cleanText()
Returns the text of the spin box excluding any prefix, suffix, or leading or trailing whitespace.. |
boolean |
event(QEvent event)
This function is reimplemented for internal reasons. |
java.lang.String |
fixup(java.lang.String str)
This function is reimplemented for internal reasons. |
static QSpinBox |
fromNativePointer(QNativePointer nativePointer)
This function returns the QSpinBox instance pointed to by nativePointer |
int |
maximum()
Returns the maximum value of the spin box. |
int |
minimum()
Returns the minimum value of the spin box. |
java.lang.String |
prefix()
Returns the spin box's prefix. |
void |
setMaximum(int max)
Sets the maximum value of the spin box to max. |
void |
setMinimum(int min)
Sets the minimum value of the spin box to min. |
void |
setPrefix(java.lang.String prefix)
Sets the spin box's prefix to prefix. |
void |
setRange(int min,
int max)
Convenience function to set the min, and max values with a single function call. |
void |
setSingleStep(int val)
Sets the step value to val. |
void |
setSuffix(java.lang.String suffix)
Sets the suffix of the spin box to suffix. |
void |
setValue(int val)
Sets the value of the spin box to val. |
int |
singleStep()
Returns the step value. |
java.lang.String |
suffix()
Returns the suffix of the spin box. |
protected java.lang.String |
textFromValue(int val)
This virtual function is used by the spin box whenever it needs to display the given val. |
QValidator.State |
validate(QValidator.QValidationData input)
Equivalent to validate(input, ). |
int |
value()
Returns the value of the spin box. |
protected int |
valueFromText(java.lang.String text)
This virtual function is used by the spin box whenever it needs to interpret text entered by the user as a value. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
blockSignals, childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, property, removeEventFilter, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
disconnect, disconnect, signalSender |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1<java.lang.String> valueStringChanged
The new value is passed literally in arg__1 with no prefix or suffix.
public final QSignalEmitter.Signal1<java.lang.Integer> valueChanged
This signal is emitted whenever the spin box's value is changed. The new value's integer value is passed in arg__1.
Constructor Detail |
---|
public QSpinBox()
Equivalent to QSpinBox(0).
public QSpinBox(QWidget parent)
Constructs a spin box with 0 as minimum value and 99 as maximum value, a step value of 1. The value is initially set to 0. It is parented to parent.
Method Detail |
---|
public final java.lang.String cleanText()
Returns the text of the spin box excluding any prefix, suffix, or leading or trailing whitespace..
public final int maximum()
Returns the maximum value of the spin box.
When setting this property the minimum is adjusted if necessary, to ensure that the range remains valid.
The default maximum value is 99.
public final int minimum()
Returns the minimum value of the spin box.
When setting this property the maximum is adjusted if necessary to ensure that the range remains valid.
The default minimum value is 0.
public final java.lang.String prefix()
Returns the spin box's prefix.
The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:
sb->setPrefix("$");
To turn off the prefix display, set this property to an empty string. The default is no prefix. The prefix is not displayed when value == minimum and specialValueText is set.
If no prefix is set, prefix returns an empty string.
public final void setMaximum(int max)
Sets the maximum value of the spin box to max.
When setting this property the minimum is adjusted if necessary, to ensure that the range remains valid.
The default maximum value is 99.
public final void setMinimum(int min)
Sets the minimum value of the spin box to min.
When setting this property the maximum is adjusted if necessary to ensure that the range remains valid.
The default minimum value is 0.
public final void setPrefix(java.lang.String prefix)
Sets the spin box's prefix to prefix.
The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:
sb->setPrefix("$");
To turn off the prefix display, set this property to an empty string. The default is no prefix. The prefix is not displayed when value == minimum and specialValueText is set.
If no prefix is set, prefix returns an empty string.
public final void setRange(int min, int max)
Convenience function to set the min, and max values with a single function call.
setRange(minimum, maximum);
is equivalent to:
setMinimum(minimum); setMaximum(maximum);
public final void setSingleStep(int val)
Sets the step value to val.
When the user uses the arrows to change the spin box's value the value will be incremented/decremented by the amount of the singleStep. The default value is 1. Setting a singleStep value of less than 0 does nothing.
public final void setSuffix(java.lang.String suffix)
Sets the suffix of the spin box to suffix.
The suffix is appended to the end of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:
sb->setSuffix(" km");
To turn off the suffix display, set this property to an empty string. The default is no suffix. The suffix is not displayed for the minimum if specialValueText is set.
If no suffix is set, suffix returns an empty string.
public final void setValue(int val)
Sets the value of the spin box to val.
setValue will emit valueChanged if the new value is different from the old one.
public final int singleStep()
Returns the step value.
When the user uses the arrows to change the spin box's value the value will be incremented/decremented by the amount of the singleStep. The default value is 1. Setting a singleStep value of less than 0 does nothing.
public final java.lang.String suffix()
Returns the suffix of the spin box.
The suffix is appended to the end of the displayed value. Typical use is to display a unit of measurement or a currency symbol. For example:
sb->setSuffix(" km");
To turn off the suffix display, set this property to an empty string. The default is no suffix. The suffix is not displayed for the minimum if specialValueText is set.
If no suffix is set, suffix returns an empty string.
public final int value()
Returns the value of the spin box.
setValue will emit valueChanged if the new value is different from the old one.
public boolean event(QEvent event)
This function is reimplemented for internal reasons.
event
in class QAbstractSpinBox
public java.lang.String fixup(java.lang.String str)
This function is reimplemented for internal reasons.
fixup
in class QAbstractSpinBox
protected java.lang.String textFromValue(int val)
This virtual function is used by the spin box whenever it needs to display the given val. The default implementation returns a string containing val printed in the standard way using QLocale().toString(). Reimplementations may return anything. (See the example in the detailed description.)
Note: QSpinBox does not call this function for specialValueText and that neither prefix nor suffix should be included in the return value.
If you reimplement this, you may also need to reimplement valueFromText and validate
public QValidator.State validate(QValidator.QValidationData input)
Equivalent to validate(input, ).
validate
in class QAbstractSpinBox
protected int valueFromText(java.lang.String text)
This virtual function is used by the spin box whenever it needs to interpret text entered by the user as a value.
Subclasses that need to display spin box values in a non-numeric way need to reimplement this function.
Note: QSpinBox handles specialValueText separately; this function is only concerned with the other values.
public static QSpinBox fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |