HildonNumberEditor

HildonNumberEditor — A widget used to enter a number within a pre-defined range.

Synopsis




enum        HildonNumberEditorErrorType;
            HildonNumberEditor;
GtkWidget*  hildon_number_editor_new        (gint min,
                                             gint max);
void        hildon_number_editor_set_range  (HildonNumberEditor *editor,
                                             gint min,
                                             gint max);
gint        hildon_number_editor_get_value  (HildonNumberEditor *editor);
void        hildon_number_editor_set_value  (HildonNumberEditor *editor,
                                             gint value);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----HildonNumberEditor

Implemented Interfaces

HildonNumberEditor implements GtkBuildable and AtkImplementorIface.

Properties


  "value"                gint                  : Read / Write

Signals


"range-error"
            gboolean    user_function      (HildonNumberEditor          *hildonnumbereditor,
                                            HildonNumberEditorErrorType *arg1,
                                            gpointer                     user_data)               : Run last

Description

HildonNumberEditor is used to enter a number from a specific range. There are two buttons to scroll the value in number field. Manual input is also possible.

Example 10. HildonNumberEditor example

number_editor = hildon_number_editor_new (-250, 500);
hildon_number_editor_set_range (number_editor, 0, 100);


Details

enum HildonNumberEditorErrorType

typedef enum
{
    HILDON_NUMBER_EDITOR_ERROR_MAXIMUM_VALUE_EXCEED,
    HILDON_NUMBER_EDITOR_ERROR_MINIMUM_VALUE_EXCEED,
    HILDON_NUMBER_EDITOR_ERROR_ERRONEOUS_VALUE
}                                               HildonNumberEditorErrorType;

HildonNumberEditor

typedef struct _HildonNumberEditor HildonNumberEditor;

hildon_number_editor_new ()

GtkWidget*  hildon_number_editor_new        (gint min,
                                             gint max);

Creates new number editor

min : minimum accepted value
max : maximum accepted value
Returns : a new HildonNumberEditor widget

hildon_number_editor_set_range ()

void        hildon_number_editor_set_range  (HildonNumberEditor *editor,
                                             gint min,
                                             gint max);

Sets accepted number range for editor

editor : a HildonNumberEditor widget
min : minimum accepted value
max : maximum accepted value

hildon_number_editor_get_value ()

gint        hildon_number_editor_get_value  (HildonNumberEditor *editor);

editor : pointer to HildonNumberEditor
Returns : current NumberEditor value

hildon_number_editor_set_value ()

void        hildon_number_editor_set_value  (HildonNumberEditor *editor,
                                             gint value);

Sets numeric value for number editor

editor : pointer to HildonNumberEditor
value : numeric value for number editor

Property Details

The "value" property

  "value"                gint                  : Read / Write

The current value of the number editor.

Default value: 0

Signal Details

The "range-error" signal

gboolean    user_function                  (HildonNumberEditor          *hildonnumbereditor,
                                            HildonNumberEditorErrorType *arg1,
                                            gpointer                     user_data)               : Run last

hildonnumbereditor : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.
Returns :