gtkspinbutton

			gtk+ reference manual
top \| description \| object hierarchy \| implemented interfaces \| properties \| style properties \| signals

gtkspinbutton — пользовательское определение целого или числа с плавающей точкой

краткое описание

#include <gtk/gtk.h>


            gtkspinbutton;
enum        gtkspinbuttonupdatepolicy;
enum        gtkspintype;
void        gtk_spin_button_configure       (gtkspinbutton *spin_button,
                                             gtkadjustment *adjustment,
                                             gdouble climb_rate,
                                             guint digits);

gtkwidget*  gtk_spin_button_new             (gtkadjustment *adjustment,
                                             gdouble climb_rate,
                                             guint digits);
gtkwidget*  gtk_spin_button_new_with_range  (gdouble min,
                                             gdouble max,
                                             gdouble step);
void        gtk_spin_button_set_adjustment  (gtkspinbutton *spin_button,
                                             gtkadjustment *adjustment);

gtkadjustment* gtk_spin_button_get_adjustment
                                            (gtkspinbutton *spin_button);
void        gtk_spin_button_set_digits      (gtkspinbutton *spin_button,
                                             guint digits);
void        gtk_spin_button_set_increments  (gtkspinbutton *spin_button,
                                             gdouble step,
                                             gdouble page);
void        gtk_spin_button_set_range       (gtkspinbutton *spin_button,
                                             gdouble min,
                                             gdouble max);
#define     gtk_spin_button_get_value_as_float

gint        gtk_spin_button_get_value_as_int
                                            (gtkspinbutton *spin_button);
void        gtk_spin_button_set_value       (gtkspinbutton *spin_button,
                                             gdouble value);
void        gtk_spin_button_set_update_policy

                                            (gtkspinbutton *spin_button,
                                             gtkspinbuttonupdatepolicy policy);
void        gtk_spin_button_set_numeric     (gtkspinbutton *spin_button,
                                             gboolean numeric);
void        gtk_spin_button_spin            (gtkspinbutton *spin_button,
                                             gtkspintype direction,
                                             gdouble increment);
void        gtk_spin_button_set_wrap        (gtkspinbutton *spin_button,
                                             gboolean wrap);
void        gtk_spin_button_set_snap_to_ticks

                                            (gtkspinbutton *spin_button,
                                             gboolean snap_to_ticks);
void        gtk_spin_button_update          (gtkspinbutton *spin_button);
guint       gtk_spin_button_get_digits      (gtkspinbutton *spin_button);
void        gtk_spin_button_get_increments  (gtkspinbutton *spin_button,
                                             gdouble *step,
                                             gdouble *page);

gboolean    gtk_spin_button_get_numeric     (gtkspinbutton *spin_button);
void        gtk_spin_button_get_range       (gtkspinbutton *spin_button,
                                             gdouble *min,
                                             gdouble *max);

gboolean    gtk_spin_button_get_snap_to_ticks
                                            (gtkspinbutton *spin_button);
gtkspinbuttonupdatepolicy gtk_spin_button_get_update_policy
                                            (gtkspinbutton *spin_button);

gdouble     gtk_spin_button_get_value       (gtkspinbutton *spin_button);
gboolean    gtk_spin_button_get_wrap        (gtkspinbutton *spin_button);
#define     gtk_input_error

иерархия объектов

  gobject
   +----ginitiallyunowned
         +----gtkobject

               +----gtkwidget
                     +----gtkentry
                           +----gtkspinbutton

осуществляемые интерфейсы

gtkspinbutton осуществляет atkimplementoriface, gtkcelleditable и gtkeditable.

свойства

  "adjustment"           gtkadjustment         : read / write
  "climb-rate"           gdouble               : read / write
  "digits"               guint                 : read / write
  "numeric"              gboolean              : read / write
  "snap-to-ticks"        gboolean              : read / write
  "update-policy"        gtkspinbuttonupdatepolicy  : read / write
  "value"                gdouble               : read / write
  "wrap"                 gboolean              : read / write

свойства стиля

  "shadow-type"          gtkshadowtype         : read

сигналы

"change-value"
            void        user_function      (gtkspinbutton *spinbutton,
                                            gtkscrolltype *arg1,
                                            gpointer       user_data)       : run last / action
"input"     gint        user_function      (gtkspinbutton *spinbutton,
                                            gpointer       arg1,
                                            gpointer       user_data)       : run last
"output"    gboolean    user_function      (gtkspinbutton *spinbutton,
                                            gpointer       user_data)       : run last
"value-changed"
            void        user_function      (gtkspinbutton *spinbutton,
                                            gpointer       user_data)       : run last
"wrapped"   void        user_function      (gtkspinbutton *spinbutton,
                                            gpointer       user_data)       : run last

описание

gtkspinbutton идеальный способ позволяющий пользователю установить значение некоторого свойства. вместо непосредственного ввода значения в gtkentry, gtkspinbutton позволяет пользователю нажатием одной из двух стрелок регулировать уменьшение или увеличение отображаемого значения. тем не менее значение может быть введено в поле, дополнительно проконтролировав соответствие заданному диапазону.

основные свойства gtkspinbutton вытекают из gtkadjustment. смотрите подробности о свойствах регулирования в разделе gtkadjustment.

пример 1. использование gtkspinbutton для получения целого.

/* функция для получения целого значения из gtkspinbutton
 * и создание кнопок прокручивания для моделирования процентного значения.
 */

gint grab_int_value (gtkspinbutton *a_spinner, gpointer user_data) {
   return gtk_spin_button_get_value_as_int (a_spinner);
}

void create_integer_spin_button (void) {

   gtkwidget *window, *spinner;
   gtkadjustment *spinner_adj;

   spinner_adj = (gtkadjustment *) gtk_adjustment_new (50.0, 0.0, 100.0, 1.0, 5.0, 5.0);
   
   window = gtk_window_new (gtk_window_toplevel);
   gtk_container_set_border_width (gtk_container (window), 5);
   
   /* создаём прокрутку (spinner), без десятичных */
   spinner = gtk_spin_button_new (spinner_adj, 1.0, 0);
   gtk_container_add (gtk_container (window), spinner);
   
   gtk_widget_show_all (window);
   return;
}

пример 2. использование gtkspinbutton для получения значения с плавающей точкой.

/* функция получения значения с плавающей точкой из
 * gtkspinbutton, и создание кнопок вращения высокой точности.
 */

gfloat grab_int_value (gtkspinbutton *a_spinner, gpointer user_data) {
   return gtk_spin_button_get_value (a_spinner);
}

void create_floating_spin_button (void) {

   gtkwidget *window, *spinner;
   gtkadjustment *spinner_adj;

   spinner_adj = (gtkadjustment *) gtk_adjustment_new (2.500, 0.0, 5.0, 0.001, 0.1, 0.1);
   
   window = gtk_window_new (gtk_window_toplevel);
   gtk_container_set_border_width (gtk_container (window), 5);
   
   /* создаём поле прокручивания (spinner), с тремя знаками после запятой */
   spinner = gtk_spin_button_new (spinner_adj, 0.001, 3);
   gtk_container_add (gtk_container (window), spinner);
   
   gtk_widget_show_all (window);
   return;
}

детали

gtkspinbutton

typedef struct _gtkspinbutton gtkspinbutton;

entry это gtkentry часть виджета gtkspinbutton и может соответственно использоваться. все другие поля содержат закрытые данные и могут модифицироваться только функциями описанными ниже.

enum gtkspinbuttonupdatepolicy

typedef enum
{
  gtk_update_always,
  gtk_update_if_valid
} gtkspinbuttonupdatepolicy;

gtk_update_always	если ваш gtkspinbutton обновляется, значение отображается всегда.
gtk_update_if_valid	если ваш gtkspinbutton обновляется, значение отображается только если оно находится в пределах кнопки вращения gtkadjustment.

enum gtkspintype

typedef enum
{
  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
} gtkspintype;

gtk_spin_step_forward, gtk_spin_step_backward, gtk_spin_page_forward, gtk_spin_page_backward	это значения вращения gtkspinbutton соответствующие значениям кнопок вращения gtkadjustment.
gtk_spin_home, gtk_spin_end	это устанавливает значение кнопок вращения в минимально или максимально возможные значения, (устанавливает gtkadjustment), соответственно.
gtk_spin_user_defined	программист должен определить точное количество для прокручивания 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.
`climb_rate` :	новая норма увеличения.
`digits` :	число десятичных для отображения в кнопке прокручивания.

gtk_spin_button_new ()

gtkwidget*  gtk_spin_button_new             (gtkadjustment *adjustment,
                                             gdouble climb_rate,
                                             guint digits);

создаёт новый gtkspinbutton.

`adjustment` :	gtkadjustment объект который использует эта кнопка прокручивания.
`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
возвращает :	gtkadjustment `spin_button`

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. это регулирует скорость изменения значения при активизации стрелок кнопки вращения.

`spin_button` :	gtkspinbutton
`step` :	приращение применённое для нажатой кнопки 1.
`page` :	приращение применённое для нажатой кнопки 2.

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_float

#define gtk_spin_button_get_value_as_float gtk_spin_button_get_value

внимание

gtk_spin_button_get_value_as_float устарела и не должна использоваться во вновь создаваемом коде.

получает значение в spin_button. вместо этой устаревшей функции используйте gtk_spin_button_get_value().

возвращает :

значение spin_button.

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` :	gtkspinbutton
`policy` :	значение gtkspinbuttonupdatepolicy

gtk_spin_button_set_numeric ()

void        gtk_spin_button_set_numeric     (gtkspinbutton *spin_button,
                                             gboolean numeric);

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

`spin_button` :	gtkspinbutton
`numeric` :	флажок указывающий допустим ли только цифровой ввод.

gtk_spin_button_spin ()

void        gtk_spin_button_spin            (gtkspinbutton *spin_button,
                                             gtkspintype direction,
                                             gdouble increment);

приращение или уменьшение значения кнопки вращения в указанном направлении указанным количеством.

`spin_button` :	gtkspinbutton
`direction` :	gtkspintype указывает направление вращения.
`increment` :	шаг приращения применённый к определённому направлению.

gtk_spin_button_set_wrap ()

void        gtk_spin_button_set_wrap        (gtkspinbutton *spin_button,
                                             gboolean wrap);

устанавливает флажок который определяет начинать или нет прокручивание с противоположного конца когда достигнут предел диапазона.

`spin_button` :	gtkspinbutton
`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` :	gtkspinbutton
`snap_to_ticks` :	флажок указывающий должно ли недопустимое значение исправляться.

gtk_spin_button_update ()

void        gtk_spin_button_update          (gtkspinbutton *spin_button);

заставляет самостоятельно обновлять кнопку прокручивания.

spin_button :

gtkspinbutton

gtk_spin_button_get_digits ()

guint       gtk_spin_button_get_digits      (gtkspinbutton *spin_button);

определяет точность spin_button. смотрите gtk_spin_button_set_digits().

`spin_button` :	gtkspinbutton
возвращает :	текущая точность

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().

`spin_button` :	gtkspinbutton
`step` :	шаг приращения, или `null`
`page` :	страница приращения, или `null`

gtk_spin_button_get_numeric ()

gboolean    gtk_spin_button_get_numeric     (gtkspinbutton *spin_button);

определяет можно ли вводить не цифровой текст в кнопку прокручивания. смотрите gtk_spin_button_set_numeric().

`spin_button` :	gtkspinbutton
возвращает :	`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().

`spin_button` :	gtkspinbutton
`min` :	допустимое минимальное значение, или `null`
`max` :	допустимое максимальное значение, или `null`

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` :	gtkspinbutton
возвращает :	`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` :	gtkspinbutton
возвращает :	текущая политика обновления

gtk_spin_button_get_value ()

gdouble     gtk_spin_button_get_value       (gtkspinbutton *spin_button);

определяет значение в spin_button.

`spin_button` :	gtkspinbutton
возвращает :	значение `spin_button`

gtk_spin_button_get_wrap ()

gboolean    gtk_spin_button_get_wrap        (gtkspinbutton *spin_button);

определяет должна ли кнопка прокручивания находиться в замкнутом цикле, то есть при достижении конца диапазона начинать прокрутку с противоположного конца. смотрите gtk_spin_button_set_wrap().

`spin_button` :	gtkspinbutton
возвращает :	`true` если кнопка прокручивания в замкнутом цикле

gtk_input_error

#define gtk_input_error -1

детали свойств

свойство "`adjustment`"

  "adjustment"           gtkadjustment         : read / write

значение регулировок кнопки прокручивания.

свойство "`climb-rate`"

  "climb-rate"           gdouble               : read / write

ускорение при удерживании кнопки нажатой.

допустимые значения: >= 0

значение по умолчанию: 0

свойство "`digits`"

  "digits"               guint                 : read / write

число отображаемых десятичных знаков.

допустимые значения: <= 20

значение по умолчанию: 0

свойство "`numeric`"

  "numeric"              gboolean              : read / write

должны ли игнорироваться не цифровые символы.

значение по умолчанию: false

свойство "`snap-to-ticks`"

  "snap-to-ticks"        gboolean              : read / write

должно ли недопустимое значение автоматически изменяться к ближайшему допустимому в пределах шага.

значение по умолчанию: false

свойство "`update-policy`"

  "update-policy"        gtkspinbuttonupdatepolicy  : read / write

должна ли кнопка прокручивания обновляться всегда, или только когда значение допустимо.

значение по умолчанию: gtk_update_always

свойство "`value`"

  "value"                gdouble               : read / write

читает текущеме значение или устанавливает новое.

значение по умолчанию: 0

свойство "`wrap`"

  "wrap"                 gboolean              : read / write

должна ли кнопка прокручивания находится в замкнутом цикле при достижении пределов диапазона.

значение по умолчанию: false

детали свойств стиля

свойство стиля "`shadow-type`"

  "shadow-type"          gtkshadowtype         : read

тип окантовки которая окружает стрелки в кнопке прокручивания.

значение по умолчанию: gtk_shadow_in

детали сигналов

сигнал "change-value"

void        user_function                  (gtkspinbutton *spinbutton,
                                            gtkscrolltype *arg1,
                                            gpointer       user_data)       : run last / action

`spinbutton` :	объект получающий сигнал.
`arg1` :
`user_data` :	пользовательские данные помещаемые при подключении обработчика сигнала.

сигнал "input"

gint        user_function                  (gtkspinbutton *spinbutton,
                                            gpointer       arg1,
                                            gpointer       user_data)       : run last

`spinbutton` :	объект получающий сигнал.
`arg1` :
`user_data` :	пользовательские данные помещаемые при подключении обработчика сигнала.
возвращает :

сигнал "output"

gboolean    user_function                  (gtkspinbutton *spinbutton,
                                            gpointer       user_data)       : run last

`spinbutton` :	объект получающий сигнал.
`user_data` :	пользовательские данные помещаемые при подключении обработчика сигнала.
возвращает :

сигнал "value-changed"

void        user_function                  (gtkspinbutton *spinbutton,
                                            gpointer       user_data)       : run last

`spinbutton` :	объект получающий сигнал.
`user_data` :	пользовательские данные помещаемые при подключении обработчика сигнала.

сигнал "wrapped"

void        user_function                  (gtkspinbutton *spinbutton,
                                            gpointer       user_data)       : run last

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

`spinbutton` :	объект получающий сигнал.
`user_data` :	пользовательские данные помещаемые при подключении обработчика сигнала.

начиная с версии 2.10

смотрите также

gtkentry

для ввода текста а не цифр.

gtkspinbutton

краткое описание

иерархия объектов

осуществляемые интерфейсы

свойства

свойства стиля

сигналы

описание

детали

gtkspinbutton

enum gtkspinbuttonupdatepolicy

enum gtkspintype

gtk_spin_button_configure ()

gtk_spin_button_new ()

gtk_spin_button_new_with_range ()

gtk_spin_button_set_adjustment ()

gtk_spin_button_get_adjustment ()

gtk_spin_button_set_digits ()

gtk_spin_button_set_increments ()

gtk_spin_button_set_range ()

gtk_spin_button_get_value_as_float

внимание

gtk_spin_button_get_value_as_int ()

gtk_spin_button_set_value ()

gtk_spin_button_set_update_policy ()

gtk_spin_button_set_numeric ()

gtk_spin_button_spin ()

gtk_spin_button_set_wrap ()

gtk_spin_button_set_snap_to_ticks ()

gtk_spin_button_update ()

gtk_spin_button_get_digits ()

gtk_spin_button_get_increments ()

gtk_spin_button_get_numeric ()

gtk_spin_button_get_range ()

gtk_spin_button_get_snap_to_ticks ()

gtk_spin_button_get_update_policy ()

gtk_spin_button_get_value ()

gtk_spin_button_get_wrap ()

gtk_input_error

детали свойств

свойство "adjustment"

свойство "climb-rate"

свойство "digits"

свойство "numeric"

свойство "snap-to-ticks"

свойство "update-policy"

свойство "value"

свойство "wrap"

детали свойств стиля

свойство стиля "shadow-type"

детали сигналов

сигнал "change-value"

сигнал "input"

сигнал "output"

сигнал "value-changed"

сигнал "wrapped"

смотрите также

свойство "`adjustment`"

свойство "`climb-rate`"

свойство "`digits`"

свойство "`numeric`"

свойство "`snap-to-ticks`"

свойство "`update-policy`"

свойство "`value`"

свойство "`wrap`"

свойство стиля "`shadow-type`"