GtkSpinButton
GtkSpinButton — Получение целого или дробного числа от пользователя
Функции
Свойства
| GtkAdjustment * | adjustment | Чтение / Запись |
| gdouble | climb-rate | Чтение / Запись |
| guint | digits | Чтение / Запись |
| gboolean | numeric | Чтение / Запись |
| gboolean | snap-to-ticks | Чтение / Запись |
| GtkSpinButtonUpdatePolicy | update-policy | Чтение / Запись |
| gdouble | value | Чтение / Запись |
| gboolean | wrap | Чтение / Запись |
Стилизованные свойства
| GtkShadowType | shadow-type | Чтение |
Сигналы
Типы и значения
| struct | GtkSpinButton |
| enum | GtkSpinButtonUpdatePolicy |
| enum | GtkSpinType |
| #define | GTK_INPUT_ERROR |
Иерархия объектов
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkEntry ╰── GtkSpinButton
Реализованные интерфейсы
GtkSpinButton реализует AtkImplementorIface, GtkBuildable, GtkEditable, GtkCellEditable и GtkOrientable.
Включенные файлы
#include <gtk/gtk.h>
Описание
GtkSpinButton — это удобный способ позволить пользователю задать значение некоторого атрибута. Вместо того, чтобы вводить число напрямую в GtkEntry, GtkSpinButton позволяет пользователю щелкнуть по одной из двух стрелок, чтобы увеличить или уменьшить отображаемое значение. Значение всё ещё можно ввести вручную, с возможностью проверки, чтобы оно находилось в заданном диапазоне.
Основные свойства GtkSpinButton определяются через настройку. Смотрите раздел GtkAdjustment для получения более подробной информации о свойствах настройки. Обратите внимание, что по умолчанию GtkSpinButton сделает свой ввод достаточно широким, чтобы вместить нижнюю и верхнюю границы настройки, что может привести к неожиданным результатам. Лучшей практикой является установка как “ширина-символов”, так и “максимальная-ширина-символов” свойств до желаемого количества символов для отображения в поле ввода.
CSS-узлы
Основной CSS-узел GtkSpinButton имеет имя spinbutton. Он создаёт подузлы для поля ввода и двух кнопок с этими именами. Кнопки имеют классы стилей .up и .down. Подузлы GtkEntry (если они есть) размещаются под узлом ввода. Ориентация спин-кнопки отражается в классе стиля .vertical или .horizontal на основном узле.
Использование GtkSpinButton для получения целого числа
Использование GtkSpinButton для получения значения с плавающей точкой
Функции
gtk_spin_button_configure ()
void gtk_spin_button_configure (GtkSpinButton *spin_button,GtkAdjustment *adjustment,gdouble climb_rate,guint digits);
Изменяет свойства существующей кнопки спин. Регулировка, скорость изменения и количество знаков после запятой изменяются соответственно после вызова этой функции.
Параметры
spin_button | кнопка GtkSpinButton | |
adjustment | объект GtkAdjustment. | [allow-none] |
climb_rate | новая скорость изменения | |
digits | количество знаков после запятой для отображения в кнопке спин |
gtk_spin_button_new ()
GtkWidget * gtk_spin_button_new (GtkAdjustment *adjustment,gdouble climb_rate,guint digits);
Создаёт новую кнопку GtkSpinButton.
Параметры
adjustment | объект GtkAdjustment, который должна использовать эта кнопка спин, или | [allow-none] |
climb_rate | устанавливает, на сколько меняется значение кнопки спин при нажатии на стрелку | |
digits | количество знаков после запятой для отображения |
Возвращаемое значение
Новая кнопка спин в виде GtkWidget
gtk_spin_button_new_with_range ()
GtkWidget * gtk_spin_button_new_with_range (gdouble min,gdouble max,gdouble step);
Это удобный конструктор, который позволяет создать числовую кнопку GtkSpinButton, не создавая вручную объект регулировки. Значение по умолчанию — минимальное значение, а шаг изменения — 10 * step. Точность кнопки спин эквивалентна точности step.
Обратите внимание, что способ получения точности лучше всего работает, если step является степенью десятки. Если полученная точность не подходит для ваших нужд, используйте gtk_spin_button_set_digits(), чтобы её исправить.
Параметры
min | Минимальное допустимое значение | |
max | Максимальное допустимое значение | |
step | Шаг, добавляемый или вычитаемый при вращении виджета |
Возвращаемое значение
Новая кнопка спин в виде GtkWidget
gtk_spin_button_set_adjustment ()
void gtk_spin_button_set_adjustment (GtkSpinButton *spin_button,GtkAdjustment *adjustment);
Заменяет GtkAdjustment, связанный с spin_button.
Параметры
spin_button | кнопка GtkSpinButton | |
adjustment | GtkAdjustment для замены существующей регулировки |
gtk_spin_button_get_adjustment ()
GtkAdjustment *
gtk_spin_button_get_adjustment (GtkSpinButton *spin_button); Получить объект регулировки, связанный с кнопкой GtkSpinButton.
Параметры
spin_button | кнопка GtkSpinButton |
gtk_spin_button_set_digits ()
void gtk_spin_button_set_digits (GtkSpinButton *spin_button,guint digits);
Устанавливает точность отображения spin_button. Допускается точность до 20 знаков.
Параметры
spin_button | кнопка GtkSpinButton | |
digits | количество знаков после запятой для отображения значения кнопки спин |
gtk_spin_button_set_increments ()
void gtk_spin_button_set_increments (GtkSpinButton *spin_button,gdouble step,gdouble page);
Устанавливает шаги и страницы изменения для кнопки спин. Это влияет на то, как быстро изменяется значение при нажатии на стрелки кнопки спин.
Параметры
spin_button | кнопка GtkSpinButton | |
step | приращение, применяемое при нажатии одной кнопки. | |
page | приращение, применяемое при нажатии второй кнопки. |
gtk_spin_button_set_range ()
void gtk_spin_button_set_range (GtkSpinButton *spin_button,gdouble min,gdouble max);
Устанавливает минимальное и максимальное допустимые значения для spin_button.
Если текущее значение находится вне этого диапазона, оно будет скорректировано, чтобы вписаться в диапазон, в противном случае оно останется без изменений.
Параметры
spin_button | кнопка GtkSpinButton | |
min | минимальное допустимое значение | |
max | максимальное допустимое значение |
gtk_spin_button_get_value_as_int ()
gint
gtk_spin_button_get_value_as_int (GtkSpinButton *spin_button); Получить значение spin_button, представленное как целое число.
Параметры
spin_button | кнопка GtkSpinButton |
Возвращаемое значение
значение spin_button
gtk_spin_button_set_value ()
void gtk_spin_button_set_value (GtkSpinButton *spin_button,gdouble value);
Устанавливает значение spin_button.
Параметры
spin_button | кнопка GtkSpinButton | |
value | новое значение |
gtk_spin_button_set_update_policy ()
void gtk_spin_button_set_update_policy (GtkSpinButton *spin_button,GtkSpinButtonUpdatePolicy policy);
Устанавливает поведение обновления спин-кнопки. Это определяет, обновляется ли спин-кнопка всегда или только при установке допустимого значения.
Параметры
spin_button | ||
policy | значение GtkSpinButtonUpdatePolicy |
gtk_spin_button_set_numeric ()
void gtk_spin_button_set_numeric (GtkSpinButton *spin_button,gboolean numeric);
Устанавливает флаг, определяющий, может ли в спин-кнопку вводиться нечисловой текст.
Параметры
spin_button | ||
numeric | флаг, указывающий, разрешено ли ввод только чисел |
gtk_spin_button_spin ()
void gtk_spin_button_spin (GtkSpinButton *spin_button,GtkSpinType direction,gdouble increment);
Увеличивает или уменьшает значение спин-кнопки в заданном направлении на заданную величину.
Параметры
spin_button | ||
direction | значение GtkSpinType, указывающее направление вращения | |
increment | приращение шага для применения в заданном направлении |
gtk_spin_button_set_wrap ()
void gtk_spin_button_set_wrap (GtkSpinButton *spin_button,gboolean wrap);
Устанавливает флаг, определяющий, будет ли значение спин-кнопки циклически переходить к противоположному пределу при превышении верхнего или нижнего предела диапазона.
Параметры
spin_button | ||
wrap | флаг, указывающий, выполняется ли поведение обхода |
gtk_spin_button_set_snap_to_ticks ()
void gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button,gboolean snap_to_ticks);
Устанавливает политику, определяющую, будут ли значения корректироваться до ближайшего приращения шага, когда спин-кнопка активируется после ввода недопустимого значения.
Параметры
spin_button | ||
snap_to_ticks | флаг, указывающий, следует ли исправлять недопустимые значения |
gtk_spin_button_update ()
void
gtk_spin_button_update (GtkSpinButton *spin_button); Принудительно обновляет спин-кнопку.
Параметры
spin_button |
gtk_spin_button_get_digits ()
guint
gtk_spin_button_get_digits (GtkSpinButton *spin_button); Извлекает точность spin_button. См. gtk_spin_button_set_digits().
Параметры
spin_button |
Возвращаемое значение
текущая точность
gtk_spin_button_get_increments ()
void gtk_spin_button_get_increments (GtkSpinButton *spin_button,gdouble *step,gdouble *page);
Получает текущие значения шага и страницы приращений, используемых spin_button. См. gtk_spin_button_set_increments().
gtk_spin_button_get_numeric ()
gboolean
gtk_spin_button_get_numeric (GtkSpinButton *spin_button); Возвращает значение, определяющее, может ли в спин-кнопку вводиться нечисловой текст. См. gtk_spin_button_set_numeric().
Параметры
spin_button |
Возвращаемое значение
TRUE, если ввод допускает только числовой текст
gtk_spin_button_get_range ()
void gtk_spin_button_get_range (GtkSpinButton *spin_button,gdouble *min,gdouble *max);
Получает диапазон, разрешённый для spin_button. См. gtk_spin_button_set_range().
gtk_spin_button_get_snap_to_ticks ()
gboolean
gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button); Возвращает значение, определяющее, корректируются ли значения до ближайшего шага. См. gtk_spin_button_set_snap_to_ticks().
Параметры
spin_button |
Возвращаемое значение
TRUE, если значения привязаны к ближайшему шагу
gtk_spin_button_get_update_policy ()
GtkSpinButtonUpdatePolicy
gtk_spin_button_get_update_policy (GtkSpinButton *spin_button); Получение поведения обновления спин-кнопки. См. gtk_spin_button_set_update_policy().
Параметры
spin_button |
Возвращаемое значение
текущая политика обновления
gtk_spin_button_get_value ()
gdouble
gtk_spin_button_get_value (GtkSpinButton *spin_button); Получение значения в spin_button.
Параметры
spin_button |
Возвращаемое значение
значение spin_button
gtk_spin_button_get_wrap ()
gboolean
gtk_spin_button_get_wrap (GtkSpinButton *spin_button); Возвращает, будет ли значение спин-кнопки циклически переходить к противоположному пределу при превышении верхнего или нижнего предела диапазона. См. gtk_spin_button_set_wrap().
Параметры
spin_button |
Возвращаемое значение
TRUE, если спин-кнопка циклически переходит к другому пределу
Типы и значения
struct GtkSpinButton
struct GtkSpinButton;
Структура GtkSpinButton содержит только закрытые данные и не должна изменяться напрямую.
перечисление GtkSpinButtonUpdatePolicy
Политика обновления спин-кнопки определяет, отображаются ли значения спин-кнопки, даже если они находятся вне границ её настройки. См. gtk_spin_button_set_update_policy().
Элементы
GTK_UPDATE_ALWAYS | При обновлении GtkSpinButton значение всегда отображается | |
GTK_UPDATE_IF_VALID | При обновлении GtkSpinButton значение отображается только в том случае, если оно допустимо в пределах границ настройки спин-кнопки |
перечисление GtkSpinType
Значения перечисления GtkSpinType используются для указания изменения, которое нужно внести в gtk_spin_button_spin().
Элементы
GTK_SPIN_STEP_FORWARD | Увеличение на шаг изменения. | |
GTK_SPIN_STEP_BACKWARD | Уменьшение на шаг изменения. | |
GTK_SPIN_PAGE_FORWARD | Увеличение на страницу изменения. | |
GTK_SPIN_PAGE_BACKWARD | Уменьшение на страницу изменения. | |
GTK_SPIN_HOME | Переход к нижней границе изменения. | |
GTK_SPIN_END | Переход к верхней границе изменения. | |
GTK_SPIN_USER_DEFINED | Изменение на указанное значение. |
GTK_INPUT_ERROR
#define GTK_INPUT_ERROR -1
Константа, возвращаемая обработчиком сигнала для сигнала “input” в случае сбоя преобразования.
Подробное описание свойств
Свойство “adjustment”
“adjustment” GtkAdjustment *
Настройка, которая содержит значение спин-кнопки.
Флаги: Чтение / Запись
Свойство “climb-rate”
“climb-rate” gdouble
Скорость ускорения при удерживании кнопки.
Флаги: Чтение / Запись
Допустимые значения: >= 0
Значение по умолчанию: 0
Свойство “digits”
“digits” guint
Количество десятичных знаков для отображения.
Флаги: Чтение / Запись
Допустимые значения: <= 20
Значение по умолчанию: 0
Свойство “numeric”
“numeric” gboolean
Должны ли игнорироваться нечисловые символы.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
Свойство “snap-to-ticks”
“snap-to-ticks” gboolean
Автоматически ли изменяются ошибочные значения на ближайший шаг спин-кнопки.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
Свойство “update-policy”
“update-policy” GtkSpinButtonUpdatePolicy
Должна ли спин-кнопка обновляться всегда или только тогда, когда значение является допустимым.
Флаги: Чтение / Запись
Значение по умолчанию: GTK_UPDATE_ALWAYS
Свойство “value”
“value” gdouble
Считывает текущее значение или устанавливает новое.
Флаги: Чтение / Запись
Значение по умолчанию: 0
Свойство “wrap”
“wrap” gboolean
Должна ли спин-кнопка переходить к противоположному пределу при достижении границ.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
Подробное описание свойств стиля
Свойство стиля “shadow-type”
“shadow-type” GtkShadowType
Стиль фаски вокруг спин-кнопки.
GtkSpinButton:shadow-type устарел с версии 3.20 и не должен использоваться в новых кодах.
Используйте CSS для определения стиля границы; значение этого свойства стиля игнорируется.
Флаги: Чтение
Значение по умолчанию: GTK_SHADOW_IN
Подробности сигналов
Сигнал “change-value”
void user_function (GtkSpinButton *spin_button, GtkScrollType scroll, gpointer user_data)
Сигнал ::change-value — это сигнал переназначения клавиш, который генерируется при изменении значения пользователем.
Приложениям не следует подключаться к нему, но они могут генерировать его с помощью g_signal_emit_by_name(), если им нужно программно управлять курсором.
По умолчанию для этого сигнала назначены клавиши Вверх/Вниз и PageUp/PageDown.
Параметры
spin_button | объект, на котором был сгенерирован сигнал | |
scroll | тип GtkScrollType, определяющий скорость и величину изменения | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Флаги: Действие
Сигнал “input”
gint user_function (GtkSpinButton *spin_button, gpointer new_value, gpointer user_data)
Сигнал ::input можно использовать для управления преобразованием пользовательского ввода в значение типа double. Обработчик сигнала должен использовать gtk_entry_get_text() для получения текста поля ввода и установить new_value в новое значение.
По умолчанию преобразование выполняется с помощью g_strtod().
Параметры
spin_button | объект, на котором был сгенерирован сигнал | |
new_value | место возврата нового значения. | [out][type double] |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Возвращаемое значение
TRUE для успешного преобразования, FALSE, если ввод не был обработан, и GTK_INPUT_ERROR, если преобразование завершилось с ошибкой.
Флаги: Выполнить последним
Сигнал “output”
gboolean user_function (GtkSpinButton *spin_button, gpointer user_data)
Сигнал ::output можно использовать для изменения формата отображаемого значения в поле ввода спин-кнопки.
spinbutton.horizontal ├── entry │ ╰── ... ├── button.down ╰── button.up
Параметры
spin_button | объект, на котором был сгенерирован сигнал | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Возвращаемое значение
TRUE, если значение было отображено.
Флаги: Выполнить последним
Сигнал “value-changed”
void user_function (GtkSpinButton *spin_button, gpointer user_data)
Сигнал ::value-changed генерируется при изменении значения, представленного spinbutton. Также см. сигнал “output”.
Параметры
spin_button | объект, на котором был сгенерирован сигнал | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Флаги: Выполнить последним
Сигнал “wrapped”
void user_function (GtkSpinButton *spin_button, gpointer user_data)
Сигнал ::wrapped генерируется сразу после того, как значение спин-кнопки переходит от максимального к минимальному значению или наоборот.
Параметры
spin_button | объект, на котором был сгенерирован сигнал | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Флаги: Выполнить последним
С версии 2.10
См. также
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.20/GtkSpinButton.html