Класс QSpinBox

Класс QSpinBox предоставляет виджет спин-бокса. Подробнее...

• Список всех членов, включая наследуемые члены

Свойства

Открытые функции

Открытые слоты

Сигналы

Защищенные функции

Переопределенные защищенные функции

Подробное описание

QSpinBox предназначен для работы с целыми числами и дискретными наборами значений (например, названиями месяцев); используйте QDoubleSpinBox для значений с плавающей точкой.

QSpinBox позволяет пользователю выбирать значение, нажимая кнопки «вверх/вниз» или нажимая клавиши «вверх/вниз» на клавиатуре для увеличения/уменьшения текущего значения. Пользователь также может ввести значение вручную. Спин-бокс поддерживает целые значения, но может быть расширен для использования различных строк с помощью validate(), textFromValue() и valueFromText().

Каждый раз, когда значение изменяется, QSpinBox излучает сигналы valueChanged() и textChanged(), первый из которых предоставляет int, а второй — QString. Сигнал textChanged() предоставляет значение с префиксом prefix() и суффиксом suffix(). Текущее значение можно получить с помощью value() и установить с помощью setValue().

Нажатие кнопок «вверх/вниз» или использование клавиш-акселераторов «вверх» и «вниз» увеличит или уменьшит текущее значение на шаги размером singleStep(). Если вы хотите изменить это поведение, вы можете переопределить виртуальную функцию stepBy(). Минимальное и максимальное значения, а также шаг могут быть установлены с помощью одного из конструкторов и могут быть изменены позже с помощью setMinimum(), setMaximum() и setSingleStep().

Большинство спин-боксов направленные, но QSpinBox также может работать как циклический спин-бокс, т.е. если диапазон 0-99, а текущее значение 99, нажатие «вверх» даст 0, если wrapping() установлено в true. Используйте setWrapping(), если вам нужно циклическое поведение.

Отображаемое значение можно дополнить и добавить произвольными строками, указывающими, например, валюту или единицу измерения. См. setPrefix() и setSuffix(). Текст в спин-боксе извлекается с помощью text() (который включает любые prefix() и suffix()), или с помощью cleanText() (который не имеет prefix(), не имеет suffix() и не имеет начального или конечного пробела).

Часто желательно предоставить пользователю специальный (часто по умолчанию) выбор помимо диапазона числовых значений. См. setSpecialValueText() для того, как это сделать с QSpinBox.

Наследование QSpinBox

Если использование prefix(), suffix() и specialValueText() не обеспечивает достаточного контроля, вы наследуете QSpinBox и переопределяете valueFromText() и textFromValue(). Например, вот код пользовательского спин-бокса, который позволяет пользователю вводить размеры значков (например, «32 x 32»):

int IconSizeSpinBox::valueFromText(const QString &text) const
{
    static const QRegularExpression regExp(tr("(\\d+)(\\s*[xx]\\s*\\d+)?"));
    Q_ASSERT(regExp.isValid());

    const QRegularExpressionMatch match = regExp.match(text);
    if (match.isValid())
        return match.captured(1).toInt();
    return 0;
}

QString IconSizeSpinBox::textFromValue(int value) const
{
    return tr("%1 x %1").arg(value);
}

См. пример Icons для полного исходного кода.

См. также QDoubleSpinBox, QDateTimeEdit, QSlider и Пример Spin Boxes.

sb->setPrefix("$");

sb->setSuffix(" km");

Документация функций-членов

QSpinBox::QSpinBox(QWidget *parent = nullptr)

Создаёт поле ввода с минимальным значением 0 и максимальным значением 99, значением шага 1. Значение по умолчанию — 0. Родительским элементом является parent.

См. также setMinimum(), setMaximum() и setSingleStep().

[signal, since 5.14] void QSpinBox::textChanged(const QString &text)

Этот сигнал излучается всякий раз, когда текст поля ввода изменяется. Новый текст передаётся в text с prefix() и suffix().

Эта функция была введена в Qt 5.14.

[signal] void QSpinBox::valueChanged(int i)

Этот сигнал излучается всякий раз, когда значение поля ввода изменяется. Новое целочисленное значение передаётся в i.

Примечание: Сигнал-уведомление для свойства value.

[virtual] QSpinBox::~QSpinBox()

Деструктор.

[override virtual protected] bool QSpinBox::event(QEvent *event)

Переопределяет: QAbstractSpinBox::event(QEvent *event).

[override virtual protected] void QSpinBox::fixup(QString &input) const

Переопределяет: QAbstractSpinBox::fixup(QString &input) const.

void QSpinBox::setRange(int minimum, int maximum)

Удобная функция для установки минимального и максимального значений с помощью одной функции.

setRange(minimum, maximum);

эквивалентно:

setMinimum(minimum);
setMaximum(maximum);

См. также minimum и maximum.

[since 5.12] void QSpinBox::setStepType(QAbstractSpinBox::StepType stepType)

Устанавливает тип шага для поля ввода на stepType, который может быть одиночным или адаптивным десятичным.

Адаптивный десятичный шаг означает, что размер шага будет непрерывно корректироваться до степени десяти ниже текущего значения. Таким образом, когда значение равно 1100, шаг устанавливается в 100, поэтому увеличение шага один раз увеличивает его до 1200. Для 1200 увеличение шага приводит к 1300. Для отрицательных значений, уменьшение шага от -1100 переходит к -1200.

Направление шага учитывается для обработки граничных случаев, так что уменьшение шага от 100 приводит к значению 99, а не 90. Таким образом, увеличение шага, за которым следует уменьшение шага — или наоборот — всегда приводит к исходному значению; 99 -> 100 -> 99.

Установка этого параметра приведет к тому, что спин-бокс проигнорирует значение singleStep, хотя оно сохраняется, чтобы singleStep вступил в силу, если адаптивный десятичный шаг будет позже отключен.

Примечание: Функция-сеттер для свойства stepType.

Эта функция была введена в Qt 5.12.

См. также stepType().

[virtual protected] QString QSpinBox::textFromValue(int value) const

Эта виртуальная функция используется спин-боксом всякий раз, когда ему нужно отобразить данное значение value. По умолчанию реализация возвращает строку, содержащую value, напечатанную стандартным способом с помощью QWidget::locale().toString(), но с удалением разделителя тысяч, если не установлен setGroupSeparatorShown(). Переопределения могут вернуть что угодно. (См. пример в подробном описании.)

Примечание: QSpinBox не вызывает эту функцию для specialValueText(), и ни prefix(), ни suffix() не должны быть включены в возвращаемое значение.

Если вы переопределяете эту функцию, вам, возможно, также потребуется переопределить valueFromText() и validate()

См. также valueFromText(), validate() и QLocale::groupSeparator().

[override virtual protected] QValidator::State QSpinBox::validate(QString &text, int &pos) const

Переопределяет: QAbstractSpinBox::validate(QString &input, int &pos) const.

[virtual protected] int QSpinBox::valueFromText(const QString &text) const

Эта виртуальная функция используется спин-боксом всякий раз, когда ему необходимо интерпретировать text, введенную пользователем, как значение.

Подклассы, которым нужно отображать значения спин-бокса нечисловым способом, должны переопределить эту функцию.

Примечание: QSpinBox обрабатывает specialValueText() отдельно; эта функция касается только других значений.

См. также textFromValue() и validate().