gtkspinbuttonsci.h

Go to the documentation of this file.

/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GtkSpinButton widget for GTK+
 * 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 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
 * 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.
 */

/*
 * 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/. 
 */

#ifndef __GTK_SPIN_BUTTON_SCI_H__
#define __GTK_SPIN_BUTTON_SCI_H__


#include <gdk/gdk.h>
#include <gtk/gtkentry.h>
#include <gtk/gtkadjustment.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define GTK_TYPE_SPIN_BUTTON_SCI                  (gtk_spin_button_sci_get_type ())
#define GTK_SPIN_BUTTON_SCI(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON_SCI, GtkSpinbuttonsci))
#define GTK_SPIN_BUTTON_SCI_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON_SCI, GtkSpinbuttonsciClass))
#define GTK_IS_SPIN_BUTTON_SCI(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON_SCI))
#define GTK_IS_SPIN_BUTTON_SCI_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON_SCI))
#define GTK_SPIN_BUTTON_SCI_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SPIN_BUTTON_SCI, GtkSpinbuttonsciClass))

#define GTK_INPUT_ERROR -1

typedef enum
{
  GTK_SPIN_SCI_UPDATE_ALWAYS,
  GTK_SPIN_SCI_UPDATE_IF_VALID
} GtkSpinbuttonsciUpdatePolicy;

typedef enum
{
  GTK_SPIN_SCI_STEP_FORWARD,
  GTK_SPIN_SCI_STEP_BACKWARD,
  GTK_SPIN_SCI_PAGE_FORWARD,
  GTK_SPIN_SCI_PAGE_BACKWARD,
  GTK_SPIN_SCI_HOME,
  GTK_SPIN_SCI_END,
  GTK_SPIN_SCI_USER_DEFINED
} GtkSpinsciType;


typedef struct _GtkSpinbuttonsci            GtkSpinbuttonsci;
typedef struct _GtkSpinbuttonsciClass  GtkSpinbuttonsciClass;


struct _GtkSpinbuttonsci
{
  GtkEntry entry;
  
  GtkAdjustment *adjustment;
  GtkAdjustment *adjustment_safety;
  
  GdkWindow *panel;
  
  guint32 timer;
  
  gdouble climb_rate;
  gdouble timer_step;
  
  GtkSpinbuttonsciUpdatePolicy 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;
  guint jump_to_limits : 1;
  guint sci_fixed_point_mantisse : 1;
  guint sci_max_left_digits : 10;
  guint sci_extension_magnitude_arrows : 1;

  gchar *sci_suffix;
};

struct _GtkSpinbuttonsciClass
{
  GtkEntryClass parent_class;

  gint (*input)  (GtkSpinbuttonsci *spin_button_sci,
                  gdouble       *new_value);
  gint (*output) (GtkSpinbuttonsci *spin_button_sci);
  void (*value_changed) (GtkSpinbuttonsci *spin_button_sci);

  /* Action signals for keybindings, do not connect to these */
  void (*change_value) (GtkSpinbuttonsci *spin_button_sci,
                        GtkScrollType  scroll);

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
};


GType           gtk_spin_button_sci_get_type       (void) G_GNUC_CONST;

void            gtk_spin_button_sci_configure      (GtkSpinbuttonsci  *spin_button_sci,
                                                    GtkAdjustment  *adjustment,
                                                    gdouble         climb_rate,
                                                    guint           digits);

GtkWidget*      gtk_spin_button_sci_new            (GtkAdjustment  *adjustment,
                                                    gdouble         climb_rate,
                                                    guint           digits);

GtkWidget*      gtk_spin_button_sci_new_with_range         (gdouble  min,
                                                    gdouble  max,
                                                    gdouble  step);

void            gtk_spin_button_sci_set_adjustment         (GtkSpinbuttonsci  *spin_button_sci,
                                                    GtkAdjustment  *adjustment);

GtkAdjustment*  gtk_spin_button_sci_get_adjustment         (GtkSpinbuttonsci  *spin_button_sci);

void            gtk_spin_button_sci_set_digits     (GtkSpinbuttonsci  *spin_button_sci,
                                                    guint           digits);
guint           gtk_spin_button_sci_get_digits         (GtkSpinbuttonsci  *spin_button_sci);

void            gtk_spin_button_sci_set_increments         (GtkSpinbuttonsci  *spin_button_sci,
                                                    gdouble         step,
                                                    gdouble         page);
void            gtk_spin_button_sci_get_increments     (GtkSpinbuttonsci  *spin_button_sci,
                                                    gdouble        *step,
                                                    gdouble        *page);

void            gtk_spin_button_sci_set_range      (GtkSpinbuttonsci  *spin_button_sci,
                                                    gdouble         min,
                                                    gdouble         max);
void            gtk_spin_button_sci_get_range          (GtkSpinbuttonsci  *spin_button_sci,
                                                    gdouble        *min,
                                                    gdouble        *max);

void            gtk_spin_button_sci_set_suffix     (GtkSpinbuttonsci  *spin_button_sci,
                                                    gchar       *suffix);

gdouble         gtk_spin_button_sci_get_value          (GtkSpinbuttonsci  *spin_button_sci);

gint            gtk_spin_button_sci_get_value_as_int   (GtkSpinbuttonsci  *spin_button_sci);

void            gtk_spin_button_sci_set_value      (GtkSpinbuttonsci  *spin_button_sci, 
                                                    gdouble         value);

void            gtk_spin_button_sci_set_update_policy  (GtkSpinbuttonsci  *spin_button_sci,
                                                    GtkSpinbuttonsciUpdatePolicy  policy);
GtkSpinbuttonsciUpdatePolicy gtk_spin_button_sci_get_update_policy (GtkSpinbuttonsci *spin_button_sci);

void            gtk_spin_button_sci_set_numeric    (GtkSpinbuttonsci  *spin_button_sci,
                                                    gboolean        numeric);
gboolean        gtk_spin_button_sci_get_numeric        (GtkSpinbuttonsci  *spin_button_sci);

void            gtk_spin_button_sci_spin                   (GtkSpinbuttonsci  *spin_button_sci,
                                                    GtkSpinsciType     direction,
                                                    gdouble         increment);

void            gtk_spin_button_sci_set_wrap       (GtkSpinbuttonsci  *spin_button_sci,
                                                    gboolean        wrap);
gboolean        gtk_spin_button_sci_get_wrap           (GtkSpinbuttonsci  *spin_button_sci);

void            gtk_spin_button_sci_set_snap_to_ticks  (GtkSpinbuttonsci  *spin_button_sci,
                                                    gboolean        snap_to_ticks);
gboolean        gtk_spin_button_sci_get_snap_to_ticks  (GtkSpinbuttonsci  *spin_button_sci);
void            gtk_spin_button_sci_update             (GtkSpinbuttonsci  *spin_button_sci);


#ifndef GTK_DISABLE_DEPRECATED
#define gtk_spin_button_sci_get_value_as_float gtk_spin_button_sci_get_value
#endif

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_SPIN_BUTTON_SCI_H__ */

---