filechooserbutton: Give proper names to the SELECT_FOLDER tests with cancelled dialog

[~andy/gtk] / gtk / gtkspinbutton.h

diff --git a/gtk/gtkspinbutton.h b/gtk/gtkspinbutton.h
index 4bf3570c2b1489adb38266cd106980542cd21512..7ed63529ad841950e95d84b36b8568b729ec2bcc 100644 (file)
--- a/gtk/gtkspinbutton.h
+++ b/gtk/gtkspinbutton.h
@@ -15,25 +15,25 @@
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GTK+ Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
 #ifndef __GTK_SPIN_BUTTON_H__
 #define __GTK_SPIN_BUTTON_H__
 
 
-#include <gdk/gdk.h>
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #include <gtk/gtkentry.h>
-#include <gtk/gtkadjustment.h>
 
 
 G_BEGIN_DECLS
@@ -45,14 +45,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,
@@ -65,34 +96,22 @@ typedef enum
 } GtkSpinType;
 
 
-typedef struct _GtkSpinButton      GtkSpinButton;
-typedef struct _GtkSpinButtonClass  GtkSpinButtonClass;
-
+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;
-  
-  GtkAdjustment *adjustment;
-  
-  GdkWindow *panel;
-  
-  guint32 timer;
-  
-  gdouble climb_rate;
-  gdouble timer_step;
-  
-  GtkSpinButtonUpdatePolicy update_policy;
-  
-  guint in_child : 2;
-  guint click_child : 2; /* valid: GTK_ARROW_UP=0, GTK_ARROW_DOWN=1 or 2=NONE/BOTH */
-  guint button : 2;
-  guint need_timer : 1;
-  guint timer_calls : 3;
-  guint digits : 10;
-  guint numeric : 1;
-  guint wrap : 1;
-  guint snap_to_ticks : 1;
+
+  /*< private >*/
+  GtkSpinButtonPrivate *priv;
 };
 
 struct _GtkSpinButtonClass
@@ -114,6 +133,7 @@ struct _GtkSpinButtonClass
   void (*_gtk_reserved1) (void);
   void (*_gtk_reserved2) (void);
   void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
 };
 
 
@@ -159,7 +179,7 @@ gdouble             gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
 
 gint           gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
 
-void           gtk_spin_button_set_value          (GtkSpinButton  *spin_button, 
+void           gtk_spin_button_set_value          (GtkSpinButton  *spin_button,
                                                    gdouble         value);
 
 void           gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
@@ -183,10 +203,10 @@ void              gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
 gboolean        gtk_spin_button_get_snap_to_ticks  (GtkSpinButton  *spin_button);
 void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
 
-
-#ifndef GTK_DISABLE_DEPRECATED
-#define gtk_spin_button_get_value_as_float gtk_spin_button_get_value
-#endif
+/* private */
+void            _gtk_spin_button_get_panels        (GtkSpinButton  *spin_button,
+                                                    GdkWindow     **down_panel,
+                                                    GdkWindow     **up_panel);
 
 G_END_DECLS