NbtkAdjustment

NbtkAdjustment — A GObject representing an adjustable bounded value

Synopsis

                    NbtkAdjustment;
NbtkAdjustment *    nbtk_adjustment_new                 (gdouble value,
                                                         gdouble lower,
                                                         gdouble upper,
                                                         gdouble step_increment,
                                                         gdouble page_increment,
                                                         gdouble page_size);
gdouble             nbtk_adjustment_get_value           (NbtkAdjustment *adjustment);
void                nbtk_adjustment_set_value           (NbtkAdjustment *adjustment,
                                                         gdouble value);
void                nbtk_adjustment_clamp_page          (NbtkAdjustment *adjustment,
                                                         gdouble lower,
                                                         gdouble upper);
void                nbtk_adjustment_set_values          (NbtkAdjustment *adjustment,
                                                         gdouble value,
                                                         gdouble lower,
                                                         gdouble upper,
                                                         gdouble step_increment,
                                                         gdouble page_increment,
                                                         gdouble page_size);
void                nbtk_adjustment_get_values          (NbtkAdjustment *adjustment,
                                                         gdouble *value,
                                                         gdouble *lower,
                                                         gdouble *upper,
                                                         gdouble *step_increment,
                                                         gdouble *page_increment,
                                                         gdouble *page_size);
void                nbtk_adjustment_interpolate         (NbtkAdjustment *adjustment,
                                                         gdouble value,
                                                         guint duration);
gboolean            nbtk_adjustment_get_elastic         (NbtkAdjustment *adjustment);
void                nbtk_adjustment_set_elastic         (NbtkAdjustment *adjustment,
                                                         gboolean elastic);
gboolean            nbtk_adjustment_clamp               (NbtkAdjustment *adjustment,
                                                         gboolean interpolate,
                                                         guint duration);

Object Hierarchy

  GObject
   +----NbtkAdjustment

Properties

  "elastic"                  gboolean              : Read / Write / Construct
  "lower"                    gdouble               : Read / Write / Construct
  "page-increment"           gdouble               : Read / Write / Construct
  "page-size"                gdouble               : Read / Write / Construct
  "step-increment"           gdouble               : Read / Write / Construct
  "upper"                    gdouble               : Read / Write / Construct
  "value"                    gdouble               : Read / Write / Construct

Signals

  "changed"                                        : Run Last

Description

The NbtkAdjustment object represents a range of values bounded between a minimum and maximum, together with step and page increments and a page size.

Details

NbtkAdjustment

typedef struct _NbtkAdjustment NbtkAdjustment;

Class for handling an interval between to values. The contents of the NbtkAdjustment are private and should be accessed using the public API.


nbtk_adjustment_new ()

NbtkAdjustment *    nbtk_adjustment_new                 (gdouble value,
                                                         gdouble lower,
                                                         gdouble upper,
                                                         gdouble step_increment,
                                                         gdouble page_increment,
                                                         gdouble page_size);

value :

lower :

upper :

step_increment :

page_increment :

page_size :

Returns :


nbtk_adjustment_get_value ()

gdouble             nbtk_adjustment_get_value           (NbtkAdjustment *adjustment);

adjustment :

Returns :


nbtk_adjustment_set_value ()

void                nbtk_adjustment_set_value           (NbtkAdjustment *adjustment,
                                                         gdouble value);

adjustment :

value :


nbtk_adjustment_clamp_page ()

void                nbtk_adjustment_clamp_page          (NbtkAdjustment *adjustment,
                                                         gdouble lower,
                                                         gdouble upper);

adjustment :

lower :

upper :


nbtk_adjustment_set_values ()

void                nbtk_adjustment_set_values          (NbtkAdjustment *adjustment,
                                                         gdouble value,
                                                         gdouble lower,
                                                         gdouble upper,
                                                         gdouble step_increment,
                                                         gdouble page_increment,
                                                         gdouble page_size);

adjustment :

value :

lower :

upper :

step_increment :

page_increment :

page_size :


nbtk_adjustment_get_values ()

void                nbtk_adjustment_get_values          (NbtkAdjustment *adjustment,
                                                         gdouble *value,
                                                         gdouble *lower,
                                                         gdouble *upper,
                                                         gdouble *step_increment,
                                                         gdouble *page_increment,
                                                         gdouble *page_size);

adjustment :

value :

lower :

upper :

step_increment :

page_increment :

page_size :


nbtk_adjustment_interpolate ()

void                nbtk_adjustment_interpolate         (NbtkAdjustment *adjustment,
                                                         gdouble value,
                                                         guint duration);

adjustment :

value :

duration :


nbtk_adjustment_get_elastic ()

gboolean            nbtk_adjustment_get_elastic         (NbtkAdjustment *adjustment);

adjustment :

Returns :


nbtk_adjustment_set_elastic ()

void                nbtk_adjustment_set_elastic         (NbtkAdjustment *adjustment,
                                                         gboolean elastic);

adjustment :

elastic :


nbtk_adjustment_clamp ()

gboolean            nbtk_adjustment_clamp               (NbtkAdjustment *adjustment,
                                                         gboolean interpolate,
                                                         guint duration);

adjustment :

interpolate :

duration :

Returns :

Property Details

The "elastic" property

  "elastic"                  gboolean              : Read / Write / Construct

Make interpolation behave in an 'elastic' way and stop clamping value.

Default value: FALSE


The "lower" property

  "lower"                    gdouble               : Read / Write / Construct

Lower bound.

Default value: 0


The "page-increment" property

  "page-increment"           gdouble               : Read / Write / Construct

Page increment.

Allowed values: >= 0

Default value: 0


The "page-size" property

  "page-size"                gdouble               : Read / Write / Construct

Page size.

Allowed values: >= 0

Default value: 0


The "step-increment" property

  "step-increment"           gdouble               : Read / Write / Construct

Step increment.

Allowed values: >= 0

Default value: 0


The "upper" property

  "upper"                    gdouble               : Read / Write / Construct

Upper bound.

Default value: 0


The "value" property

  "value"                    gdouble               : Read / Write / Construct

Current value.

Default value: 0

Signal Details

The "changed" signal

void                user_function                      (NbtkAdjustment *arg0,
                                                        gpointer        user_data)      : Run Last

Emitted when any of the adjustment values have changed

user_data :

user data set when the signal handler was connected.