Guiliani  Version 2.4 revision 5970 (build 3)
CGUIScrollBar Class Reference

The ScrollBar allows navigating controls which are larger than their actual visual representation. More...

#include <GUIScrollBar.h>

Inheritance diagram for CGUIScrollBar:

Public Member Functions

 CGUIScrollBar (CGUICompositeObject *const pParent, CGUIObject *const pScrolledObject, const eC_UInt &uiStepSize=1, const CGUIRange::Base_t &eBase=CGUIRange::BASE_AT_MINIMUM, const CGUICommonEnums::Orientation_t &eStyle=CGUICommonEnums::OR_HORIZONTAL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIScrollBar ()
 
virtual ~CGUIScrollBar ()
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
eC_Bool DoClick (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
CGUIButtonGetDownRightButton () const
 
const CGUIRangeGetRange () const
 
CGUIObjectGetScrolledObject () const
 
eC_UInt GetScrollInterval () const
 
eC_UInt GetScrollSpeed () const
 
CGUISliderGetSlider () const
 
CGUIButtonGetUpLeftButton () const
 
void HideButtons (const eC_Bool &bHide)
 
void OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)
 
virtual void ReadFromStream ()
 
void RecalculateScrollingRange (const eC_Value vCLipperSize)
 
virtual void RemoveObject (CGUIObject *pObject)
 
void SetScrolledObject (CGUIObject *pObject)
 
void SetScrollInterval (const eC_UInt &ruiScrollInterval)
 
void SetScrollSpeed (const eC_UInt &ruiScrollSpeed) const
 
eC_Bool SetValue (const CGUIValue &rkValue)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUICompositeObject
 CGUICompositeObject ()
 
 CGUICompositeObject (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUICompositeObject (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUICompositeObject (const CGUICompositeObject &kSource)
 
virtual ~CGUICompositeObject ()
 This destructor is automatically virtual, as the base class destructor is virtual.
 
virtual eC_Bool AddObject (CGUIObject *pkObject)
 
eC_Bool BringToFront (const CGUIObject *pkObject)
 
eC_Bool CanBeCyclicFocussed () const
 
virtual eC_Bool DoPostDraw ()
 
void DrawOnTop (CGUIObject *pkObject)
 
void DrawOnTopOf (CGUIObject *const pkObject, CGUIObject *const pDrawOnTopOf)
 
virtual CGUIObjectFindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
void Flip (const eC_Bool &rbVertical)
 
eC_Bool FocusAny ()
 
virtual eC_Bool FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
virtual eC_Bool FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
const CGUIObjectGetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const
 
CGUIObjectGetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)
 
CGUIObjectGetChild (const eC_UInt uIndex) const
 
CGUIObjectGetChild (const eC_UInt uIndex)
 
const ObjectPtrListGetChildObjectsList () const
 
const ObjectPtrListGetDrawOrderList () const
 
eC_Int GetIndexOfChild (const CGUIObject *pkObject) const
 
eC_UInt GetNumberOfChildren () const
 
CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
eC_Bool InsertChildAt (const eC_UInt cuiIndex, CGUIObject *pkChild)
 
void InvalidateChildren ()
 Invalidates all chidren, but not this parent.
 
eC_Bool IsAncestorOf (const CGUIObject *pkObject) const
 
virtual eC_Bool IsCompositeObject () const
 
eC_Bool LowerOneLevel (const CGUIObject *pkObject)
 
CGUICompositeObjectoperator= (const CGUICompositeObject &kSource)
 
eC_Bool RaiseOneLevel (const CGUIObject *pkObject)
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveAllChildren ()
 
void Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)
 
eC_Bool SendToBack (const CGUIObject *pkObject)
 
virtual void SetClickThrough (const eC_Bool &bClickThrough)
 
virtual void SetClickThrough (const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough)
 
void SetCyclicFocus (const eC_Bool &bCyclicFocus)
 
virtual void SetDisabled (const eC_Bool &bDisabled)
 
virtual void SetDisabled (const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled)
 
virtual void SetFocussable (const eC_Bool &bFocussable)
 
virtual void SetFocussable (const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable)
 
virtual void SetGrayedOut (const eC_Bool &bGrayedOut)
 
virtual void SetGrayedOut (const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut)
 
virtual void SetHeight (const eC_Value &vY)
 
virtual void SetInvisible (const eC_Bool &bInvisible)
 
virtual void SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)
 
virtual void SetWidth (const eC_Value &vX)
 
- Public Member Functions inherited from CGUIObject
 CGUIObject (CGUICompositeObject *const pParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject ()
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pObserver)
 
eC_Bool CalculateInvalidatedRect (CGUIRect &rRect) const
 
virtual eC_Bool ClaimFocus ()
 
virtual void CreateSnapshot (eC_UInt uiBackColor=0x00)
 
eC_Bool DataPoolConnectorExists () const
 
void DeleteSnapshot ()
 
virtual void DisableSnapshotDrawing (eC_Bool bDeleteSnapshot=true)
 
virtual eC_Bool DoDraw ()
 
virtual eC_Bool DoDrawSnapshot ()
 
virtual void EnableSnapshotDrawing ()
 
CGUIRect GetAbsRect () const
 
eC_Value GetAbsXPos () const
 
eC_Value GetAbsXPosCenter () const
 
eC_Value GetAbsXPosREdge () const
 
eC_Value GetAbsYPos () const
 
eC_Value GetAbsYPosBEdge () const
 
eC_Value GetAbsYPosCenter () const
 
eC_UByte GetAlpha () const
 
CGUIBehaviourDecoratorGetBehaviour ()
 
const CGUIBehaviourDecoratorGetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlaneGetBitmapPlane () const
 
CGUIRect GetCurrentAbsRect () const
 
eC_Value GetCurrentAbsXPos () const
 
eC_Value GetCurrentAbsXPosCenter () const
 
eC_Value GetCurrentAbsXPosREdge () const
 
eC_Value GetCurrentAbsYPos () const
 
eC_Value GetCurrentAbsYPosBEdge () const
 
eC_Value GetCurrentAbsYPosCenter () const
 
CDataPoolConnectorGetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouterGetLayouter ()
 
const CGUILayouterGetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObjectGetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObjectGetParent ()
 
const CGUICompositeObjectGetParent () const
 
CGUIRect GetRelRect () const
 
eC_Value GetRelXPos () const
 
eC_Value GetRelXPosCenter () const
 
eC_Value GetRelXPosREdge () const
 
eC_Value GetRelYPos () const
 
eC_Value GetRelYPosBEdge () const
 
eC_Value GetRelYPosCenter () const
 
eC_Value GetWidth () const
 
void InvalidateArea ()
 
eC_Bool IsClickable () const
 
eC_Bool IsClickThrough () const
 
eC_Bool IsDescendantOf (const CGUIObject *const pAncestor) const
 
eC_Bool IsDisabled () const
 
eC_Bool IsDragable () const
 
eC_Bool IsDragged () const
 
eC_Bool IsDrawingSnapshot () const
 
eC_Bool IsFocussable () const
 
eC_Bool IsFocussed () const
 
eC_Bool IsGrayedOut () const
 
virtual eC_Bool IsHighlightable () const
 
eC_Bool IsHighlighted () const
 
eC_Bool IsInvisible () const
 
eC_Bool IsPressed () const
 
eC_Bool IsStopFocus () const
 
void NotifyValueObservers (const CGUIValue &kValue, const eC_UInt uiX=0, const eC_UInt uiY=0)
 
CGUIObjectoperator= (const CGUIObject &kSource)
 
void RemoveValueObserver (CGUIObserver *pObserver)
 
void RenderToBitmap (eC_UInt uiBitmapID, eC_Value vXOffset=eC_FromInt(0), eC_Value vYOffset=eC_FromInt(0))
 
eC_Bool RequestFocus ()
 
void SetAlpha (eC_UByte ubAlpha)
 
void SetBehaviour (CGUIBehaviourDecorator *pBehaviour)
 
void SetClickThrough (const eC_Bool &bClickThrough)
 
void SetID (const ObjectHandle_t &eID)
 
void SetLayouter (CGUILayouter *pLayouter)
 
void SetNeighborBottomID (const ObjectHandle_t eNewNeighborBottomID)
 
void SetNeighborIDs (const ObjectHandle_t eNewNeighborLeftID, const ObjectHandle_t eNewNeighborRightID, const ObjectHandle_t eNewNeighborTopID, const ObjectHandle_t eNewNeighborBottomID)
 
void SetNeighborLeftID (const ObjectHandle_t eNewNeighborLeftID)
 
void SetNeighborRightID (const ObjectHandle_t eNewNeighborRightID)
 
void SetNeighborTopID (const ObjectHandle_t eNewNeighborTopID)
 
virtual void SetParent (CGUICompositeObject *const pParent)
 
void SetRelRect (const CGUIRect &kNewRect)
 
virtual void SetRelXPos (const eC_Value &vX)
 
void SetRelXPosCenter (const eC_Value &vXCenter)
 
void SetRelXPosREdge (const eC_Value &vX)
 
virtual void SetRelYPos (const eC_Value &vY)
 
void SetRelYPosBEdge (const eC_Value &vY)
 
void SetRelYPosCenter (const eC_Value &vYCenter)
 
void SetStopFocus (const eC_Bool &bDontFocusToParent)
 
virtual eC_Bool SetValue (CDataPoolEntry &rkValue)
 
- Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool DoUserEvent (CGUIEvent *const pEvent)
 
virtual void OnCreate ()
 
virtual void OnDelete ()
 
virtual void OnHide ()
 
virtual void OnShow ()
 
virtual eC_Bool DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual eC_Bool Decrease ()
 
virtual eC_Bool Increase ()
 
virtual eC_Bool DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoScrollUp (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoScrollDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoScrollLeft (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoScrollRight (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
void SetXMLTag (const eC_String &kXMLTag)
 
- Public Member Functions inherited from CGUIAnimatable
virtual ~CGUIAnimatable ()
 Destructor. Removes all existing animation callbacks.
 
virtual eC_Bool IsAnimating () const
 
virtual void StartAnimation ()
 
virtual void StopAnimation ()
 
- Public Member Functions inherited from CGUIObserver
 CGUIObserver ()
 Default constructor.
 
virtual ~CGUIObserver ()
 Default destructor. Notifies all subjects of destruction.
 
const eC_TListDoubleLinked< CGUISubject * > & GetSubjectList () const
 
virtual void OnNotification ()
 Called by CGUISubject whenever an observed object triggers an update.
 
virtual void OnNotification (const eC_String &kMessage)
 
virtual void OnNotification (const CGUIObject *const pkUpdatedObject)
 
void SetAutoDelete (const eC_Bool bAutoDelete)
 

Protected Member Functions

eC_Bool DoButtonDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
eC_Bool DoDragEnd (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
- Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
ObjectPtrListGetChildObjectsList ()
 
virtual void HandleDraw (const CGUIRect &ClipRect)
 
- Protected Member Functions inherited from CGUIObject
virtual eC_Bool CreateBitmapPlane ()
 
- Protected Member Functions inherited from CGUIStreamableObject
eC_UInt ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const
 
void WriteStreamingFooter (const eC_Bool &bWriteClassID) const
 
void WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const
 
- Protected Member Functions inherited from CGUIObserver
virtual void AddSubject (CGUISubject *pSubjectToAdd)
 
virtual void RemoveSubject (CGUISubject *pSubjectToRemove)
 

Additional Inherited Members

- Public Types inherited from CGUIObject
enum  FourWayFocus_t { FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUS_DOWN }
 
- Static Public Attributes inherited from CGUICompositeObject
static const eC_Char XMLTAG_CHILDREN [] = "Children"
 XML comment tag to be used before writing children to a stream.
 
static const eC_Char XMLTAG_ENDCHILDREN [] = "/Children"
 XML comment tag to be used after writing children to a stream.
 
- Static Public Attributes inherited from CGUIObject
static const eC_Char XMLTAG_ALPHA [] = "Alpha"
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH [] = "ClickThrough"
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID [] = "ControlClassID"
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED [] = "Disabled"
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE [] = "Focussable"
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT [] = "GrayedOut"
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT [] = "Height"
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE [] = "Invisible"
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID [] = "ObjectID"
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS [] = "OverriddenNeighbors"
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_WIDTH [] = "Width"
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS [] = "XPos"
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS [] = "YPos"
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID [] = "BehaviourClassID"
 XML tag to be used when writing a behaviour class ID into a stream.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION [] = "ClassVersion"
 

Detailed Description

The ScrollBar allows navigating controls which are larger than their actual visual representation.

A GUIScrollBar is a CompositeObject which consists of two CGUIButton objects and a CGUISlider. It can be attached to a CompositeObject. If this composite object has children that lie outside of its visual area, the ScrollBar will automatically initialize itself to a scrolling range which is sufficient to make all of the composite object's children visible. You can either use the slider or the two buttons (which will act as up and down arrow) to navigate the visible area of the CompositeObject. If you click a button and hold it, the scrollbar will start an animation and scrolls until the border is reached or the button is released.

The only object which is scrolled by this class is the one passed to SetScrolledObject().

Be aware that you have access to all child objects of this control. If you don't use this feature carefully, you can produce strange behaviours.

Example:

// Creates the object which is going to be scrolled using the ScrollBar.
CGUIImage* pObject = new CGUIImage(&GETGUI, eC_FromInt(0), eC_FromInt(0), eC_Mul(eC_FromInt(2), GETGUI.GetWidth()), GETGUI.GetHeight(), IMG_STDCTRL_PLACEHOLDER);
// Create a scroll bar.
CGUIScrollBar* pkScrollBar = new CGUIScrollBar(&GETGUI, NULL, 1, CGUIRange::BASE_AT_MINIMUM, CGUIBaseSlider::SLD_HORIZONTAL, NO_HANDLE);
// Link ScrollBar to scrolled object
pkScrollBar->SetScrolledObject(pObject);

Constructor & Destructor Documentation

◆ CGUIScrollBar() [1/2]

CGUIScrollBar::CGUIScrollBar ( CGUICompositeObject *const  pParent,
CGUIObject *const  pScrolledObject,
const eC_UInt &  uiStepSize = 1,
const CGUIRange::Base_t eBase = CGUIRange::BASE_AT_MINIMUM,
const CGUICommonEnums::Orientation_t eStyle = CGUICommonEnums::OR_HORIZONTAL,
const ObjectHandle_t eID = NO_HANDLE 
)

Constructor This attaches the ScrollBar as a child to the given CompositeObject. The ScrollBar will automatically calculate its size and position with regard to the specified style and its scrolled object.

Parameters
pParentThe scroll bar's parent object.
pScrolledObjectPointer to the CompositeObject which is to be scrolled.
uiStepSizeThe step size in units of the range.
eBaseSteps are based at minimum or maximum.
eStyleSpecifies whether this scroll bar will be horizontal or vertical.
eIDObject handle of this scroll bar.

◆ ~CGUIScrollBar()

CGUIScrollBar::~CGUIScrollBar ( )
virtual

Destructor

◆ CGUIScrollBar() [2/2]

CGUIScrollBar::CGUIScrollBar ( )
inline

Standard constructor. Only to be called by factory. No user code should call this constructor, not even in streaming mode (that is, when GUILIANI_STREAM_GUI is defined)!

See also
CGUISlider()

Member Function Documentation

◆ DoAnimate()

void CGUIScrollBar::DoAnimate ( const eC_Value &  vTimes = eC_FromInt(1))
virtual

Handles the scroll animation if the user keeps pressing on one of the scrollbar's buttons

Parameters
vTimesThe correction factor

Reimplemented from CGUIAnimatable.

◆ DoButtonDown()

eC_Bool CGUIScrollBar::DoButtonDown ( const eC_Value &  vAbsX,
const eC_Value &  vAbsY 
)
protectedvirtual

Implemented to start scroll animation.

Parameters
vAbsXX-position in screen coordinates where the click occurred
vAbsYY-position in screen coordinates where the click occurred
Returns
True The event has been handled.
False The event has not been handled.

Reimplemented from CGUIBehaviour.

◆ DoClick()

eC_Bool CGUIScrollBar::DoClick ( const eC_Value &  vAbsX,
const eC_Value &  vAbsY 
)
virtual

Handles the button clicks by increasing or decreasing the slider's value.

Parameters
vAbsXX-position in screen coordinates where the click occurred
vAbsYY-position in screen coordinates where the click occurred
Returns
True The event has been handled.
False The event has not been handled. In this base implementation it always returns False.

Reimplemented from CGUIBehaviour.

◆ DoDragEnd()

eC_Bool CGUIScrollBar::DoDragEnd ( const eC_Value &  vAbsX,
const eC_Value &  vAbsY 
)
protectedvirtual

Implemented to stop scroll animation.

Parameters
vAbsXX-position in screen coordinates where the click occurred
vAbsYY-position in screen coordinates where the click occurred
Returns
True The event has been handled.
False The event has not been handled.

Reimplemented from CGUIBehaviour.

◆ GetDownRightButton()

CGUIButton * CGUIScrollBar::GetDownRightButton ( ) const

Returns the pointer to the down or right button depending on the orientation.

Returns
Pointer to the button object.

◆ GetRange()

const CGUIRange & CGUIScrollBar::GetRange ( ) const

Returns the range of internal slider object.

Returns
Range of internal slider object.

◆ GetScrolledObject()

CGUIObject * CGUIScrollBar::GetScrolledObject ( ) const

Returns the object which is being scrolled using this ScrollBar.

Returns
Pointer to object, which is being scrolled using this ScrollBar

◆ GetScrollInterval()

eC_UInt CGUIScrollBar::GetScrollInterval ( ) const

Returns the scroll interval for auto scroll.

Returns
Scroll interval in ms.

◆ GetScrollSpeed()

eC_UInt CGUIScrollBar::GetScrollSpeed ( ) const

Returns number of pixels to scroll per step, or 0 if the internal slider object does not exist

Returns
Step size or 0.

◆ GetSlider()

CGUISlider * CGUIScrollBar::GetSlider ( ) const

Returns the pointer to slider object.

Returns
Pointer to slider object.

◆ GetUpLeftButton()

CGUIButton * CGUIScrollBar::GetUpLeftButton ( ) const

Returns the pointer to the up or left button depending on the orientation.

Returns
Pointer to the button object.

◆ HideButtons()

void CGUIScrollBar::HideButtons ( const eC_Bool &  bHide)

Shows or hides the buttons depending on given parameter.

Parameters
bHideTrue to hide buttons.

◆ OnNotification()

void CGUIScrollBar::OnNotification ( const CGUIValue kObservedValue,
const CGUIObject *const  pkUpdatedObject,
const eC_UInt  uiX = 0,
const eC_UInt  uiY = 0 
)
virtual

Will be called if the value of the slider object changes.

Parameters
kObservedValueNew slider value.
pkUpdatedObjectPointer to the slider object which changed.
uiXX-Index Additional X-Index in case the updated value is part of a multidimensional array
uiYY-Index Additional Y-Index in case the updated value is part of a multidimensional array

Reimplemented from CGUIObserver.

◆ ReadFromStream()

void CGUIScrollBar::ReadFromStream ( )
virtual

Reads composite object attributes and children from stream. Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also
CGUIObject::ReadFromStream()
Exceptions
CGUIStreamingControlExceptionWhen catching a CGUIStreamingControlException from a child, this method adds the object from the exception, resets the object pointer to 'this', then re-throws.

Reimplemented from CGUICompositeObject.

◆ RecalculateScrollingRange()

void CGUIScrollBar::RecalculateScrollingRange ( const eC_Value  vCLipperSize)

Calling this method causes the scrollbar to recalculate its scrolling range with regard to the position/size of the scrolled object in relation to the object against which it is clipped, You should usually call this method after the clipper or scrolled object's size has changed.

Parameters
vCLipperSizeSize of the clipper object in scrolling direction.

◆ RemoveObject()

void CGUIScrollBar::RemoveObject ( CGUIObject pObject)
virtual

Calls base implementation and makes sure that if any of the specific children is removed, its pointer is set to NULL.

Parameters
pObjectChild object that is removed.

Reimplemented from CGUICompositeObject.

◆ SetScrolledObject()

void CGUIScrollBar::SetScrolledObject ( CGUIObject pObject)

Sets the object which is going to be scrolled using this ScrollBar.

Parameters
pObjectPointer to object to scroll

◆ SetScrollInterval()

void CGUIScrollBar::SetScrollInterval ( const eC_UInt &  ruiScrollInterval)

Sets scroll interval for auto scroll. This is the interval in milliseconds after which the scrollbar changes its value, while the user keeps pressing one of the scrollbar's button.

Parameters
ruiScrollIntervalInterval in ms.

◆ SetScrollSpeed()

void CGUIScrollBar::SetScrollSpeed ( const eC_UInt &  ruiScrollSpeed) const

Sets number of pixels to scroll per step.

Parameters
ruiScrollSpeedNumber of pixels to scroll per step.

◆ SetValue()

eC_Bool CGUIScrollBar::SetValue ( const CGUIValue rkValue)
virtual

Sets the value on the scrollbar's slider, thus scrolling to the respective position.

Parameters
rkValueThe new value
Returns
Always True.

Reimplemented from CGUIObject.

◆ WriteToStream()

void CGUIScrollBar::WriteToStream ( const eC_Bool  bWriteClassID = false)
virtual

Writes all object attributes to the streaming file. StreamWriter has to be initialized. Only for use with GUIStreamWriter.

Parameters
bWriteClassIDThis flag is used to select if writing of ControlID, leading and trailing tags is performed. Only GUIStreamWriter and GUICompositeObject have to set this flag true.
See also
CGUIStreamWriter

Reimplemented from CGUICompositeObject.


The documentation for this class was generated from the following files: