HildonRangeEditor

HildonRangeEditor — A widget is used to ask bounds of a range.

Synopsis

                    HildonRangeEditor;
GtkWidget*          hildon_range_editor_new_with_separator
                                                        (const gchar *separator);
GtkWidget*          hildon_range_editor_new             (void);
void                hildon_range_editor_set_range       (HildonRangeEditor *editor,
                                                         gint start,
                                                         gint end);
void                hildon_range_editor_get_range       (HildonRangeEditor *editor,
                                                         gint *start,
                                                         gint *end);
void                hildon_range_editor_set_limits      (HildonRangeEditor *editor,
                                                         gint start,
                                                         gint end);
void                hildon_range_editor_set_lower       (HildonRangeEditor *editor,
                                                         gint value);
void                hildon_range_editor_set_higher      (HildonRangeEditor *editor,
                                                         gint value);
gint                hildon_range_editor_get_lower       (HildonRangeEditor *editor);
gint                hildon_range_editor_get_higher      (HildonRangeEditor *editor);
void                hildon_range_editor_set_min         (HildonRangeEditor *editor,
                                                         gint value);
void                hildon_range_editor_set_max         (HildonRangeEditor *editor,
                                                         gint value);
gint                hildon_range_editor_get_min         (HildonRangeEditor *editor);
gint                hildon_range_editor_get_max         (HildonRangeEditor *editor);
void                hildon_range_editor_set_separator   (HildonRangeEditor *editor,
                                                         const gchar *separator);
const gchar*        hildon_range_editor_get_separator   (HildonRangeEditor *editor);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----HildonRangeEditor

Implemented Interfaces

HildonRangeEditor implements AtkImplementorIface and GtkBuildable.

Properties

  "higher"                   gint                  : Read / Write / Construct
  "lower"                    gint                  : Read / Write / Construct
  "max"                      gint                  : Read / Write / Construct
  "min"                      gint                  : Read / Write / Construct
  "separator"                gchar*                : Read / Write / Construct

Style Properties

  "hildon-range-editor-entry-alignment" gint                  : Read
  "hildon-range-editor-separator-padding" gint                  : Read

Description

HidlonRangeEditor allows entering a pair of integers, e.g. the lower and higher bounds of a range. A minimum and maximum can also be set for the bounds.

Note

HildonRangeEditor has been deprecated since Hildon 2.2 and should not be used in newly written code. See Migrating Number Widgets section to know how to migrate this deprecated widget.

Example 24. 

     range_editor = hildon_range_editor_new ();
     hildon_range_editor_set_limits (editor, start, end );
     hildon_range_editor_get_range (editor, &start, &end);


Details

HildonRangeEditor

typedef struct _HildonRangeEditor HildonRangeEditor;

Warning

HildonRangeEditor is deprecated and should not be used in newly-written code.

hildon_range_editor_new_with_separator ()

GtkWidget*          hildon_range_editor_new_with_separator
                                                        (const gchar *separator);

Warning

hildon_range_editor_new_with_separator is deprecated and should not be used in newly-written code.

HildonRangeEditor contains two Gtk entries that accept numbers. A separator is displayed between two entries. CHECKME: Use '-' as a separator in the case of null separator?

separator : a string that is shown between the numbers
Returns : pointer to a new HildonRangeEditor widget

hildon_range_editor_new ()

GtkWidget*          hildon_range_editor_new             (void);

Warning

hildon_range_editor_new is deprecated and should not be used in newly-written code.

HildonRangeEditor contains two GtkEntrys that accept numbers and minus.

Returns : pointer to a new HildonRangeEditor widget

hildon_range_editor_set_range ()

void                hildon_range_editor_set_range       (HildonRangeEditor *editor,
                                                         gint start,
                                                         gint end);

Warning

hildon_range_editor_set_range is deprecated and should not be used in newly-written code.

Sets a range to the editor. (The current value)

Sets the range of the HildonRangeEditor widget.

editor : the HildonRangeEditor widget
start : range's start value
end : range's end value

hildon_range_editor_get_range ()

void                hildon_range_editor_get_range       (HildonRangeEditor *editor,
                                                         gint *start,
                                                         gint *end);

Warning

hildon_range_editor_get_range is deprecated and should not be used in newly-written code.

Gets the range of the HildonRangeEditor widget.

editor : the HildonRangeEditor widget
start : ranges start value
end : ranges end value

hildon_range_editor_set_limits ()

void                hildon_range_editor_set_limits      (HildonRangeEditor *editor,
                                                         gint start,
                                                         gint end);

Warning

hildon_range_editor_set_limits is deprecated and should not be used in newly-written code.

Sets the range of the HildonRangeEditor widget.

editor : the HildonRangeEditor widget
start : minimum acceptable value (default: no limit)
end : maximum acceptable value (default: no limit)

hildon_range_editor_set_lower ()

void                hildon_range_editor_set_lower       (HildonRangeEditor *editor,
                                                         gint value);

Warning

hildon_range_editor_set_lower is deprecated and should not be used in newly-written code.

editor :
value :

hildon_range_editor_set_higher ()

void                hildon_range_editor_set_higher      (HildonRangeEditor *editor,
                                                         gint value);

Warning

hildon_range_editor_set_higher is deprecated and should not be used in newly-written code.

editor :
value :

hildon_range_editor_get_lower ()

gint                hildon_range_editor_get_lower       (HildonRangeEditor *editor);

Warning

hildon_range_editor_get_lower is deprecated and should not be used in newly-written code.

editor :
Returns :

hildon_range_editor_get_higher ()

gint                hildon_range_editor_get_higher      (HildonRangeEditor *editor);

Warning

hildon_range_editor_get_higher is deprecated and should not be used in newly-written code.

editor :
Returns :

hildon_range_editor_set_min ()

void                hildon_range_editor_set_min         (HildonRangeEditor *editor,
                                                         gint value);

Warning

hildon_range_editor_set_min is deprecated and should not be used in newly-written code.

editor :
value :

hildon_range_editor_set_max ()

void                hildon_range_editor_set_max         (HildonRangeEditor *editor,
                                                         gint value);

Warning

hildon_range_editor_set_max is deprecated and should not be used in newly-written code.

editor :
value :

hildon_range_editor_get_min ()

gint                hildon_range_editor_get_min         (HildonRangeEditor *editor);

Warning

hildon_range_editor_get_min is deprecated and should not be used in newly-written code.

editor :
Returns :

hildon_range_editor_get_max ()

gint                hildon_range_editor_get_max         (HildonRangeEditor *editor);

Warning

hildon_range_editor_get_max is deprecated and should not be used in newly-written code.

editor :
Returns :

hildon_range_editor_set_separator ()

void                hildon_range_editor_set_separator   (HildonRangeEditor *editor,
                                                         const gchar *separator);

Warning

hildon_range_editor_set_separator is deprecated and should not be used in newly-written code.

editor :
separator :

hildon_range_editor_get_separator ()

const gchar*        hildon_range_editor_get_separator   (HildonRangeEditor *editor);

Warning

hildon_range_editor_get_separator is deprecated and should not be used in newly-written code.

editor :
Returns :

Property Details

The "higher" property

  "higher"                   gint                  : Read / Write / Construct

Current value in the entry presenting higher end of selected range. Default: 999

Default value: 999

The "lower" property

  "lower"                    gint                  : Read / Write / Construct

Current value in the entry presenting lower end of selected range. Default: -999

Default value: -999

The "max" property

  "max"                      gint                  : Read / Write / Construct

Maximum value in a range. Default: 999

Default value: 999

The "min" property

  "min"                      gint                  : Read / Write / Construct

Minimum value in a range. Default: -999

Default value: -999

The "separator" property

  "separator"                gchar*                : Read / Write / Construct

Separator string to separate range editor entries. Default: "-"

Default value: "ckct_wi_range_separator"

Style Property Details

The "hildon-range-editor-entry-alignment" style property

  "hildon-range-editor-entry-alignment" gint                  : Read

Hildon RangeEditor entry alignment.

Allowed values: [0,1]

Default value: 1

The "hildon-range-editor-separator-padding" style property

  "hildon-range-editor-separator-padding" gint                  : Read

Hildon RangeEditor separaror padding.

Default value: 3

Generated by GTK-Doc V1.10