Gtk2HsContentsIndex
Graphics.UI.Gtk.Misc.Adjustment
Description

An adjustment is a bounded value controlled by the user.

An Adjustment object contains a value with maximum bounds and a step size. It is used to represent the value of a scoll bar and similar widgets. In particular it is contained in the abstract Range widget.

Synopsis
data Adjustment
class ObjectClass o => AdjustmentClass o
castToAdjustment :: GObjectClass obj => obj -> Adjustment
adjustmentNew :: Double -> Double -> Double -> Double -> Double -> Double -> IO Adjustment
adjustmentSetLower :: Adjustment -> Double -> IO ()
adjustmentGetLower :: Adjustment -> IO Double
adjustmentSetPageIncrement :: Adjustment -> Double -> IO ()
adjustmentGetPageIncrement :: Adjustment -> IO Double
adjustmentSetPageSize :: Adjustment -> Double -> IO ()
adjustmentGetPageSize :: Adjustment -> IO Double
adjustmentSetStepIncrement :: Adjustment -> Double -> IO ()
adjustmentGetStepIncrement :: Adjustment -> IO Double
adjustmentSetUpper :: Adjustment -> Double -> IO ()
adjustmentGetUpper :: Adjustment -> IO Double
adjustmentSetValue :: Adjustment -> Double -> IO ()
adjustmentGetValue :: Adjustment -> IO Double
adjustmentClampPage :: Adjustment -> Double -> Double -> IO ()
onAdjChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
afterAdjChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
onValueChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
afterValueChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
Documentation
data Adjustment
Instances
AdjustmentClass Adjustment
ObjectClass Adjustment
GObjectClass Adjustment
class ObjectClass o => AdjustmentClass o
Instances
AdjustmentClass Adjustment
castToAdjustment :: GObjectClass obj => obj -> Adjustment
adjustmentNew :: Double -> Double -> Double -> Double -> Double -> Double -> IO Adjustment

Create a new Adjustment object.

  • 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 range.
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 ()
Set the current value of the Adjustment object.
adjustmentGetValue :: Adjustment -> IO Double
Get the current value of the Adjustment object.
adjustmentClampPage :: Adjustment -> Double -> Double -> IO ()

Ensure that the alignment is within these bounds.

  • Updates the Adjustment value to ensure that the range between lower and upper is in the current page (i.e. between value and value + page_size). 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.
onAdjChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
This signal is emitted if some value of Adjustment except value itself changes.
afterAdjChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
onValueChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
This signal is emitted if the value of the Alignment object changed.
afterValueChanged :: Adjustment -> IO () -> IO (ConnectId Adjustment)
Produced by Haddock version 0.6