MxAdjustment

MxAdjustment — A GObject representing an adjustable bounded value

Synopsis

                    MxAdjustment;
MxAdjustment *      mx_adjustment_new                   (gdouble value,
                                                         gdouble lower,
                                                         gdouble upper,
                                                         gdouble step_increment,
                                                         gdouble page_increment,
                                                         gdouble page_size);
gdouble             mx_adjustment_get_value             (MxAdjustment *adjustment);
void                mx_adjustment_set_value             (MxAdjustment *adjustment,
                                                         gdouble value);
void                mx_adjustment_clamp_page            (MxAdjustment *adjustment,
                                                         gdouble lower,
                                                         gdouble upper);
void                mx_adjustment_set_values            (MxAdjustment *adjustment,
                                                         gdouble value,
                                                         gdouble lower,
                                                         gdouble upper,
                                                         gdouble step_increment,
                                                         gdouble page_increment,
                                                         gdouble page_size);
void                mx_adjustment_get_values            (MxAdjustment *adjustment,
                                                         gdouble *value,
                                                         gdouble *lower,
                                                         gdouble *upper,
                                                         gdouble *step_increment,
                                                         gdouble *page_increment,
                                                         gdouble *page_size);
void                mx_adjustment_interpolate           (MxAdjustment *adjustment,
                                                         gdouble value,
                                                         guint duration,
                                                         gulong mode);
gboolean            mx_adjustment_get_elastic           (MxAdjustment *adjustment);
void                mx_adjustment_set_elastic           (MxAdjustment *adjustment,
                                                         gboolean elastic);
gboolean            mx_adjustment_clamp                 (MxAdjustment *adjustment,
                                                         gboolean interpolate,
                                                         guint duration,
                                                         gulong mode);

Object Hierarchy

  GObject
   +----MxAdjustment

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 MxAdjustment object represents a range of values bounded between a minimum and maximum, together with step and page increments and a page size.

Details

MxAdjustment

typedef struct _MxAdjustment MxAdjustment;

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


mx_adjustment_new ()

MxAdjustment *      mx_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 :


mx_adjustment_get_value ()

gdouble             mx_adjustment_get_value             (MxAdjustment *adjustment);

adjustment :

Returns :


mx_adjustment_set_value ()

void                mx_adjustment_set_value             (MxAdjustment *adjustment,
                                                         gdouble value);

adjustment :

value :


mx_adjustment_clamp_page ()

void                mx_adjustment_clamp_page            (MxAdjustment *adjustment,
                                                         gdouble lower,
                                                         gdouble upper);

adjustment :

lower :

upper :


mx_adjustment_set_values ()

void                mx_adjustment_set_values            (MxAdjustment *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 :


mx_adjustment_get_values ()

void                mx_adjustment_get_values            (MxAdjustment *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 :


mx_adjustment_interpolate ()

void                mx_adjustment_interpolate           (MxAdjustment *adjustment,
                                                         gdouble value,
                                                         guint duration,
                                                         gulong mode);

adjustment :

value :

duration :

mode :


mx_adjustment_get_elastic ()

gboolean            mx_adjustment_get_elastic           (MxAdjustment *adjustment);

adjustment :

Returns :


mx_adjustment_set_elastic ()

void                mx_adjustment_set_elastic           (MxAdjustment *adjustment,
                                                         gboolean elastic);

adjustment :

elastic :


mx_adjustment_clamp ()

gboolean            mx_adjustment_clamp                 (MxAdjustment *adjustment,
                                                         gboolean interpolate,
                                                         guint duration,
                                                         gulong mode);

adjustment :

interpolate :

duration :

mode :

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                      (MxAdjustment *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.