Improve QAbstractSpinBox::stepBy() docs

Change-Id: I28e942b6b2952205641c751e4c120cb38ae13fd6
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
bb10
Mitch Curtis 2018-04-05 15:11:43 +02:00
parent 2823cc6d4b
commit a14bfea500
1 changed files with 4 additions and 5 deletions

View File

@ -611,12 +611,11 @@ void QAbstractSpinBox::stepDown()
}
/*!
Virtual function that is called whenever the user triggers a step.
The \a 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).
The \a steps parameter indicates how many steps were taken.
For example, pressing \c Qt::Key_Down will trigger a call to \c stepBy(-1),
whereas pressing \c Qt::Key_PageUp will trigger a call to \c stepBy(10).
If you subclass QAbstractSpinBox you must reimplement this
If you subclass \c 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.