| Mx Toolkit Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
struct MxAdjustment; struct MxAdjustmentClass; MxAdjustment * mx_adjustment_new (void); MxAdjustment * mx_adjustment_new_with_values (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); gdouble mx_adjustment_get_lower (MxAdjustment *adjustment); void mx_adjustment_set_lower (MxAdjustment *adjustment,gdouble lower); gdouble mx_adjustment_get_upper (MxAdjustment *adjustment); void mx_adjustment_set_upper (MxAdjustment *adjustment,gdouble upper); gdouble mx_adjustment_get_step_increment (MxAdjustment *adjustment); void mx_adjustment_set_step_increment (MxAdjustment *adjustment,gdouble increment); gdouble mx_adjustment_get_page_increment (MxAdjustment *adjustment); void mx_adjustment_set_page_increment (MxAdjustment *adjustment,gdouble increment); gdouble mx_adjustment_get_page_size (MxAdjustment *adjustment); void mx_adjustment_set_page_size (MxAdjustment *adjustment,gdouble page_size); 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); void mx_adjustment_interpolate_relative (MxAdjustment *adjustment,gdouble offset,guint duration,gulong mode); gboolean mx_adjustment_get_elastic (MxAdjustment *adjustment); void mx_adjustment_set_elastic (MxAdjustment *adjustment,gboolean elastic); gboolean mx_adjustment_get_clamp_value (MxAdjustment *adjustment); void mx_adjustment_set_clamp_value (MxAdjustment *adjustment,gboolean clamp);
"clamp-value" gboolean : Read / Write "elastic" gboolean : Read / Write "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
The MxAdjustment object represents a range of values bounded between a minimum and maximum, together with step and page increments and a page size.
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 {
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.
MxAdjustment * mx_adjustment_new (void);
Create a new MxAdjustment
Returns : |
a newly allocated MxAdjustment |
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.
gdouble mx_adjustment_get_value (MxAdjustment *adjustment);
Get the current value of the "value" property
|
An MxAdjustment |
Returns : |
the current value of the "value" property |
void mx_adjustment_set_value (MxAdjustment *adjustment,gdouble value);
Set the value of the "value" property.
|
An MxAdjustment |
|
A gdouble |
gdouble mx_adjustment_get_lower (MxAdjustment *adjustment);
Get the value of the "lower" property.
|
A MxAdjustment |
Returns : |
the current value of the "lower" property. |
void mx_adjustment_set_lower (MxAdjustment *adjustment,gdouble lower);
Set the value of the "lower" property.
|
A MxAdjustment |
|
A gdouble |
gdouble mx_adjustment_get_upper (MxAdjustment *adjustment);
Get the value of the "upper" property.
|
A MxAdjustment |
Returns : |
the current value of the "upper" property. |
void mx_adjustment_set_upper (MxAdjustment *adjustment,gdouble upper);
Set the value of the "upper" property.
|
A MxAdjustment |
|
A gdouble |
gdouble mx_adjustment_get_step_increment (MxAdjustment *adjustment);
Get the value of the MxAdjustment:step-increment property.
|
A MxAdjustment |
Returns : |
the current value of the "step-increment" property. |
void mx_adjustment_set_step_increment (MxAdjustment *adjustment,gdouble increment);
Set the value of the "step-increment" property.
|
A MxAdjustment |
|
A gdouble |
gdouble mx_adjustment_get_page_increment (MxAdjustment *adjustment);
Get the value of the MxAdjustment:page-increment property.
|
A MxAdjustment |
Returns : |
the current value of the "page-increment" property. |
void mx_adjustment_set_page_increment (MxAdjustment *adjustment,gdouble increment);
Set the value of the "page-increment" property.
|
A MxAdjustment |
|
A gdouble |
gdouble mx_adjustment_get_page_size (MxAdjustment *adjustment);
Get the value of the "page-size" property.
|
A MxAdjustment |
Returns : |
the current value of the "page-size" property. |
void mx_adjustment_set_page_size (MxAdjustment *adjustment,gdouble page_size);
Set the "page-size" property.
|
A MxAdjustment |
|
A gdouble |
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.
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.
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.
|
A MxAdjustment |
|
A gdouble |
|
duration in milliseconds |
|
A ClutterAnimationMode |
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.
|
A MxAdjustment |
|
A gdouble |
|
duration in milliseconds |
|
A ClutterAnimationMode |
gboolean mx_adjustment_get_elastic (MxAdjustment *adjustment);
Get the value of the "elastic" property.
|
A MxAdjustment |
Returns : |
the current value of the "elastic" property. |
void mx_adjustment_set_elastic (MxAdjustment *adjustment,gboolean elastic);
Set the value of the "elastic" property.
|
A MxAdjustment |
|
A gboolean |
gboolean mx_adjustment_get_clamp_value (MxAdjustment *adjustment);
Get the value of the "clamp-value" property.
|
A MxAdjustment |
Returns : |
the current value of the "clamp-value" property. |
Since 1.2
void mx_adjustment_set_clamp_value (MxAdjustment *adjustment,gboolean clamp);
Set the value of the "clamp-value" property.
|
A MxAdjustment |
|
a gboolean |
Since 1.2
"clamp-value" property"clamp-value" gboolean : Read / Write
Clamp the adjustment value between the lower and upper values, respecting the page-size.
Default value: TRUE
"elastic" property"elastic" gboolean : Read / Write
Make interpolation behave in an 'elastic' way and stop clamping value.
Default value: FALSE
"page-increment" property"page-increment" gdouble : Read / Write / Construct
Page increment.
Allowed values: >= 0
Default value: 0
"page-size" property"page-size" gdouble : Read / Write / Construct
Page size.
Allowed values: >= 0
Default value: 0
"step-increment" property"step-increment" gdouble : Read / Write / Construct
Step increment.
Allowed values: >= 0
Default value: 1
"changed" signalvoid user_function (MxAdjustment *arg0,
gpointer user_data) : Run Last
Emitted when any of the adjustment values have changed
|
user data set when the signal handler was connected. |
"interpolation-completed" signalvoid user_function (MxAdjustment *arg0,
gpointer user_data) : Run Last
Emitted when the animation started by mx_adjustment_interpolate completes
|
user data set when the signal handler was connected. |