DigitalSpaces::DICEGUIScrollbar Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
float	getDocumentSize ()
	Return the size of the document or data.
float	getPageSize ()
	Return the page size for this scroll bar.
float	getStepSize ()
	Return the step size for this scroll bar.
float	getOverlapSize ()
	Return the overlap size for this scroll bar.
float	getScrollPosition ()
	Return the current position of scroll bar within the document.
DICEGUIButton *	getIncreaseButton ()
	Return a pointer to the 'increase' PushButtoncomponent widget for this Scrollbar.
DICEGUIButton *	getDecreaseButton ()
	Return a pointer to the 'decrease' PushButton component widget for this Scrollbar.
DICEGUIThumb *	getThumb ()
	Return a pointer to the Thumb component widget for this Scrollbar.
void	initialiseComponents ()
	Initialises the Scrollbar object ready for use.
void	setDocumentSize (float document_size)
	Set the size of the document or data.
void	setPageSize (float page_size)
	Set the page size for this scroll bar.
void	setStepSize (float step_size)
	Set the step size for this scroll bar.
void	setOverlapSize (float overlap_size)
	Set the overlap size for this scroll bar.
void	setScrollPosition (float position)
	Set the current position of scroll bar within the document.

---

Member Function Documentation

float DigitalSpaces::DICEGUIScrollbar::getDocumentSize

(

)

Return the size of the document or data.

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

Note:

The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns:

float value specifying the currently set document size.

float DigitalSpaces::DICEGUIScrollbar::getPageSize

(

)

Return the page size for this scroll bar.

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

Note:

The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns:

float value specifying the currently set page size.

float DigitalSpaces::DICEGUIScrollbar::getStepSize

(

)

Return the step size for this scroll bar.

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

Note:

The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns:

float value specifying the currently set step size.

float DigitalSpaces::DICEGUIScrollbar::getOverlapSize

(

)

Return the overlap size for this scroll bar.

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.

Note:

The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns:

float value specifying the currently set overlap size.

float DigitalSpaces::DICEGUIScrollbar::getScrollPosition

(

)

Return the current position of scroll bar within the document.

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

Note:

The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns:

float value specifying the current position of the scroll bar within its document.

DICEGUIButton* DigitalSpaces::DICEGUIScrollbar::getIncreaseButton

(

)

Return a pointer to the 'increase' PushButtoncomponent widget for this Scrollbar.

Returns:

Pointer to a PushButton object.

Exceptions:

UnknownObjectException

Thrown if the increase PushButton component does not exist.

DICEGUIButton* DigitalSpaces::DICEGUIScrollbar::getDecreaseButton

(

)

Return a pointer to the 'decrease' PushButton component widget for this Scrollbar.

Returns:

Pointer to a PushButton object.

Exceptions:

UnknownObjectException

Thrown if the 'decrease' PushButton component does not exist.

DICEGUIThumb* DigitalSpaces::DICEGUIScrollbar::getThumb

(

)

Return a pointer to the Thumb component widget for this Scrollbar.

Returns:

Pointer to a Thumb object.

Exceptions:

UnknownObjectException

Thrown if the Thumb component does not exist.

void DigitalSpaces::DICEGUIScrollbar::initialiseComponents

(

)

Initialises the Scrollbar object ready for use.

Note:

This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window type.

Returns:

Nothing

void DigitalSpaces::DICEGUIScrollbar::setDocumentSize

(

float

document_size

)

Set the size of the document or data.

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

Note:

The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters:

document_size

float value specifying the document size.

Returns:

Nothing.

void DigitalSpaces::DICEGUIScrollbar::setPageSize

(

float

page_size

)

Set the page size for this scroll bar.

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

Note:

The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters:

page_size

float value specifying the page size.

Returns:

Nothing.

void DigitalSpaces::DICEGUIScrollbar::setStepSize

(

float

step_size

)

Set the step size for this scroll bar.

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

Note:

The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters:

step_size

float value specifying the step size.

Returns:

Nothing.

void DigitalSpaces::DICEGUIScrollbar::setOverlapSize

(

float

overlap_size

)

Set the overlap size for this scroll bar.

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.

Note:

The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters:

overlap_size

float value specifying the overlap size.

Returns:

Nothing.

void DigitalSpaces::DICEGUIScrollbar::setScrollPosition

(

float

position

)

Set the current position of scroll bar within the document.

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.

Note:

The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters:

position

float value specifying the position of the scroll bar within its document.

Returns:

Nothing.

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h