Safe Haskell	None

HGamer3D.Bindings.CEGUI.ClassScrollbar

Synopsis

Documentation

getDocumentSize Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

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

getPageSize Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

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

getStepSize Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

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.

getOverlapSize Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

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

getScrollPosition Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float

Return a pointer to the increase PushButtoncomponent widget for this Scrollbar

getIncreaseButton Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to a

getDecreaseButton Source

Arguments

:: 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

getThumb Source

Arguments

:: 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

initialiseComponents Source

Arguments

:: 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

setDocumentSize Source

Arguments

:: 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).

setPageSize Source

Arguments

:: 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).

setStepSize Source

Arguments

:: 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.

setOverlapSize Source

Arguments

:: 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.

setScrollPosition Source

Arguments

:: 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.

setEndLockEnabled Source

Arguments

:: 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.

new Source

Arguments