Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.trolltech.qt.gui
Class QDoubleSpinBox

    java.lang.Object
      com.trolltech.qt.internal.QSignalEmitterInternal
          com.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.QDoubleSpinBox

All Implemented Interfaces:
  QPaintDeviceInterface, QtJambiInterface

    public class QDoubleSpinBox

extends QAbstractSpinBox

The `QDoubleSpinBox` class provides a spin box widget that takes doubles. `QDoubleSpinBox` allows the user to choose a value by clicking the up and down buttons or by pressing Up or Down on the keyboard to increase or decrease the value currently displayed. The user can also type the value in manually. The spin box supports double values but can be extended to use different strings with `validate()`, `textFromValue()` and `valueFromText()`.

Every time the value changes `QDoubleSpinBox` emits the `valueChanged()` signal. The current value can be fetched with `value()` and set with `setValue()`.

Note: `QDoubleSpinBox` will round numbers so they can be displayed with the current precision. In a `QDoubleSpinBox` with decimals set to 2, calling setValue(2.555) will cause `value()` to return 2.56.

Clicking the up and 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 behavior 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()`. The spinbox has a default precision of 2 decimal places but this can be changed using `setDecimals()`.

Most spin boxes are directional, but `QDoubleSpinBox` can also operate as a circular spin box, i.e. if the range is 0.0-99.9 and the current value is 99.9, 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 `QDoubleSpinBox`.

See also:
  `QSpinBox`, `QDateTimeEdit`, `QSlider`, and Spin Boxes Example.

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, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9`

Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal`

Field Summary
`QSignalEmitter.Signal1` | `valueChanged` This signal takes 1 generic argument(s).
`QSignalEmitter.Signal1` | `valueStringChanged` This signal takes 1 generic argument(s).

Fields inherited from class com.trolltech.qt.gui.QAbstractSpinBox
`editingFinished`

Fields inherited from class com.trolltech.qt.gui.QWidget
`customContextMenuRequested`

Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`currentSender`

Constructor Summary
`QDoubleSpinBox()` Constructs a spin box with 0.
`QDoubleSpinBox(QWidget parent)` Constructs a spin box with 0.

Method Summary
`java.lang.String` | `cleanText()` This property holds the text of the spin box excluding any prefix, suffix, or leading or trailing whitespace.
`int` | `decimals()` This property holds the precision of the spin box, in decimals.
`double` | `maximum()` This property holds the maximum value of the spin box.
`double` | `minimum()` This property holds the minimum value of the spin box.
`java.lang.String` | `prefix()` This property holds the spin box's prefix.
`void` | `setDecimals(int prec)` This property holds the precision of the spin box, in decimals.
`void` | `setMaximum(double max)` This property holds the maximum value of the spin box.
`void` | `setMinimum(double min)` This property holds the minimum value of the spin box.
`void` | `setPrefix(java.lang.String prefix)` This property holds the spin box's prefix.
`void` | `setRange(double min, double max)` Convenience function to set the `minimum` and `maximum` values with a single function call.
`void` | `setSingleStep(double val)` This property holds the step value.
`void` | `setSuffix(java.lang.String suffix)` This property holds the suffix of the spin box.
`void` | `setValue(double val)` This property holds the value of the spin box.
`double` | `singleStep()` This property holds the step value.
`java.lang.String` | `suffix()` This property holds the suffix of the spin box.
`java.lang.String` | `textFromValue(double val)` This virtual function is used by the spin box whenever it needs to display the given `value`.
`double` | `value()` This property holds the value of the spin box.
`double` | `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.gui.QAbstractSpinBox
`alignment, buttonSymbols, clear, correctionMode, fixup, hasAcceptableInput, hasFrame, initStyleOption, interpretText, isAccelerated, isReadOnly, keyboardTracking, lineEdit, selectAll, setAccelerated, setAlignment, setAlignment, setButtonSymbols, setCorrectionMode, setFrame, setKeyboardTracking, setLineEdit, setReadOnly, setSpecialValueText, setWrapping, specialValueText, stepBy, stepDown, stepEnabled, stepUp, text, validate, wrapping`

Methods inherited from class com.trolltech.qt.gui.QWidget
`acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, changeEvent, childAt, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, closeEvent, contentsRect, contextMenuEvent, contextMenuPolicy, cursor, depth, destroy, destroy, destroy, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, ensurePolished, enterEvent, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grabKeyboard, grabMouse, grabMouse, grabShortcut, grabShortcut, hasFocus, hasMouseTracking, height, heightForWidth, heightMM, hide, hideEvent, inputContext, inputMethodEvent, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isFullScreen, isHidden, isMaximized, isMinimized, isModal, isVisible, isVisibleTo, isWindow, isWindowModified, keyboardGrabber, keyPressEvent, keyReleaseEvent, languageChange, layout, layoutDirection, leaveEvent, locale, logicalDpiX, logicalDpiY, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, move, moveEvent, nativeParentWidget, nextInFocusChain, normalGeometry, numColors, overrideWindowFlags, overrideWindowFlags, paintEngine, paintEvent, paintingActive, palette, parentWidget, physicalDpiX, physicalDpiY, pos, raise, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, render, render, render, render, render, render, render, render, repaint, repaint, repaint, repaint, resetInputContext, resize, resize, resizeEvent, restoreGeometry, saveGeometry, scroll, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setBaseSize, setContentsMargins, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedSize, setFixedWidth, setFocus, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGeometry, setHidden, setInputContext, setLayout, setLayoutDirection, setLocale, setMask, setMask, setMaximumHeight, setMaximumSize, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setParent, setParent, setShortcutAutoRepeat, setShortcutAutoRepeat, setShortcutEnabled, setShortcutEnabled, setSizeIncrement, setSizeIncrement, setSizePolicy, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setUpdatesEnabled, setVisible, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowState, setWindowTitle, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeHint, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, underMouse, unsetCursor, unsetLayoutDirection, unsetLocale, update, update, update, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, widthMM, window, windowFilePath, windowFlags, windowIcon, windowIconText, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowType, winId, x, y`

Methods inherited from class com.trolltech.qt.core.QObject
`childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty`

Methods inherited from class com.trolltech.qt.QtJambiObject
`dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr`

Methods inherited from class com.trolltech.qt.QSignalEmitter
`blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread`

Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`__qt_signalInitialization`

Methods inherited from class java.lang.Object
`clone, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.trolltech.qt.QtJambiInterface
`disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership`

Field Detail

### valueStringChanged

    public final QSignalEmitter.Signal1 valueStringChanged

  This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.String(named: arg__1)>:

### valueChanged

    public final QSignalEmitter.Signal1 valueChanged

  This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Double(named: d)>:

  This signal is emitted whenever the spin box's value is changed. The new value is passed in `d`.

Constructor Detail

### QDoubleSpinBox

    public QDoubleSpinBox()

  Constructs a spin box with 0. as minimum value and 99.99 as maximum value, a step value of 1.0 and a precision of 2 decimal places. The value is initially set to 0.00. The spin box has the given `parent`.

See also:
  `setMinimum()`, `setMaximum()`, and `setSingleStep()`.

### QDoubleSpinBox

    public QDoubleSpinBox(QWidget parent)

  Constructs a spin box with 0. as minimum value and 99.99 as maximum value, a step value of 1.0 and a precision of 2 decimal places. The value is initially set to 0.00. The spin box has the given `parent`.

See also:
  `setMinimum()`, `setMaximum()`, and `setSingleStep()`.

Method Detail

### cleanText

    public final java.lang.String cleanText()

  This property holds the text of the spin box excluding any prefix, suffix, or leading or trailing whitespace.

See also:
  `text`, `QDoubleSpinBox::prefix`, and `QDoubleSpinBox::suffix`.

### decimals

    public final int decimals()

  This property holds the precision of the spin box, in decimals. Sets how many decimals the spinbox will use for displaying and interpreting doubles.

  Warning: The results might not be reliable with very high values for `decimals`.

  Note: The maximum, minimum and value might change as a result of changing this property.

### maximum

    public final double maximum()

  This property holds 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.99.

  Note: The maximum value will be rounded to match the decimals property.

See also:
  `decimals`, and `setRange()`.

### minimum

    public final double minimum()

  This property holds 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.0.

  Note: The minimum value will be rounded to match the decimals property.

See also:
  `decimals`, `setRange()`, and `specialValueText`.

### prefix

    public final java.lang.String prefix()

  This property holds 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:

              spinbox.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.

See also:
  `suffix()`, `setSuffix()`, specialValueText(), and setSpecialValueText().

### setDecimals

    public final void setDecimals(int prec)

  This property holds the precision of the spin box, in decimals. Sets how many decimals the spinbox will use for displaying and interpreting doubles.

  Warning: The results might not be reliable with very high values for `decimals`.

  Note: The maximum, minimum and value might change as a result of changing this property.

### setMaximum

    public final void setMaximum(double max)

  This property holds 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.99.

  Note: The maximum value will be rounded to match the decimals property.

See also:
  `decimals`, and `setRange()`.

### setMinimum

    public final void setMinimum(double min)

  This property holds 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.0.

  Note: The minimum value will be rounded to match the decimals property.

See also:
  `decimals`, `setRange()`, and `specialValueText`.

### setPrefix

    public final void setPrefix(java.lang.String prefix)

  This property holds 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:

              spinbox.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.

See also:
  `suffix()`, `setSuffix()`, specialValueText(), and setSpecialValueText().

### setRange

    public final void setRange(double min,
                               double max)

  Convenience function to set the `minimum` and `maximum` values with a single function call.

  Note: The maximum and minimum values will be rounded to match the decimals property.

              spinbox.setRange(minimum, maximum);

  is equivalent to:

              spinbox.setMinimum(minimum);
              spinbox.setMaximum(maximum);

See also:
  `minimum`, and `maximum`.

### setSingleStep

    public final void setSingleStep(double val)

  This property holds 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.0. Setting a `singleStep` value of less than 0 does nothing.

### setSuffix

    public final void setSuffix(java.lang.String suffix)

  This property holds 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:

              spinbox.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.

See also:
  `prefix()`, `setPrefix()`, specialValueText(), and setSpecialValueText().

### setValue

    public final void setValue(double val)

  This property holds the value of the spin box. `setValue()` will emit `valueChanged()` if the new value is different from the old one.

  Note: The value will be rounded so it can be displayed with the current setting of decimals.

See also:
  `decimals`.

### singleStep

    public final double singleStep()

  This property holds 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.0. Setting a `singleStep` value of less than 0 does nothing.

### suffix

    public final java.lang.String suffix()

  This property holds 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:

              spinbox.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.

See also:
  `prefix()`, `setPrefix()`, specialValueText(), and setSpecialValueText().

### value

    public final double value()

  This property holds the value of the spin box. `setValue()` will emit `valueChanged()` if the new value is different from the old one.

  Note: The value will be rounded so it can be displayed with the current setting of decimals.

See also:
  `decimals`.

### textFromValue

    public java.lang.String textFromValue(double val)

  This virtual function is used by the spin box whenever it needs to display the given `value`. The default implementation returns a string containing `value` printed using `QWidget::locale()`.toString(`value`, QLatin1Char('f'), `decimals()`) and will remove the thousand separator. Reimplementations may return anything.

  Note: `QDoubleSpinBox` 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()`.

See also:
  `valueFromText()`.

### valueFromText

    public double 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: `QDoubleSpinBox` handles specialValueText() separately; this function is only concerned with the other values.

See also:
  `textFromValue()`, and `validate()`.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD