* Copyright (C) 1998 Lars Hamann and Stefan Jeske
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library 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.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
- * Modified by the GTK+ Team and others 1997-1999. See the AUTHORS
+ * 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>
-#include <gtk/gtkentry.h>
-#include <gtk/gtkadjustment.h>
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+#include <gtk/gtkentry.h>
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
#define GTK_TYPE_SPIN_BUTTON (gtk_spin_button_get_type ())
-#define GTK_SPIN_BUTTON(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
-#define GTK_SPIN_BUTTON_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
-#define GTK_IS_SPIN_BUTTON(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
-#define GTK_IS_SPIN_BUTTON_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
-
-
+#define GTK_SPIN_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
+#define GTK_SPIN_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
+#define GTK_IS_SPIN_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
+#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,
} 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;
- GtkShadowType shadow_type;
-
- guint32 timer;
- guint32 ev_time;
-
- gfloat climb_rate;
- gfloat timer_step;
-
- GtkSpinButtonUpdatePolicy update_policy;
-
- guint in_child : 2;
- guint click_child : 2;
- guint button : 2;
- guint need_timer : 1;
- guint timer_calls : 3;
- guint digits : 3;
- guint numeric : 1;
- guint wrap : 1;
- guint snap_to_ticks : 1;
+
+ /*< private >*/
+ GtkSpinButtonPrivate *priv;
};
struct _GtkSpinButtonClass
{
GtkEntryClass parent_class;
+
+ gint (*input) (GtkSpinButton *spin_button,
+ gdouble *new_value);
+ gint (*output) (GtkSpinButton *spin_button);
+ void (*value_changed) (GtkSpinButton *spin_button);
+
+ /* Action signals for keybindings, do not connect to these */
+ void (*change_value) (GtkSpinButton *spin_button,
+ GtkScrollType scroll);
+
+ void (*wrapped) (GtkSpinButton *spin_button);
+
+ /* Padding for future expansion */
+ void (*_gtk_reserved1) (void);
+ void (*_gtk_reserved2) (void);
+ void (*_gtk_reserved3) (void);
+ void (*_gtk_reserved4) (void);
};
-GtkType gtk_spin_button_get_type (void);
+GType gtk_spin_button_get_type (void) G_GNUC_CONST;
void gtk_spin_button_configure (GtkSpinButton *spin_button,
GtkAdjustment *adjustment,
- gfloat climb_rate,
+ gdouble climb_rate,
guint digits);
GtkWidget* gtk_spin_button_new (GtkAdjustment *adjustment,
- gfloat climb_rate,
+ 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);
void gtk_spin_button_set_digits (GtkSpinButton *spin_button,
guint digits);
+guint gtk_spin_button_get_digits (GtkSpinButton *spin_button);
+
+void gtk_spin_button_set_increments (GtkSpinButton *spin_button,
+ gdouble step,
+ gdouble page);
+void gtk_spin_button_get_increments (GtkSpinButton *spin_button,
+ gdouble *step,
+ gdouble *page);
+
+void gtk_spin_button_set_range (GtkSpinButton *spin_button,
+ gdouble min,
+ gdouble max);
+void gtk_spin_button_get_range (GtkSpinButton *spin_button,
+ gdouble *min,
+ gdouble *max);
-gfloat gtk_spin_button_get_value_as_float (GtkSpinButton *spin_button);
+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,
- gfloat value);
+void gtk_spin_button_set_value (GtkSpinButton *spin_button,
+ gdouble value);
void gtk_spin_button_set_update_policy (GtkSpinButton *spin_button,
GtkSpinButtonUpdatePolicy policy);
+GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
void gtk_spin_button_set_numeric (GtkSpinButton *spin_button,
gboolean numeric);
+gboolean gtk_spin_button_get_numeric (GtkSpinButton *spin_button);
void gtk_spin_button_spin (GtkSpinButton *spin_button,
GtkSpinType direction,
- gfloat increment);
+ gdouble increment);
void gtk_spin_button_set_wrap (GtkSpinButton *spin_button,
gboolean wrap);
-
-void gtk_spin_button_set_shadow_type (GtkSpinButton *spin_button,
- GtkShadowType shadow_type);
+gboolean gtk_spin_button_get_wrap (GtkSpinButton *spin_button);
void gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button,
gboolean snap_to_ticks);
+gboolean gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button);
void gtk_spin_button_update (GtkSpinButton *spin_button);
+/* private */
+void _gtk_spin_button_get_panels (GtkSpinButton *spin_button,
+ GdkWindow **down_panel,
+ GdkWindow **up_panel);
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
+G_END_DECLS
#endif /* __GTK_SPIN_BUTTON_H__ */
projects / ~andy / gtk / blobdiff