|Portability||portable (depends on GHC)|
|A Object representing an adjustable bounded value
The Adjustment object represents a value which has an associated lower
and upper bound, together with step and page increments, and a page size. It
is used within several Gtk+ widgets, including SpinButton, Viewport, and
Range (which is a base class for HScrollbar, VScrollbar, HScale, and
The Adjustment object does not update the value itself. Instead it is
left up to the owner of the Adjustment to control the value.
The owner of the Adjustment typically calls the
adjustmentValueChanged and adjustmentChanged functions after changing
the value and its bounds. This results in the emission of the
"value_changed" or "changed" signal respectively.
|data Adjustment |
|class ObjectClass o => AdjustmentClass o |
|castToAdjustment :: GObjectClass obj => obj -> Adjustment|
|:: Double||value - the initial value.
|-> Double||lower - the minimum value.
|-> Double||upper - the maximum value.
|-> Double||stepIncrement - the step increment.
|-> Double||pageIncrement - the page increment.
|-> Double||pageSize - the page size.
|-> IO Adjustment|
Creates a new Adjustment.
The creation function take every value that is contained in the object:
value is the initial value and should be between the upper and lower
bounds of the slider. Clicking on the arrows increases this value by
stepIncrement. Clicking in the slider advances by pageIncrement. The
pageSize is needed to determine if the end of the slider is still in the
|adjustmentSetLower :: Adjustment -> Double -> IO ()|
|Set the lower value.
|adjustmentGetLower :: Adjustment -> IO Double|
|Retrieve the lower value.
|adjustmentSetPageIncrement :: Adjustment -> Double -> IO ()|
|Set the page increment value.
|adjustmentGetPageIncrement :: Adjustment -> IO Double|
|Retrieve the pageincrement value.
|adjustmentSetPageSize :: Adjustment -> Double -> IO ()|
|Set the page size value.
|adjustmentGetPageSize :: Adjustment -> IO Double|
|Retrieve the page size value.
|adjustmentSetStepIncrement :: Adjustment -> Double -> IO ()|
|Set the step-increment value.
|adjustmentGetStepIncrement :: Adjustment -> IO Double|
|Retrieve the step-increment value.
|adjustmentSetUpper :: Adjustment -> Double -> IO ()|
|Set the upper value.
|adjustmentGetUpper :: Adjustment -> IO Double|
|Retrieve the upper value.
|adjustmentSetValue :: Adjustment -> Double -> IO ()|
Sets the current value of the Adjustment object. The value is clamped to
lie between the adjustment's lower and upper values. See adjustmentNew
for details of these properties.
Note that for adjustments which are used in a Scrollbar, the effective
range of allowed values goes from lower to upper - page_size.
|adjustmentGetValue :: Adjustment -> IO Double|
|Gets the current value of the adjustment. See adjustmentSetValue.
|-> Double||lower - the lower value.
|-> Double||upper - the upper value.
|-> IO ()|
|Updates the Adjustment value to ensure that the range between lower
and upper is in the current page (i.e. between value and value +
pageSize). If the range is larger than the page size, then only the start
of it will be in the current page. A "changed" signal will be emitted if
the value is changed.
|adjustmentValue :: Attr Adjustment Double|
The value of the adjustment.
Default value: 0
|adjustmentStepIncrement :: Attr Adjustment Double|
|adjustmentPageIncrement :: Attr Adjustment Double|
|adjustmentPageSize :: Attr Adjustment Double|
|onAdjChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)|
|Emitted when one or more of the Adjustment fields have been changed,
other than the value field.
|afterAdjChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)|
|onValueChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)|
|Emitted when the Adjustment value field has been changed.
|afterValueChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)|
|Produced by Haddock version 0.7|