gtk_numericalEntryWidget

gtk_numericalEntryWidget — Defines a widget to enter numerical values without any boundary or precision constrains.

Synopsis

#define             NUMERICAL_ENTRY_TYPE
#define             NUMERICAL_ENTRY                     (obj)
#define             NUMERICAL_ENTRY_CLASS               (klass)
#define             IS_NUMERICAL_ENTRY                  (obj)
#define             IS_NUMERICAL_ENTRY_CLASS            (klass)
                    NumericalEntry;
                    NumericalEntryClass;
GType               numericalEntry_get_type             (void);
GtkWidget*          numericalEntry_new                  (double value);
void                numericalEntrySet_value             (NumericalEntry *numericalEntry,
                                                         double value);
double              numericalEntryGet_value             (NumericalEntry *numericalEntry);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkEntry
                           +----NumericalEntry

Implemented Interfaces

NumericalEntry implements AtkImplementorIface, GtkBuildable, GtkEditable and GtkCellEditable.

Signals

  "value-changed"                                  : Run First / Action

Description

This widget is based on the GtkEntry widget but behaves more like a GtkSpinButton is fact. It is designed to enter numerical values, but without any boundary or precision constrains. One can use either plain or scientific notations.

Details

NUMERICAL_ENTRY_TYPE

#define NUMERICAL_ENTRY_TYPE         (numericalEntry_get_type ())

Return the associated GType to the NumericalEntry objects.


NUMERICAL_ENTRY()

#define NUMERICAL_ENTRY(obj)         (G_TYPE_CHECK_INSTANCE_CAST ((obj), NUMERICAL_ENTRY_TYPE, NumericalEntry))

Cast the given object to a NumericalEntry object.

obj :

the widget to cast.

NUMERICAL_ENTRY_CLASS()

#define NUMERICAL_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NUMERICAL_ENTRY_TYPE, NumericalEntryClass))

Cast the given class to a NumericalEntryClass object.

klass :

the class to cast.

IS_NUMERICAL_ENTRY()

#define IS_NUMERICAL_ENTRY(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NUMERICAL_ENTRY_TYPE))

Return if the given object is a valid NumericalEntry object.

obj :

the object to test.

IS_NUMERICAL_ENTRY_CLASS()

#define IS_NUMERICAL_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NUMERICAL_ENTRY_TYPE))

Return if the given class is a valid NumericalEntryClass class.

klass :

the class to test.

NumericalEntry

typedef struct _NumericalEntry NumericalEntry;

Short form for a NumericalEntry_struct structure.


NumericalEntryClass

typedef struct _NumericalEntryClass NumericalEntryClass;

Short form for a NumericalEntryClass_struct structure.


numericalEntry_get_type ()

GType               numericalEntry_get_type             (void);

GType are unique numbers to identify objects.

Returns :

the GType associated with NumericalEntry objects.

numericalEntry_new ()

GtkWidget*          numericalEntry_new                  (double value);

A NumericalEntry widget is like a GtkEntry widget, but it only accepts double precision values (written in plain format, e.g. 1.23456, or scientific notation, e.g. 1.2345e6). The widget can't be blank and there is always a value printed in it. If the user erase the current value or enter something that is not a recognised double precision value, the widget returns to its previous valid value.

value :

the initial value.

Returns :

a newly created NumericalEntry widget.

numericalEntrySet_value ()

void                numericalEntrySet_value             (NumericalEntry *numericalEntry,
                                                         double value);

Use this method to set the value for the given numericalEntry widget.

numericalEntry :

a NumericalEntry widget ;

value :

a double precision value.

numericalEntryGet_value ()

double              numericalEntryGet_value             (NumericalEntry *numericalEntry);

You can get the value contained in the given numericalEntry using this method.

numericalEntry :

a NumericalEntry widget.

Returns :

the double precision value printed in the NumericalEntry.

Signal Details

The "value-changed" signal

void                user_function                      (NumericalEntry *entry,
                                                        gdouble         oldValue,
                                                        gpointer        user_data)      : Run First / Action

This signal is emitted when a new valid numerical value is entered.

entry :

the NumericalEntry that emits the signal ;

oldValue :

the previous value.

user_data :

user data set when the signal handler was connected.

Since 3.1