diff options
author | Matthias Clasen <mclasen@redhat.com> | 2011-01-02 23:30:02 -0500 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2011-01-02 23:30:02 -0500 |
commit | 85fe6cb2c414c57c174fee4cea7fcb05c617fc0e (patch) | |
tree | fbe6c75653c6c72c78cf9c78e6613e8c0ef5d6df /gtk/gtkspinbutton.h | |
parent | 1a87dfdf6d101fbf9f07ca2215be518c3da4dc12 (diff) | |
download | gtk+-85fe6cb2c414c57c174fee4cea7fcb05c617fc0e.tar.gz |
Move GtkSpinButton docs inline
...and modernize the examples at the same time.
This fixes a problem pointed out in bug 638193.
Diffstat (limited to 'gtk/gtkspinbutton.h')
-rw-r--r-- | gtk/gtkspinbutton.h | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/gtk/gtkspinbutton.h b/gtk/gtkspinbutton.h index f061f29028..40a861503d 100644 --- a/gtk/gtkspinbutton.h +++ b/gtk/gtkspinbutton.h @@ -48,14 +48,45 @@ G_BEGIN_DECLS #define GTK_IS_SPIN_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON)) #define GTK_SPIN_BUTTON_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass)) +/** + * GTK_INPUT_ERROR: + * + * Constant to return from a signal handler for the #GtkSpinButton::input + * signal in case of conversion failure. + */ #define GTK_INPUT_ERROR -1 +/** + * GtkSpinButtonUpdatePolicy: + * @GTK_UPDATE_ALWAYS: When refreshing your #GtkSpinButton, the value is + * always displayed + * @GTK_UPDATE_IF_VALID: When refreshing your #GtkSpinButton, the value is + * only displayed if it is valid within the bounds of the spin button's + * adjustment + * + * The spin button update policy determines whether the spin button displays + * values even if they are outside the bounds of its adjustment. + * See gtk_spin_button_set_update_policy(). + */ typedef enum { GTK_UPDATE_ALWAYS, GTK_UPDATE_IF_VALID } GtkSpinButtonUpdatePolicy; +/** + * GtkSpinType: + * @GTK_SPIN_STEP_FORWARD: Increment by the adjustments step increment. + * @GTK_SPIN_STEP_BACKWARD: Decrement by the adjustments step increment. + * @GTK_SPIN_PAGE_FORWARD: Increment by the adjustments page increment. + * @GTK_SPIN_PAGE_BACKWARD: Decrement by the adjustments page increment. + * @GTK_SPIN_HOME: Go to the adjustments lower bound. + * @GTK_SPIN_END: Go to the adjustments upper bound. + * @GTK_SPIN_USER_DEFINED: Change by a specified amount. + * + * The values of the GtkSpinType enumeration are used to specify the + * change to make in gtk_spin_button_spin(). + */ typedef enum { GTK_SPIN_STEP_FORWARD, @@ -72,7 +103,12 @@ typedef struct _GtkSpinButton GtkSpinButton; typedef struct _GtkSpinButtonPrivate GtkSpinButtonPrivate; typedef struct _GtkSpinButtonClass GtkSpinButtonClass; - +/** + * GtkSpinButton: + * + * The #GtkSpinButton struct contains only private data and should + * not be directly modified. + */ struct _GtkSpinButton { GtkEntry entry; |