#include <GUISegmentBar.h>

Inheritance diagram for CGUISegmentBar:

[legend]

Public Member Functions
	CGUISegmentBar (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)

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)

eC_Bool	GetAutoStretch () const

eC_Value	GetGap () const

void	GetImages (ImageResource_t &eInactiveImage, ImageResource_t &eActiveImage) const

void	GetMargin (eC_Value &vMarginX, eC_Value &vMarginY) const

CGUINinePatch	GetNinePatch ()

CGUICommonEnums::Orientation_t	GetOrientation () const

void	GetSegmentSize (eC_Value &vSegmentWidth, eC_Value &vSegmentHeight) const

virtual eC_Bool	IsHighlightable () const

eC_Bool	OnValueChange ()

virtual void	ReadFromStream ()

void	SetAutoStretch (const eC_Bool &bAutoStretch)

void	SetGap (const eC_Value &vGap)

virtual void	SetHeight (const eC_Value &vY)

void	SetImages (const ImageResource_t &eInactiveImage, const ImageResource_t &eActiveImage)

void	SetMargin (const eC_Value &vMarginX, const eC_Value &vMarginY)

void	SetOrientation (const CGUICommonEnums::Orientation_t &eOrientation)

void	SetSegmentSize (const eC_Value &vSegmentWidth, const eC_Value &vSegmentHeight)

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

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)

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	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	DoDragEnd (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	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

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 Member Functions
virtual eC_Bool	DoDraw ()

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

Additional Inherited Members
Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }

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_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 Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Detailed Description

This control can be used to display values in the form of a filled bar with distinct segments. The images for inactive and active segments can be set. Additionally the margin and the size of a segment and also the gap between each segment can be set. There is also an auto-stretch-attribute which can be used to resize the bar without changing the size of the segments.

During runtime the value can be adjusted by clicking or dragging on the control. Minimum and maximum-values as well as step-size are inherited from CGUIAbstractBar.

To understand how the control is displayed:

+-----------------------------------+
|                                   |  < vertical margin
|  ooo ooo ooo ooo ooo ooo ooo ooo  |  <\
|  ooo ooo ooo ooo ooo ooo ooo ooo  |  <- segment height
|  ooo ooo ooo ooo ooo ooo ooo ooo  |  </
|                                   |  < vertical margin
+-----------------------------------+
      ^ Gap between segments
   ^^^ segment width
 ^^ horizontal margin
 
if auto-stretch is active the segment-size is calculated by the size of the control minus the (margin * 2)

Constructor & Destructor Documentation

◆ CGUISegmentBar()

CGUISegmentBar::CGUISegmentBar	(	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`
	)

Constructor.

Parameters

pkParent	Pointer to the designated parent object.
vX	X-position relative to its parent object, i.e. the x-offset from the left border of the parent object
vY	Y-position relative to its parent object, i.e. the y-offset from the upper border of the parent object
vWidth	Width of the object
vHeight	Height of the object
eID	Object identifier of this object (choose NO_HANDLE if none is required).

Member Function Documentation

◆ DoButtonDown()

virtual eC_Bool CGUISegmentBar::DoButtonDown	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

virtual

Called when the mouse button or finger is pressed down over an object.

Note: DoButtonDown() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on the object in a newer and probably intermediate state that he currently does not see in this state. Thus, to calculate the relative position (where the object was pressed relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-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 always returns False.

Reimplemented from CGUIBehaviour.

◆ DoClick()

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

virtual

Called when the object receives a click event. A click can e.g., be the result of a mouse click, a finger press/release sequence on touchscreens, or be triggered by a GK_ACTION keyboard event.

Note: DoClick() should work on the absolute positions of this object, that were set at the time of the passed redraw, as the user expects to click on what he sees and not to click on an object in a newer and probably intermediate state that he currently does not see. Thus, to calculate the relative position (where the mouse button was pressed and released at the same position for in a certain time span, relative to the origin of this object) from the vAbsY argument you must do it like this: vMyRelYPos = vAbsY - GetAbsYPos().

Parameters

vAbsX	X-position in screen coordinates where the click occurred
vAbsY	Y-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.

◆ DoDrag()

virtual eC_Bool CGUISegmentBar::DoDrag	(	const eC_Value &	vDeltaX,
		const eC_Value &	vDeltaY,
		const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

virtual

Called when the object receives a Drag event. Drags are typically created if the mouse is being used while a mouse-button is being pressed, or if the user moves his finger over a touchscreen.

Parameters

vDeltaX	relative movement in x-direction since the last call of DoDrag/ButtonDown
vDeltaY	relative movement in y-direction since the last call of DoDrag/ButtonDown
vAbsX	current X-position in screen coordinates of the mouse
vAbsY	current Y-position in screen coordinates of the mouse

Returns: True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoDraw()

virtual eC_Bool CGUISegmentBar::DoDraw ( )

protectedvirtual

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

◆ GetAutoStretch()

eC_Bool CGUISegmentBar::GetAutoStretch ( ) const

Return whether auto-stretch is used.

Returns: true if auto-stretch is used, or false

◆ GetGap()

eC_Value CGUISegmentBar::GetGap ( ) const

Return the gap between each segment.

Returns: gap

◆ GetImages()

void CGUISegmentBar::GetImages	(	ImageResource_t &	eInactiveImage,
		ImageResource_t &	eActiveImage
	)		const

Return the images used for the control

Parameters

eInactiveImage	image-id for inactive segment
eActiveImage	image-id for active segment

◆ GetMargin()

void CGUISegmentBar::GetMargin	(	eC_Value &	vMarginX,
		eC_Value &	vMarginY
	)		const

Return the margin used for the segments.

Parameters

vMarginX	horizontal margin
vMarginY	vertical margin

◆ GetNinePatch()

CGUINinePatch CGUISegmentBar::GetNinePatch ( )

Return the ninepatch which is used for each segment

Returns: nine-patch

◆ GetOrientation()

CGUICommonEnums::Orientation_t CGUISegmentBar::GetOrientation ( ) const

Return the orientation of the bar

Returns: orientation

◆ GetSegmentSize()

void CGUISegmentBar::GetSegmentSize	(	eC_Value &	vSegmentWidth,
		eC_Value &	vSegmentHeight
	)		const

Return the size for a segment.

Parameters

vSegmentWidth	width of the segment
vSegmentHeight	height of the segment

◆ IsHighlightable()

virtual eC_Bool CGUISegmentBar::IsHighlightable ( ) const

inlinevirtual

This method checks if an object is highlightable. This refers to whether it can be highlighted via the event handler. If true the event handler may mark this object as the currently highlighted one. Thus, there is no special flag in CGUIObject that determines if an object is highlightable. The default determination is that the control is in none of the following states:

invisible
grayed-out
disabled if so the return value will be true. NOTE: when an object is not highlightable, it will never receive DoMouseEnter and DoMouseLeave-events
Returns
True if highlightable, False otherwise

Reimplemented from CGUIObject.

◆ OnValueChange()

eC_Bool CGUISegmentBar::OnValueChange ( )

virtual

Virtual method which gets called whenever the value of the corresponding GUIRange changes. This will be done prior to notifying any observers subscribed to this GUIAbstractBar. Derived classes can override this method to implement specific behavior in reaction to a change of the contained value.

In particular, it is possible to override the default invalidation-behavior, which will invalidate the entire object. If a derived class implements an optimized invalidation algorithm, it must return TRUE, indicating to the base-class that it has already taken care of invalidation. If you are not familiar with Guiliani's invalidation mechanisms, return FALSE.

Returns: True if an implementation of a derived class has implemented its own invalidation algorithm, False otherwise

Reimplemented from CGUIAbstractBar.

◆ ReadFromStream()

virtual void CGUISegmentBar::ReadFromStream ( )

virtual

Reads all object attributes from streaming file. This method is called by CGUIFactoryManager after one of the registered factories has created an instance of this class.

Reimplemented from CGUIAbstractBar.

◆ SetAutoStretch()

void CGUISegmentBar::SetAutoStretch ( const eC_Bool & bAutoStretch )

Set if auto-stretch will be used. If auto-stretch is active the images for the segments will be stretched over the whole size of the object minus the margin. otherwise the segment-sizes will be used.

Parameters

bAutoStretch true for auto-stretch

◆ SetGap()

void CGUISegmentBar::SetGap ( const eC_Value & vGap )

Set the gap between each segment.

Parameters

vGap gap

◆ SetHeight()

virtual void CGUISegmentBar::SetHeight ( const eC_Value & vY )

virtual

Sets this object's height to a new value.

Parameters

vY	the new height

Reimplemented from CGUIObject.

◆ SetImages()

void CGUISegmentBar::SetImages	(	const ImageResource_t &	eInactiveImage,
		const ImageResource_t &	eActiveImage
	)

Sets the images used for the control

Parameters

eInactiveImage	image-id for inactive segment
eActiveImage	image-id for active segment

◆ SetMargin()

void CGUISegmentBar::SetMargin	(	const eC_Value &	vMarginX,
		const eC_Value &	vMarginY
	)

Set the margin which is used to display the segments.

Parameters

vMarginX	horizontal margin
vMarginY	vertical margin

◆ SetOrientation()

void CGUISegmentBar::SetOrientation ( const CGUICommonEnums::Orientation_t & eOrientation )

Sets the orientation of the bar

Parameters

eOrientation either horizontal or vertical

◆ SetSegmentSize()

void CGUISegmentBar::SetSegmentSize	(	const eC_Value &	vSegmentWidth,
		const eC_Value &	vSegmentHeight
	)

Set the size for a segment. If auto-stretch is false these sizes are used to display the segments.

Parameters

vSegmentWidth	width of the segment
vSegmentHeight	height of the segment

◆ SetWidth()

virtual void CGUISegmentBar::SetWidth ( const eC_Value & vX )

virtual

Sets this object's width to a new value.

Parameters

vX	the new width

Reimplemented from CGUIObject.

◆ WriteToStream()

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

virtual

Writes all object attributes to the streaming file. A CGUIStreamWriter has to be initialized first.

Parameters

bWriteClassID This flag is used to select if writing of ControlID, leading and trailing tags is performed.

Reimplemented from CGUIAbstractBar.

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

GUISegmentBar.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUISegmentBar()

Member Function Documentation

◆ DoButtonDown()

◆ DoClick()

◆ DoDrag()

◆ DoDraw()

◆ GetAutoStretch()

◆ GetGap()

◆ GetImages()

◆ GetMargin()

◆ GetNinePatch()

◆ GetOrientation()

◆ GetSegmentSize()

◆ IsHighlightable()

◆ OnValueChange()

◆ ReadFromStream()

◆ SetAutoStretch()

◆ SetGap()

◆ SetHeight()

◆ SetImages()

◆ SetMargin()

◆ SetOrientation()

◆ SetSegmentSize()

◆ SetWidth()

◆ WriteToStream()