MxAdjustment

MxAdjustment — A GObject representing an adjustable bounded value

Functions

Properties

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

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── MxAdjustment

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.

Functions

mx_adjustment_new ()

MxAdjustment *
mx_adjustment_new (void);

Create a new MxAdjustment

Returns

a newly allocated MxAdjustment


mx_adjustment_new_with_values ()

MxAdjustment *
mx_adjustment_new_with_values (gdouble value,
                               gdouble lower,
                               gdouble upper,
                               gdouble step_increment,
                               gdouble page_increment,
                               gdouble page_size);

Create a new MxAdjustment with the properties set to the values specified.

Parameters

value

A gdouble

 

lower

A gdouble

 

upper

A gdouble

 

step_increment

A gdouble

 

page_increment

A gdouble

 

page_size

A gdouble

 

Returns

a newly allocated MxAdjustment


mx_adjustment_get_value ()

gdouble
mx_adjustment_get_value (MxAdjustment *adjustment);

Get the current value of the “value” property

Parameters

adjustment

An MxAdjustment

 

Returns

the current value of the "value" property


mx_adjustment_set_value ()

void
mx_adjustment_set_value (MxAdjustment *adjustment,
                         gdouble value);

Set the value of the “value” property.

Parameters

adjustment

An MxAdjustment

 

value

A gdouble

 

mx_adjustment_get_lower ()

gdouble
mx_adjustment_get_lower (MxAdjustment *adjustment);

Get the value of the “lower” property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "lower" property.


mx_adjustment_set_lower ()

void
mx_adjustment_set_lower (MxAdjustment *adjustment,
                         gdouble lower);

Set the value of the “lower” property.

Parameters

adjustment

A MxAdjustment

 

lower

A gdouble

 

mx_adjustment_get_upper ()

gdouble
mx_adjustment_get_upper (MxAdjustment *adjustment);

Get the value of the “upper” property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "upper" property.


mx_adjustment_set_upper ()

void
mx_adjustment_set_upper (MxAdjustment *adjustment,
                         gdouble upper);

Set the value of the “upper” property.

Parameters

adjustment

A MxAdjustment

 

upper

A gdouble

 

mx_adjustment_get_step_increment ()

gdouble
mx_adjustment_get_step_increment (MxAdjustment *adjustment);

Get the value of the MxAdjustment:step-increment property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "step-increment" property.


mx_adjustment_set_step_increment ()

void
mx_adjustment_set_step_increment (MxAdjustment *adjustment,
                                  gdouble increment);

Set the value of the “step-increment” property.

Parameters

adjustment

A MxAdjustment

 

increment

A gdouble

 

mx_adjustment_get_page_increment ()

gdouble
mx_adjustment_get_page_increment (MxAdjustment *adjustment);

Get the value of the MxAdjustment:page-increment property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "page-increment" property.


mx_adjustment_set_page_increment ()

void
mx_adjustment_set_page_increment (MxAdjustment *adjustment,
                                  gdouble increment);

Set the value of the “page-increment” property.

Parameters

adjustment

A MxAdjustment

 

increment

A gdouble

 

mx_adjustment_get_page_size ()

gdouble
mx_adjustment_get_page_size (MxAdjustment *adjustment);

Get the value of the “page-size” property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "page-size" property.


mx_adjustment_set_page_size ()

void
mx_adjustment_set_page_size (MxAdjustment *adjustment,
                             gdouble page_size);

Set the “page-size” property.

Parameters

adjustment

A MxAdjustment

 

page_size

A gdouble

 

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);

Set the various properties of MxAdjustment.

Parameters

adjustment

A MxAdjustment

 

value

A gdouble

 

lower

A gdouble

 

upper

A gdouble

 

step_increment

A gdouble

 

page_increment

A gdouble

 

page_size

A gdouble

 

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);

Get the various properties of MxAdjustment.

Parameters

adjustment

A MxAdjustment

 

value

A gdouble

 

lower

A gdouble

 

upper

A gdouble

 

step_increment

A gdouble

 

page_increment

A gdouble

 

page_size

A gdouble

 

mx_adjustment_interpolate ()

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

Interpolate “value” to the new value specified by value , using the mode and duration given.

Parameters

adjustment

A MxAdjustment

 

value

A gdouble

 

duration

duration in milliseconds

 

mode

A ClutterAnimationMode

 

mx_adjustment_interpolate_relative ()

void
mx_adjustment_interpolate_relative (MxAdjustment *adjustment,
                                    gdouble offset,
                                    guint duration,
                                    gulong mode);

Interpolate the value of “value” to a new value calculated from offset .

Parameters

adjustment

A MxAdjustment

 

offset

A gdouble

 

duration

duration in milliseconds

 

mode

A ClutterAnimationMode

 

mx_adjustment_get_elastic ()

gboolean
mx_adjustment_get_elastic (MxAdjustment *adjustment);

Get the value of the “elastic” property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "elastic" property.


mx_adjustment_set_elastic ()

void
mx_adjustment_set_elastic (MxAdjustment *adjustment,
                           gboolean elastic);

Set the value of the “elastic” property.

Parameters

adjustment

A MxAdjustment

 

elastic

A gboolean

 

mx_adjustment_get_clamp_value ()

gboolean
mx_adjustment_get_clamp_value (MxAdjustment *adjustment);

Get the value of the “clamp-value” property.

Parameters

adjustment

A MxAdjustment

 

Returns

the current value of the "clamp-value" property.

Since: 1.2


mx_adjustment_set_clamp_value ()

void
mx_adjustment_set_clamp_value (MxAdjustment *adjustment,
                               gboolean clamp);

Set the value of the “clamp-value” property.

Parameters

adjustment

A MxAdjustment

 

clamp

a gboolean

 

Since: 1.2

Types and Values

struct MxAdjustment

struct MxAdjustment;

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


struct MxAdjustmentClass

struct MxAdjustmentClass {
  void (* changed)                 (MxAdjustment *adjustment);
  void (* interpolation_completed) (MxAdjustment *adjustment);

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
};

Base class for MxAdjustment.

Members

changed ()

Class handler for the ::changed signal.

 

interpolation_completed ()

   

_padding_0 ()

   

_padding_1 ()

   

_padding_2 ()

   

_padding_3 ()

   

Property Details

The “clamp-value” property

  “clamp-value”              gboolean

Clamp the adjustment value between the lower and upper values, respecting the page-size.

Owner: MxAdjustment

Flags: Read / Write

Default value: TRUE


The “elastic” property

  “elastic”                  gboolean

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

Owner: MxAdjustment

Flags: Read / Write

Default value: FALSE


The “lower” property

  “lower”                    gdouble

Lower bound.

Owner: MxAdjustment

Flags: Read / Write / Construct

Default value: 0


The “page-increment” property

  “page-increment”           gdouble

Page increment.

Owner: MxAdjustment

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0


The “page-size” property

  “page-size”                gdouble

Page size.

Owner: MxAdjustment

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0


The “step-increment” property

  “step-increment”           gdouble

Step increment.

Owner: MxAdjustment

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 1


The “upper” property

  “upper”                    gdouble

Upper bound.

Owner: MxAdjustment

Flags: Read / Write / Construct

Default value: 0


The “value” property

  “value”                    gdouble

Current value.

Owner: MxAdjustment

Flags: Read / Write / Construct

Default value: 0

Signal Details

The “changed” signal

void
user_function (MxAdjustment *mxadjustment,
               gpointer      user_data)

Emitted when any of the adjustment values have changed

Parameters

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “interpolation-completed” signal

void
user_function (MxAdjustment *mxadjustment,
               gpointer      user_data)

Emitted when the animation started by mx_adjustment_interpolate completes

Parameters

user_data

user data set when the signal handler was connected.

 

Flags: Run Last