Guiliani  Version 2.6 revision 7293 (documentation build 12)
Public Member Functions | Protected Attributes | List of all members
CGUISlider Class Reference
Controls

Slider specialization that uses images for graphical representation. More...

#include <GUISlider.h>

Inheritance diagram for CGUISlider:
Inheritance graph
[legend]

Public Member Functions

 CGUISlider ()
 
 CGUISlider (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_Int &iValue, const eC_Int &iMin, const eC_Int &iMax, const eC_UInt &uiStepSize, const CGUIRange::Base_t &eBase=CGUIRange::BASE_AT_MINIMUM, const CGUICommonEnums::Orientation_t &eStyle=CGUICommonEnums::OR_HORIZONTAL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUISlider (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Int &iValue, const eC_Int &iMin, const eC_Int &iMax, const eC_UInt &uiStepSize, const CGUIRange::Base_t &eBase=CGUIRange::BASE_AT_MINIMUM, const CGUICommonEnums::Orientation_t &eStyle=CGUICommonEnums::OR_HORIZONTAL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUISlider (const CGUISlider &kSource)
 
virtual ~CGUISlider ()
 Destructor.
 
void AdjustBackgroundMarginToMiddleOfKnob ()
 
eC_Bool DoDraw ()
 
CGUINinePatch & GetNinePatch ()
 
CGUISlider & operator= (const CGUISlider &kSource)
 
virtual void ReadFromStream ()
 
void SetBackgroundMargin (const eC_Value &vBkgndMargin)
 
void SetImages (const ImageResource_t &eSldBG, const ImageResource_t &eSldKnobNormal, const ImageResource_t &eSldKnobHighlighted, const ImageResource_t &eSldKnobPressed, const ImageResource_t &eSldKnobGrayedOut=DUMMY_IMAGE)
 
void SetStretchImages (const eC_Bool &bStretchImages)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBaseSlider
 CGUIBaseSlider ()
 
 CGUIBaseSlider (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const eC_Int &iValue, const eC_Int &iMin, const eC_Int &iMax, const eC_UInt &uiStepSize, const CGUIRange::Base_t &eBase=CGUIRange::BASE_AT_MINIMUM, const CGUICommonEnums::Orientation_t &eStyle=CGUICommonEnums::OR_HORIZONTAL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseSlider (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Int &iValue, const eC_Int &iMin, const eC_Int &iMax, const eC_UInt &uiStepSize, const CGUIRange::Base_t &eBase=CGUIRange::BASE_AT_MINIMUM, const CGUICommonEnums::Orientation_t &eStyle=CGUICommonEnums::OR_HORIZONTAL, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIBaseSlider (const CGUIBaseSlider &kSource)
 
virtual ~CGUIBaseSlider ()
 
virtual CGUIRect CalculateKnobRect ()
 
virtual eC_Bool DoButtonDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoClick (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoDrag (const eC_Value &vDeltaX, const eC_Value &vDeltaY, const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoDragEnd (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual eC_Bool DoDraw ()
 
eC_Value GetKnobSizeHorizontal () const
 
eC_Value GetKnobSizeVertical () const
 
CGUICommonEnums::Orientation_t GetOrientation () const
 
eC_UInt GetScrollDistance () const
 
SliderMode_t GetSliderMode () const
 
eC_Value GetSliderTrackLength () const
 
CGUIBaseSlider & operator= (const CGUIBaseSlider &kSource)
 
virtual void ReadFromStream ()
 
virtual void SetHeight (const eC_Value &vY)
 
void SetKnobSize (const eC_Value &vKnobSize)
 
void SetKnobSizeHorizontal (const eC_Value &vKnobSize)
 
void SetKnobSizeVertical (const eC_Value &vKnobSize)
 
void SetMinimumKnobSize (const eC_Value vMinimumKnobSize)
 
void SetScrollDistance (const eC_UInt &uiDistance)
 
void SetSliderMaxPos (const eC_Value vSliderMaxPos)
 
void SetSliderMinPos (const eC_Value vSliderMinPos)
 
void SetSliderMode (const SliderMode_t &eMode)
 
void SetSliderTrackDistance (const eC_Value vPixel)
 
virtual void SetWidth (const eC_Value &vX)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIAbstractBar
void AnimateToValue (const eC_Int iTargetValue)
 
eC_Bool Decrease ()
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
eC_UInt GetAnimationInterval () const
 
eC_UInt GetAnimationSpeed () const
 
const CGUIRange & GetRange () const
 
eC_Bool Increase ()
 
virtual eC_Bool OnValueChange ()
 
void SetAnimationInterval (const eC_UInt &ruiAnimationInterval)
 
void SetAnimationSpeed (const eC_UInt &ruiAnimationSpeed)
 
void SetBase (CGUIRange::Base_t eBase)
 
void SetLevel (eC_Value vPercent)
 
void SetLevelPercentage (eC_UInt uiPercentage)
 
void SetMaximumLevelIsAlwaysValid (eC_Bool bNotOnlyMultiplesOfStepSize)
 
void SetMaxValue (eC_Int iMaxValue)
 
void SetMinValue (eC_Int iMinValue)
 
void SetRange (eC_Int iMinValue, eC_Int iMaxValue)
 
void SetStepSize (eC_UInt uiIntValues)
 
void SetStepSizeLevel (eC_Value vPercent)
 
void SetStepSizeLevelPercentage (eC_UInt uiPercentage)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
- Public Member Functions inherited from CGUIObject
 CGUIObject ()
 
 CGUIObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIObject (const CGUIObject &kSource)
 
virtual ~CGUIObject ()
 
void AddValueObserver (CGUIObserver *pkObserver)
 
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 ()
 
virtual CGUIObject * FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
virtual 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)
 
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
 
CGUIBehaviourDecorator * GetBehaviour ()
 
const CGUIBehaviourDecorator * GetBehaviour () const
 
GUIBitmapPlaneID_t GetBitmapID () const
 
CGUIBitmapPlane & GetBitmapPlane () 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
 
CDataPoolConnector & GetDataPoolConnector ()
 
eC_Value GetDistanceBottom () const
 
eC_Value GetDistanceRight () const
 
eC_Value GetHalfHeight () const
 
eC_Value GetHalfWidth () const
 
eC_Value GetHeight () const
 
ObjectHandle_t GetID () const
 
CGUILayouter * GetLayouter ()
 
const CGUILayouter * GetLayouter () const
 
ObjectHandle_t GetNeighborBottomID () const
 
ObjectHandle_t GetNeighborLeftID () const
 
ObjectHandle_t GetNeighborRightID () const
 
ObjectHandle_t GetNeighborTopID () const
 
CGUIObject * GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)
 
const CGUIObject * GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const
 
CGUIRect GetOriginRect () const
 
CGUICompositeObject * GetParent ()
 
const CGUICompositeObject * GetParent () 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
 
UUID_t GetUUID () const
 
eC_Value GetWidth () const
 
void InvalidateArea ()
 
eC_Bool IsClickable () const
 
eC_Bool IsClickThrough () const
 
virtual eC_Bool IsCompositeObject () 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)
 
CGUIObject & operator= (const CGUIObject &kSource)
 
virtual void ReadFromStream ()
 
virtual void RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const
 
void RemoveValueObserver (CGUIObserver *pkObserver)
 
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 *pkBehaviour)
 
void SetClickThrough (const eC_Bool &bClickThrough)
 
virtual void SetDisabled (const eC_Bool &bDisabled)
 
virtual void SetFocussable (const eC_Bool &bFocussable)
 
virtual void SetGrayedOut (const eC_Bool &bGrayOut)
 
virtual void SetHeight (const eC_Value &vY)
 
void SetID (const ObjectHandle_t &eID)
 
virtual void SetInvisible (const eC_Bool &bInvisible)
 
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 pkParent)
 
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)
 
void SetUUID (const UUID_t &kUUID)
 
virtual eC_Bool SetValue (CDataPoolEntry &rkValue)
 
virtual eC_Bool SetValue (const CGUIValue &rkValue)
 
virtual void SetWidth (const eC_Value &vX)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool DoScale (const eC_Value &vDelta)
 
virtual eC_Bool DoUserEvent (CGUIEvent *const pEvent)
 
virtual void OnCreate ()
 
virtual void OnDataPool (const DataPoolResource_t &eID)
 
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 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 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 DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive)
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
virtual void ReadFromStream ()
 
void SetXMLTag (const eC_String &kXMLTag)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIAnimatable
virtual ~CGUIAnimatable ()
 Destructor. Removes all existing animation callbacks.
 
virtual void DoAnimate (const eC_Value &vTimes=eC_FromInt(1))
 
virtual eC_Bool IsAnimating () const
 
virtual void StartAnimation ()
 
virtual void StopAnimation ()
 

Protected Attributes

ImageResource_t m_eSldBG
 Slider background.
 
ImageResource_t m_eSldKnobGrayedOut
 SLider knob grayed out.
 
ImageResource_t m_eSldKnobHighlighted
 Slider knob highlighted.
 
ImageResource_t m_eSldKnobNormal
 Slider knob normal state.
 
ImageResource_t m_eSldKnobPressed
 Slider knob pressed.
 
CGUINinePatch m_kNinePatch
 Nine Patch for the slider knob.
 
- Protected Attributes inherited from CGUIBaseSlider
eC_Bool m_bDraggingMode
 Still holding the mouse button while dragging?
 
eC_Bool m_bStartOnKnob
 Click started on knob.
 
SliderMode_t m_eSliderMode
 Define mode of slider operation.
 
CGUICommonEnums::Orientation_t m_eStyle
 
eC_Int m_iScrollDistance
 Specifies scroll distance in scroll mode.
 
CGUIRect m_kKnobAbsRect
 
CGUIPoint m_kRelDraggingPoint
 Relative point that is beeing dragged.
 
eC_Value m_vDiffKnobMouse
 
eC_Value m_vKnobSizeHorizontal
 
eC_Value m_vKnobSizeVertical
 
eC_Value m_vMinimumKnobSize
 Minimum allowed knob size (in direction of slider orientation) in pixels (Defaults to 10)
 
eC_Value m_vSliderTrackDistance
 
eC_Value m_vSliderMaxPos
 
eC_Value m_vSliderMinPos
 
- Protected Attributes inherited from CGUIObject
UUID_t m_kUUID
 UUID of object.
 

Additional Inherited Members

- Public Types inherited from CGUIBaseSlider
enum  SliderMode_t { SM_NONE = 0 , SM_JUMPTOCLICK , SM_SCROLLTOCLICK }
 Defines Behaviour of slider when clicking beneath knob. More...
 
- Public Types inherited from CGUIObject
enum  FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }
 
- Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t GenerateUUID ()
 
- Static Public Attributes inherited from CGUIObject
static const eC_Char XMLTAG_ALPHA []
 XML tag to be used writing alpha-value into a stream.
 
static const eC_Char XMLTAG_CLICKTHROUGH []
 XML tag to be used writing clickthrough-state into a stream.
 
static const eC_Char XMLTAG_CONTROLCLASSID []
 XML tag to be used when writing a control class ID into a stream.
 
static const eC_Char XMLTAG_DISABLED []
 XML tag to be used writing disabled-state into a stream.
 
static const eC_Char XMLTAG_FOCUSSABLE []
 XML tag to be used writing focussable-state into a stream.
 
static const eC_Char XMLTAG_GRAYEDOUT []
 XML tag to be used writing grayedout-state into a stream.
 
static const eC_Char XMLTAG_HEIGHT []
 XML tag to be used writing height into a stream.
 
static const eC_Char XMLTAG_INVISIBLE []
 XML tag to be used writing invisible-state into a stream.
 
static const eC_Char XMLTAG_OBJECTID []
 XML tag to be used writing object id into a stream.
 
static const eC_Char XMLTAG_OVERRIDDENNEIGHBORS []
 XML tag to be used writing overridden neighbors into a stream.
 
static const eC_Char XMLTAG_UUID []
 XML tag to be used when writing a UUID into a stream.
 
static const eC_Char XMLTAG_WIDTH []
 XML tag to be used writing width into a stream.
 
static const eC_Char XMLTAG_XPOS []
 XML tag to be used writing x-position into a stream.
 
static const eC_Char XMLTAG_YPOS []
 XML tag to be used writing y-position into a stream.
 
- Static Public Attributes inherited from CGUIBehaviour
static const eC_Char XMLTAG_BEHAVIOURCLASSID []
 XML tag to be used when writing a behaviour class ID into a stream.
 
static const eC_Char XMLTAG_BEHAVIOURCOUNT []
 XML tag for count.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION []
 
- Protected Member Functions inherited from CGUIBaseSlider
void ClipToPixelBounds (eC_Value &vPos) const
 
void CopyAttributes (const CGUIBaseSlider &kSource)
 
eC_Int GetSliderValue (const eC_Value &vAbsX, const eC_Value &vAbsY) const
 
void Init (const eC_Int &iValue, const eC_Int &iMin, const eC_Int &iMax, const eC_UInt &uiStepSize, const CGUIRange::Base_t &eBase)
 
void SetSliderPos (const eC_Value &vAbsX, const eC_Value &vAbsY)
 
- Protected Member Functions inherited from CGUIAbstractBar
 CGUIAbstractBar ()
 
 CGUIAbstractBar (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIAbstractBar (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)
 
 CGUIAbstractBar (const CGUIAbstractBar &kSource)
 
CGUIAbstractBar & operator= (const CGUIAbstractBar &kSource)
 
virtual void ReadFromStream ()
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Protected Member Functions inherited from CGUIObject
virtual eC_Bool CreateBitmapPlane ()
 
virtual eC_Bool FourWayNext (FourWayFocus_t eFocusDirection)
 
- 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
 

Detailed Description

Slider specialization that uses images for graphical representation.

The "slider" control is used for setting and representing of values as a knob on a bar. It supports horizontal and vertical orientation of the bar. The minimum value is represented by the left most or bottom position of the knob. (Class: CGUISlider). The "slider" supports nine patch images (CGUINinePatch).

The image based slider has a knob that may be dragged inside the slider track (a specific area inside the control) into one direction that is determined by the orientation of the control (horizontal or vertical). The position of the knob determines the associated value of the control or, to be more precise, the value of the associated CGUIRange.

The knob is an image that is drawn centered (relative to the opposite direction of the control). Its size may be determined by the user calling SetKnobSizeHorizontal() and SetKnobSizeVertical()), so that it is automatically stretched if needed. Stretching behaviour can be customized via the knob's CGUINinePatch.

The background is an image which will be stretched into the direction of the slider, and centered in the opposite direction. E.g. a horizontal slider's background will be stretched horizontally.and centered vertically.

Example:

// Create horizontal slider.
CGUISlider* pkSliderHor = new CGUISlider(this,
eC_FromInt(0), eC_FromInt(0),
eC_FromInt(300), eC_FromInt(20),
0, 0, 100, 10,
CGUIRange::BASE_AT_MINIMUM,
CGUIBaseSlider::SLD_HORIZONTAL,
OBJ_HORIZONTALSLIDER);
// Set images of the slider.
// Before calling this method, please add image IDs to UserImageResource.h.
// After that call GETRESMANAGER.RegisterImageResource() to register images for image IDs.
pkSliderHor->SetImages(
IMG_SLD_BG,
IMG_KNOB_NORMAL,
IMG_KNOB_HIGHLIGHTED,
IMG_KNOB_PRESSED);
// Sets the distance of background to the border of the control.
pkSliderHor->SetBackgroundMargin(eC_FromInt(10));
CGUISlider
Slider specialization that uses images for graphical representation.
Definition: GUISlider.h:80
CGUISlider::SetBackgroundMargin
void SetBackgroundMargin(const eC_Value &vBkgndMargin)
Definition: GUISlider.h:184
CGUISlider::SetImages
void SetImages(const ImageResource_t &eSldBG, const ImageResource_t &eSldKnobNormal, const ImageResource_t &eSldKnobHighlighted, const ImageResource_t &eSldKnobPressed, const ImageResource_t &eSldKnobGrayedOut=DUMMY_IMAGE)

Constructor & Destructor Documentation

◆ CGUISlider() [1/4]

CGUISlider::CGUISlider ( CGUICompositeObject *const  pkParent,
const eC_Value &  vX,
const eC_Value &  vY,
const eC_Value &  vWidth,
const eC_Value &  vHeight,
const eC_Int &  iValue,
const eC_Int &  iMin,
const eC_Int &  iMax,
const eC_UInt &  uiStepSize,
const CGUIRange::Base_t &  eBase = CGUIRange::BASE_AT_MINIMUM,
const CGUICommonEnums::Orientation_t &  eStyle = CGUICommonEnums::OR_HORIZONTAL,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructor Please use the SetImages method to set the correct images.

Parameters
pkParentPointer to the designated parent object
vXX-position relative to its parent object
vYY-position relative to its parent object
vWidthWidth of the slider
vHeightHeight of the slider
iValueCurrent value of the slider
iMinMinimum setting of the slider
iMaxMaximum setting of the slider
uiStepSizeThe step size in units of the range
eBaseSteps are based at minimum or maximum.
eStyleOrientation of control
eIDObject identifier of this slider (chose NO_HANDLE if none is required)

◆ CGUISlider() [2/4]

CGUISlider::CGUISlider ( CGUICompositeObject *const  pkParent,
const CGUIRect &  kRect,
const eC_Int &  iValue,
const eC_Int &  iMin,
const eC_Int &  iMax,
const eC_UInt &  uiStepSize,
const CGUIRange::Base_t &  eBase = CGUIRange::BASE_AT_MINIMUM,
const CGUICommonEnums::Orientation_t &  eStyle = CGUICommonEnums::OR_HORIZONTAL,
const ObjectHandle_t &  eID = NO_HANDLE 
)

Constructor Please use the SetImages method to set the correct images.

Parameters
pkParentPointer to the designated parent object
kRectThe boundary rectangle, relative to parent.
iValueCurrent value of the slider
iMinMinimum setting of the slider
iMaxMaximum setting of the slider
uiStepSizeThe step size in units of the range
eBaseSteps are based at minimum or maximum.
eStyleOrientation of control
eIDObject identifier of this slider.

◆ CGUISlider() [3/4]

CGUISlider::CGUISlider ( const CGUISlider &  kSource)

Copy-constructor of the CGUIBaseSlider class.

Parameters
kSourceSource object to be copied.

◆ CGUISlider() [4/4]

CGUISlider::CGUISlider ( )

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
CGUIBaseSlider()

Member Function Documentation

◆ AdjustBackgroundMarginToMiddleOfKnob()

void CGUISlider::AdjustBackgroundMarginToMiddleOfKnob ( )
inline

Shrinks the background image so that its borders lie under the middle of the knob at the knob's extreme positions if the track distance is zero.

◆ DoDraw()

eC_Bool CGUISlider::DoDraw ( )
virtual

Visualizes the object. It is forbidden to call SetRelXPos, SetRelYPos, SetWidth or SetHeight in DoDraw, i.e., it is not allowed to change the layout.

Returns
True if anything was drawn, False otherwise

Reimplemented from CGUIBaseSlider.

◆ GetNinePatch()

CGUINinePatch & CGUISlider::GetNinePatch ( )
inline

Grants access to the object's nine patch.

Returns
Nine patch used to display the object

◆ operator=()

CGUISlider & CGUISlider::operator= ( const CGUISlider &  kSource)

Operator= method of the CGUISlider class.

Parameters
kSourceSource object to be copied.
Returns
Copied object.

◆ ReadFromStream()

virtual void CGUISlider::ReadFromStream ( )
virtual

Reads all object attributes from streaming file. Only for use with GUIFactory. GUIStreamingFileReader has to be set in CGUI::Init().

See also
CGUIFactory

Reimplemented from CGUIBaseSlider.

◆ SetBackgroundMargin()

void CGUISlider::SetBackgroundMargin ( const eC_Value &  vBkgndMargin)
inline

Sets the distance of background to the border of the control. This may be used to align the middle of the knob to the visible ends of the background (in the scrolling direction) without using transparent background graphics and still dragging the knob completely visible all the time (no clipping at the control's borders), for example.

Parameters
vBkgndMargindistance of background to the border of the control in pixel

◆ SetImages()

void CGUISlider::SetImages ( const ImageResource_t &  eSldBG,
const ImageResource_t &  eSldKnobNormal,
const ImageResource_t &  eSldKnobHighlighted,
const ImageResource_t &  eSldKnobPressed,
const ImageResource_t &  eSldKnobGrayedOut = DUMMY_IMAGE 
)

SetImages Method to change the images used for the slider representation. The sizes of the knob images may differ. If the knob size varies from the supplied image's size, the image will automatically split into three portions. These are either a left/middle/right part for horizontal, or a top/middle/bottom part for vertical sliders. The left/top images will be constructed from the left/top half of the original image. Analogue, The right/bottom images will be constructor from the right/bottom half of the original image. The pixel row/column in the middle of the original image will be stretched to fill up the space, if the knob is to be displayed bigger than the original image.

Parameters
eSldBGID of background image
eSldKnobNormalID of image used to represent the normal state of the slider
eSldKnobHighlightedID of image used to represent the highlighted slider
eSldKnobPressedID of image used to represent the pressed slider
eSldKnobGrayedOutID of image used to represent the grayed out slider (compat: set to DUMMY_IMAGE)

◆ SetStretchImages()

void CGUISlider::SetStretchImages ( const eC_Bool &  bStretchImages)

Set if images should be stretched

Parameters
bStretchImages

◆ WriteToStream()

virtual void CGUISlider::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 CGUIBaseSlider.

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