Safe Haskell | None |
---|
- getDocumentSize :: HG3DClass -> IO Float
- getPageSize :: HG3DClass -> IO Float
- getStepSize :: HG3DClass -> IO Float
- getOverlapSize :: HG3DClass -> IO Float
- getScrollPosition :: HG3DClass -> IO Float
- getIncreaseButton :: HG3DClass -> IO HG3DClass
- getDecreaseButton :: HG3DClass -> IO HG3DClass
- getThumb :: HG3DClass -> IO HG3DClass
- initialiseComponents :: HG3DClass -> IO ()
- setDocumentSize :: HG3DClass -> Float -> IO ()
- setPageSize :: HG3DClass -> Float -> IO ()
- setStepSize :: HG3DClass -> Float -> IO ()
- setOverlapSize :: HG3DClass -> Float -> IO ()
- setScrollPosition :: HG3DClass -> Float -> IO ()
- setEndLockEnabled :: HG3DClass -> Bool -> IO ()
- new :: String -> String -> IO HG3DClass
- isEndLockEnabled :: HG3DClass -> IO Bool
- delete :: HG3DClass -> IO ()
- getDocumentSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getPageSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getStepSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getOverlapSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getScrollPosition'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()
- getIncreaseButton'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- getDecreaseButton'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- getThumb'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- initialiseComponents'_ :: HG3DClassPtr -> IO ()
- setDocumentSize'_ :: HG3DClassPtr -> CFloat -> IO ()
- setPageSize'_ :: HG3DClassPtr -> CFloat -> IO ()
- setStepSize'_ :: HG3DClassPtr -> CFloat -> IO ()
- setOverlapSize'_ :: HG3DClassPtr -> CFloat -> IO ()
- setScrollPosition'_ :: HG3DClassPtr -> CFloat -> IO ()
- setEndLockEnabled'_ :: HG3DClassPtr -> CInt -> IO ()
- isEndLockEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- new'_ :: Ptr CChar -> Ptr CChar -> HG3DClassPtr -> IO ()
- delete'_ :: HG3DClassPtr -> IO ()
Documentation
Return the page size for this scroll bar. - Details: The page size is typically the amount of data that can be displayed at one time. This value is also used when calculating the amount the position will change when you click either side of the scroll bar thumb, the amount the position changes will is (pageSize - overlapSize).
Return the size of the document or data. - Details: The document size should be thought of as the total size of the data that is being scrolled through (the number of lines in a text file for example).
Return the step size for this scroll bar. - Details: The step size is typically a single unit of data that can be displayed, this is the amount the position will change when you click either of the arrow buttons on the scroll bar. (this could be 1 for a single line of text, for example).
Return the overlap size for this scroll bar. - Details: The overlap size is the amount of data from the end of a page
that
will remain visible when the position is moved by a page. This is
usually used so that the user keeps some context of where they were
within the document's data when jumping a page at a time.
Return the current position of scroll bar within the document. - Details: The range of the scroll bar is from 0 to the size of the document minus the size of a page (0 <= position <= (documentSize - pageSize)).
Return a pointer to the increase
PushButtoncomponent widget for this Scrollbar
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> IO HG3DClass | return value - Pointer to a |
Return a pointer to the decrease
PushButtonScrollbar
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> IO HG3DClass | return value - Pointer to a |
Return a pointer to the ThumbScrollbar
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> IO () | return value - Nothing |
Set the size of the document or data. - Details: The document size should be thought of as the total size of the data that is being scrolled through (the number of lines in a text file for example).
Initialises the Scrollbar - Details: This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Float | document_size |
-> IO () |
Set the page size for this scroll bar. - Details: The page size is typically the amount of data that can be displayed at one time. This value is also used when calculating the amount the position will change when you click either side of the scroll bar thumb, the amount the position changes will is (pageSize - overlapSize).
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Float | page_size |
-> IO () |
Set the step size for this scroll bar. - Details: The step size is typically a single unit of data that can be displayed, this is the amount the position will change when you click either of the arrow buttons on the scroll bar. (this could be 1 for a single line of text, for example).
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Float | step_size |
-> IO () |
Set the overlap size for this scroll bar. - Details: The overlap size is the amount of data from the end of a page
that
will remain visible when the position is moved by a page. This is
usually used so that the user keeps some context of where they were
within the document's data when jumping a page at a time.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Float | overlap_size |
-> IO () |
Set the current position of scroll bar within the document. - Details: The range of the scroll bar is from 0 to the size of the document minus the size of a page (0 <= position <= (documentSize - pageSize)), any attempt to set the position outside this range will be adjusted so that it falls within the legal range.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Float | position |
-> IO () |
Enable or disable the 'end lock' mode for the scrollbar. - Details: When enabled and the current position of the scrollbar is at the end of it's travel, the end lock mode of the scrollbar will automatically update the position when the document and/or page size change in order that the scroll position will remain at the end of it's travel. This can be used to implement auto-scrolling in certain other widget types.
:: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
-> Bool | enabled |
-> IO () |
Returns whether the 'end lock'mode for the scrollbar is enabled. - Details: When enabled, and the current position of the scrollbar is at the end of it's travel, the end lock mode of the scrollbar will automatically update the scrollbar position when the document and/or page size change in order that the scroll position will remain at the end of it's travel. This can be used to implement auto-scrolling in certain other widget types.
Constructor for Scrollbar
Destructor for Scrollbar
getDocumentSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getPageSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getStepSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getOverlapSize'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getScrollPosition'_ :: HG3DClassPtr -> Ptr CFloat -> IO ()Source
getIncreaseButton'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
getDecreaseButton'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
getThumb'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
initialiseComponents'_ :: HG3DClassPtr -> IO ()Source
setDocumentSize'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setPageSize'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setStepSize'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setOverlapSize'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setScrollPosition'_ :: HG3DClassPtr -> CFloat -> IO ()Source
setEndLockEnabled'_ :: HG3DClassPtr -> CInt -> IO ()Source
isEndLockEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
delete'_ :: HG3DClassPtr -> IO ()Source