]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkspinbutton.h
css: Don't query type for regions
[~andy/gtk] / gtk / gtkspinbutton.h
index 2e431631cf4d4cf55393bde506bbc560fc0feb08..40a861503df3b40c6935b2bd59787ad35a4f3ae0 100644 (file)
@@ -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,12 +103,17 @@ 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;
 
-  /* <private> */
+  /*< private >*/
   GtkSpinButtonPrivate *priv;
 };
 
@@ -100,6 +136,7 @@ struct _GtkSpinButtonClass
   void (*_gtk_reserved1) (void);
   void (*_gtk_reserved2) (void);
   void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
 };