gtk:entry, gtk:widget, gtk:buildable, gtk:editable, gtk:cell-editable, gtk:orientable, gobject:object, common-lisp:standard-object, common-lisp:t

None

The gtk:spin-button widget is an ideal way to allow the user to set the value of some attribute. Rather than having to directly type a number into a gtk:entry widget, the spin button allows the user to click on one of two arrows to increment or decrement the displayed value. A value can still be typed in, with the bonus that it can be checked to ensure it is in a given range.

Figure: GtkSpinButton

The main properties of a gtk:spin-button widget are through an adjustment. See the gtk:adjustment class for more details about an adjustment's properties. Note that the spin button will by default make its entry large enough to accomodate the lower and upper bounds of the adjustment, which can lead to surprising results. Best practice is to set both the width-chars and max-width-chars poperties to the desired number of characters to display in the entry.

 spinbutton.horizontal
 ├── undershoot.left
 ├── undershoot.right
 ├── entry
 │   ╰── ...
 ├── button.down
 ╰── button.up


 spinbutton.vertical
 ├── undershoot.left
 ├── undershoot.right
 ├── button.up
 ├── entry
 │   ╰── ...
 ╰── button.down    

The gtk:spin-button implementation main CSS node has the name spinbutton. It creates subnodes for the entry and the two buttons, with these names. The button nodes have the .up and .down style classes. The gtk:entry subnodes, if present, are put below the entry node. The orientation of the spin button is reflected in the .vertical or .horizontal style class on the main node. Code fragment for creating a spin button. The value from the spin button is retrieved with the gtk:spin-button-value function in a signal handler as a floating point number. Use the gtk:spin-button-value-as-int function to retrieve the value as an integer.

(let (...
      (spinner (make-instance 'gtk:spin-button
                              :adjustment
                              (make-instance 'gtk:adjustment
                                             :value 50.0
                                             :lower 0.0
                                             :upper 100.0
                                             :step-increment 1.0
                                             :page-increment 5.0
                                             :page-size 0.0)
                              :climb-rate 0
                              :digits 0
                              :wrap t)))


  (g:signal-connect spinner "value-changed"
                    (lambda (widget)
                      (let ((value (gtk:spin-button-value widget)))))
                        ... ))    

shadow-type

The "shadow-type" style property of type gtk:shadow-type (Read)
Style of bevel around the spin button.
Warning: The shadow-type style property has been deprecated since version 3.20 and should not be used in newly written code. Use CSS to determine the style of the border. The value of this style property is ignored.
Default value: :in

The "change-value" signal

lambda (spinbutton scroll)    :action      

spinbutton

The gtk:spin-button widget on which the signal was emitted.

scroll

The value of the gtk:scroll-type enumeration to specify the speed and amount of change.

Keybinding signal which gets emitted when the user initiates a value change. Applications should not connect to it, but may emit it with the g:signal-emit function if they need to control the cursor programmatically. The default bindings for this signal are Up/Down and PageUp and/PageDown.

The "input" signal

lambda (spinbutton new-value)    :run-last      

spinbutton

The gtk:spin-button widget on which the signal was emitted.

new-value

The pointer to a double float with the return location for the new value.

Returns

True for a successful conversion, false if the input was not handled, and GTK_INPUT_ERROR if the conversion failed.

Can be used to influence the conversion of the users input into a double float. The signal handler is expected to use the gtk:entry-text function to retrieve the text of the entry and set new-value to the new value. The default conversion uses the g_strtod() function.

The "output" signal

lambda (spinbutton)    :run-last      

spinbutton

The gtk:spin-button widget which received the signal.

Returns

True if the value has been displayed.

Can be used to change the formatting of the value that is displayed in the spin buttons entry.

(let (...
      ;; A spin button for a number
      (spinner1 (make-instance 'gtk:spin-button
                               :adjustment
                               (make-instance 'gtk:adjustment
                                              :value 1.0
                                              :lower -10000.0
                                              :upper  10000.0
                                              :step-increment 0.5
                                              :page-increment 100.0
                                              :page-size 0.0)
                               :climb-rate 1.0
                               :digits 2
                               :wrap t))
      ;; A spin button for the digits to display
      (spinner2 (make-instance 'gtk:spin-button
                               :adjustment
                               (make-instance 'gtk:adjustment
                                              :value 2
                                              :lower 1
                                              :upper 5
                                              :step-increment 1
                                              :page-increment 1
                                              :page-size 0)
                                :climb-rate 0.0
                                :digits 0
                                :wrap t)))
  ;; Customize the appearance of the number
  (g:signal-connect spinner1 "output"
    (lambda (spin-button)
      (let ((value (gtk:adjustment-value
                     (gtk:spin-button-adjustment spin-button)))
            (digits (truncate
                      (gtk:adjustment-value
                        (gtk:spin-button-adjustment spinner2)))))
        (setf (gtk:entry-text spin-button)
              (format nil "~@?" (format nil "~~,~d@f" digits) value)))))
  ... )      

The "value-changed" signal

lambda (spinbutton)    :run-last      

spinbutton

The gtk:spin-button widget on which the signal was emitted.

Is emitted when the value represented by spin-button changes. Also see the "output" signal.

The "wrapped" signal

lambda (spinbutton)    :run-last      

spinbutton

The gtk:spin-button widget which received the signal.

Is emitted right after the spin button wraps from its maximum to minimum value or vice versa.