Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

QAbstractSpinBox Class Reference

#include <QAbstractSpinBox>

Inherits QWidget.

Inherited by QDateTimeEdit, QSpinBox, and QDoubleSpinBox.

List of all members.

Public Types

Writable Properties

Read-Only Properties

Public Functions

Public Slots

Signals

Static Public Members

Protected Functions


Detailed Description

The QAbstractSpinBox class provides a spinwidget and a lineedit to display values.

The class is designed as a common super class for widgets like QSpinBox, QDoubleSpinBox and QDateTimeEdit

Here are the main properties of the class:

  1. text: The text that is displayed in the QAbstractSpinBox.
  2. alignment: The alignment of the text in the QAbstractSpinBox.
  3. cleanText: The text of the QAbstractSpinBox exluding any prefix/suffix.
  4. wrapping: Whether the QAbstractSpinBox wraps from the minimum value to the maximum value and vica versa.
  5. tracking: Whether the spinbox validates the text and emits signals for each change in the input.

QAbstractSpinBox provides a virtual stepBy() function that is called whenever the user triggers a step. This function takes an integer value to signify how many steps were taken. E.g. Pressing Qt::Key_Down will trigger a call to stepBy(-1).

QAbstractSpinBox also provide a virtual function stepEnabled() to determine whether stepping up/down is allowed at any point. This function returns a bitset of StepEnabled.


Member Type Documentation

enum QAbstractSpinBox::ButtonSymbols

This enum type determines what the buttons in a spin box show.

QAbstractSpinBox::UpDownArrowsthe buttons show little arrows in the classic style.
QAbstractSpinBox::PlusMinusthe buttons show + and - symbols.

See also QAbstractSpinBox::buttonSymbols.

enum QAbstractSpinBox::StepEnabledFlag
typedef QAbstractSpinBox::StepEnabled

QAbstractSpinBox::StepNone 
QAbstractSpinBox::StepUpEnabled 
QAbstractSpinBox::StepDownEnabled 

The StepEnabled typedef can store a combination of StepEnabledFlag values.


Property Documentation

alignment : Qt::Alignment

This property holds the alignment of the spin box.

Possible Values are Qt::AlignAuto, Qt::AlignLeft, Qt::AlignRight and Qt::AlignHCenter.

Attempting to set the alignment to an illegal flag combination does nothing.

Access functions:

See also Qt::Alignment.

buttonSymbols : ButtonSymbols

This property holds the current button symbol mode.

The possible values can be either UpDownArrows or PlusMinus. The default is UpDownArrows.

Access functions:

See also ButtonSymbols.

cleanText : QString

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

Access functions:

See also text, prefix, and suffix.

slider : bool

This property holds whether the spin box's slider is pressed down.

Access functions:

text : QString

This property holds the spin box's text, including any prefix() and suffix().

There is no default text.

Access functions:

tracking : bool

This property holds whether valueChanged is emitted continuously while typing.

    QSpinBox *sb = new QSpinBox(this);
    sb->setTracking(true);
    // put the keyboard focus in the editor
    // type 1

    // valueChanged(1) is emitted

    // type 2

    // valueChanged(12) is emitted

    // hit return

    // valueChanged(12) is emitted again

By default, tracking is turned off.

Access functions:

See also QSpinBox::minimum() and QSpinBox::maximum().

wrapping : bool

This property holds whether the spin box is circular.

If wrapping is true stepping up from maximum() value will take you to the minimum() value and vica versa. Wrapping only make sense if you have minimum() and maximum() values set.

    QSpinBox *sb = new QSpinBox(0, 100, 1, 0, this);
    sb->setValue(100);
    sb->stepUp();
    // value is 100

    sb->setWrapping(true);
    sb->stepUp();
    // value is 0

By default, wrapping is turned off.

Access functions:

See also QSpinBox::minimum() and QSpinBox::maximum().


Member Function Documentation

QAbstractSpinBox::QAbstractSpinBox ( QWidget * parent = 0 )

Constructs an abstract spinbox.

The parent arguments is sent to the QWidget constructor.

wrapping defaults to false. tracking defaults to false. alignment defaults to Qt::AlignLeft. // ### qlocale

QAbstractSpinBox::~QAbstractSpinBox ()

Called when the QAbstractSpinBox is destroyed.

void QAbstractSpinBox::interpretText ()

This function interprets the text of the spin box. If the value has changed since last interpretation it will emit signals.

QLineEdit * QAbstractSpinBox::lineEdit () const   [protected]

This function returns a pointer to the line edit of the spin box.

void QAbstractSpinBox::stepBy ( int steps )   [virtual protected]

Virtual function that is called whenever the user triggers a step. The steps parameter indicates how many steps were taken, e.g. Pressing Qt::Key_Down will trigger a call to stepBy(-1), whereas pressing Qt::Key_Prior will trigger a call to stepBy(10).

If you subclass QAbstractSpinBox you must reimplement this function. Note that this function is called even if the resulting value will be outside the bounds of minimum and maximum. It's this function's job to handle these situations.

See also QSpinBox::setValue(), QSpinBox::minimum(), and QSpinBox::maximum().

StepEnabled QAbstractSpinBox::stepEnabled () const   [virtual protected]

Virtual function that determines whether stepping up and down is legal at any given time.

The up arrow will be painted as disabled unless stepEnabled() & StepUpEnabled != 0.

The default implementation will return (StepUpEnabled| StepDownEnabled) if wrapping is turned on. Else it will return StepDownEnabled if value is > minimum() or'ed with StepUpEnabled if value < maximum().

If you subclass QAbstractSpinBox you will need to reimplement this function.

See also QSpinBox::minimum(), QSpinBox::maximum(), and wrapping().


Copyright © 2004 Trolltech. Trademarks
Qt 4.0.0-tp1