This control can be used to display an analog clock. More...

#include <GUIClock.h>

Inheritance diagram for CGUIClock:

[legend]

Public Member Functions
	CGUIClock ()

	CGUIClock (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_UByte &ubHours, const eC_UByte &ubMinutes, const eC_UByte &ubSeconds, const eC_UInt &uiHourHandleColor, const eC_UInt &uiMinuteHandleColor, const eC_UInt &uiSecondHandleColor, const eC_Value &vHourNeedleLength, const eC_Value &vMinuteNeedleLength, const eC_Value &vSecondNeedleLength, const eC_Value &vHourNeedleWidth, const eC_Value &vMinuteNeedleWidth, const eC_Value &vSecondNeedleWidth, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIClock (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_UByte &ubHours, const eC_UByte &ubMinutes, const eC_UByte &ubSeconds, const eC_UInt &uiHourHandleColor, const eC_UInt &uiMinuteHandleColor, const eC_UInt &uiSecondHandleColor, const eC_Value &vHourNeedleLength, const eC_Value &vMinuteNeedleLength, const eC_Value &vSecondNeedleLength, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIClock (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_UByte &ubHours, const eC_UByte &ubMinutes, const eC_UByte &ubSeconds, const eC_UInt &uiHourHandleColor, const eC_UInt &uiMinuteHandleColor, const eC_UInt &uiSecondHandleColor, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIClock (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_UByte &ubHours, const eC_UByte &ubMinutes, const eC_UByte &ubSeconds, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIClock (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	~CGUIClock ()
	Destructor.

virtual void	DoAnimate (const eC_Value &vTimes)

virtual eC_Bool	DoDraw ()

eC_Bool	GetAutoStart () const

eC_UByte	GetHour () const

eC_UInt	GetHourNeedleColor () const

eC_Value	GetHourNeedleLength () const

eC_Value	GetHourNeedleWidth () const

void	GetImages (ImageResource_t &eImageBG, ImageResource_t &eImageHour, ImageResource_t &eImageMinute, ImageResource_t &eImageSecond) const

eC_UByte	GetMinute () const

eC_UInt	GetMinuteNeedleColor () const

eC_Value	GetMinuteNeedleLength () const

eC_Value	GetMinuteNeedleWidth () const

eC_UByte	GetSecond () const

eC_UInt	GetSecondNeedleColor () const

eC_Value	GetSecondNeedleLength () const

eC_Value	GetSecondNeedleWidth () const

eC_UInt	GetShadowColor () const

void	GetTime (eC_UByte &ubHours, eC_UByte &ubMinutes, eC_UByte &ubSeconds) const

eC_UInt	GetTimeInSeconds () const

virtual eC_Bool	IsHighlightable () const

virtual void	ReadFromStream ()

void	SetAutoStart (const eC_Bool &bAutoStart)

void	SetHour (const eC_UByte &uiHour)

void	SetHourNeedleColor (const eC_UInt &uiNeedleColor)

void	SetHourNeedleColor (const GlobalProperty_t &eNeedleColor)

void	SetHourNeedleLength (const eC_Value &vNeedleLength)

void	SetHourNeedleWidth (const eC_Value &vNeedleWidth)

void	SetImages (const ImageResource_t &eImageBG, const ImageResource_t &eImageHour, const ImageResource_t &eImageMinute, const ImageResource_t &eImageSecond)

void	SetMinute (const eC_UByte &uiMinute)

void	SetMinuteNeedleColor (const eC_UInt &uiNeedleColor)

void	SetMinuteNeedleColor (const GlobalProperty_t &eNeedleColor)

void	SetMinuteNeedleLength (const eC_Value &vNeedleLength)

void	SetMinuteNeedleWidth (const eC_Value &vNeedleWidth)

void	SetSecond (const eC_UByte &uiSecond)

void	SetSecondNeedleColor (const eC_UInt &uiNeedleColor)

void	SetSecondNeedleColor (const GlobalProperty_t &eNeedleColor)

void	SetSecondNeedleLength (const eC_Value &vNeedleLength)

void	SetSecondNeedleWidth (const eC_Value &vNeedleWidth)

void	SetShadowColor (const eC_UInt &uiShadowColor)

void	SetShadowColor (const GlobalProperty_t &eShadowColor)

void	SetStandardImages ()

void	SetTime (const eC_UByte &ubHours, const eC_UByte &ubMinutes, const eC_UByte &ubSeconds)

void	SetTimeInSeconds (const eC_UInt &uiTimeInSeconds)

virtual eC_Bool	SetValue (const CGUIValue &rkValue)

eC_Bool	ShowSecondHandle () const

void	ShowSecondHandle (const eC_Bool &bShowSecondHandle)

eC_Bool	ShowShadows () const

void	ShowShadows (const eC_Bool &bShowShadow)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

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	DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

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

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

Public Member Functions inherited from CGUIColorPropertyObserver
	CGUIColorPropertyObserver ()
	default-constructor

	~CGUIColorPropertyObserver ()
	destructor

eC_UInt	AddColorProperty (const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)

void	AddColorProperty (const eC_UInt &uiIndex, const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)

ColorValue_t	GetColorProperty (const eC_UInt &uiIndex) const

eC_UInt	GetColorValue (const eC_UInt &uiIndex) const

virtual void	OnColorPropertyChange ()

virtual void	OnNotification ()
	Called by CGUISubject whenever an observed object triggers an update. More...

void	RemoveColorProperty (const eC_UInt &uiIndex)

void	SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)

void	SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)

void	SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)

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

virtual void	OnNotification (const CGUIObject *const pkUpdatedObject)

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

virtual void	OnNotification (const eC_String &kMessage)

void	SetAutoDelete (const eC_Bool bAutoDelete)

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 []

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

Protected Member Functions inherited from CGUIObserver
virtual void	AddSubject (CGUISubject *pSubjectToAdd)

virtual void	RemoveSubject (CGUISubject *pSubjectToRemove)

Detailed Description

This control can be used to display an analog clock.

Constructor & Destructor Documentation

◆ CGUIClock() [1/6]

CGUIClock::CGUIClock	(	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 Please use the SetImages method to set the correct images.

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the geometry object
vHeight	Height of the geometry object
eID	Object-ID

◆ CGUIClock() [2/6]

CGUIClock::CGUIClock	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_UByte &	ubHours,
		const eC_UByte &	ubMinutes,
		const eC_UByte &	ubSeconds,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

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

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the geometry object
vHeight	Height of the geometry object
ubHours	hours of the clock
ubMinutes	minutes of the clock
ubSeconds	seconds of the clock
eID	Object-ID

◆ CGUIClock() [3/6]

CGUIClock::CGUIClock	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_UByte &	ubHours,
		const eC_UByte &	ubMinutes,
		const eC_UByte &	ubSeconds,
		const eC_UInt &	uiHourHandleColor,
		const eC_UInt &	uiMinuteHandleColor,
		const eC_UInt &	uiSecondHandleColor,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

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

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the geometry object
vHeight	Height of the geometry object
ubHours	hours of the clock
ubMinutes	minutes of the clock
ubSeconds	seconds of the clock
uiHourHandleColor	hour handle color
uiMinuteHandleColor	minute handle color
uiSecondHandleColor	second handle color
eID	Object-ID

◆ CGUIClock() [4/6]

CGUIClock::CGUIClock	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_UByte &	ubHours,
		const eC_UByte &	ubMinutes,
		const eC_UByte &	ubSeconds,
		const eC_UInt &	uiHourHandleColor,
		const eC_UInt &	uiMinuteHandleColor,
		const eC_UInt &	uiSecondHandleColor,
		const eC_Value &	vHourNeedleLength,
		const eC_Value &	vMinuteNeedleLength,
		const eC_Value &	vSecondNeedleLength,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

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

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the geometry object
vHeight	Height of the geometry object
ubHours	hours of the clock
ubMinutes	minutes of the clock
ubSeconds	seconds of the clock
uiHourHandleColor	hour handle color
uiMinuteHandleColor	minute handle color
uiSecondHandleColor	second handle color
vHourNeedleLength	hour handle length
vMinuteNeedleLength	minute handle length
vSecondNeedleLength	second handle length
eID	Object-ID

◆ CGUIClock() [5/6]

CGUIClock::CGUIClock	(	CGUICompositeObject *const	pkParent,
		const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const eC_UByte &	ubHours,
		const eC_UByte &	ubMinutes,
		const eC_UByte &	ubSeconds,
		const eC_UInt &	uiHourHandleColor,
		const eC_UInt &	uiMinuteHandleColor,
		const eC_UInt &	uiSecondHandleColor,
		const eC_Value &	vHourNeedleLength,
		const eC_Value &	vMinuteNeedleLength,
		const eC_Value &	vSecondNeedleLength,
		const eC_Value &	vHourNeedleWidth,
		const eC_Value &	vMinuteNeedleWidth,
		const eC_Value &	vSecondNeedleWidth,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

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

Parameters

pkParent	Pointer to the designated parent object
vX	X-position relative to its parent object
vY	Y-position relative to its parent object
vWidth	Width of the geometry object
vHeight	Height of the geometry object
ubHours	hours of the clock
ubMinutes	minutes of the clock
ubSeconds	seconds of the clock
uiHourHandleColor	hour handle color
uiMinuteHandleColor	minute handle color
uiSecondHandleColor	second handle color
vHourNeedleLength	hour handle length
vMinuteNeedleLength	minute handle length
vSecondNeedleLength	second handle length
vHourNeedleWidth	hour handle width
vMinuteNeedleWidth	minute handle width
vSecondNeedleWidth	second handle width
eID	Object-ID

◆ CGUIClock() [6/6]

CGUIClock::CGUIClock ( )

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: CGUIClock()

Member Function Documentation

◆ DoAnimate()

virtual void CGUIClock::DoAnimate ( const eC_Value & vTimes )

virtual

Called when the timer of an animation callback belonging to this animatable has expired.

Parameters

vTimes The factor of the registered callback time in relation to the actually elapsed time. For example, the elapsed time is 80ms, and the standard time is 50ms, then vTimes is 1.6. If the given time in GETTIMER.AddAnimationCallback is 0, It will be set to -1.

Reimplemented from CGUIAnimatable.

◆ DoDraw()

virtual eC_Bool CGUIClock::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 CGUIObject.

◆ GetAutoStart()

eC_Bool CGUIClock::GetAutoStart ( ) const

Return the autostart-state

Returns: True if autostart is active

◆ GetHour()

eC_UByte CGUIClock::GetHour ( ) const

GetHours This method gets the hours

Returns: hours

◆ GetHourNeedleColor()

eC_UInt CGUIClock::GetHourNeedleColor ( ) const

Get Color for hour-needle

Returns: color

◆ GetHourNeedleLength()

eC_Value CGUIClock::GetHourNeedleLength ( ) const

get length of hour-needle

Returns: the length of the needle

◆ GetHourNeedleWidth()

eC_Value CGUIClock::GetHourNeedleWidth ( ) const

This method gets the width of the hour handle

Returns: the width of the needle

◆ GetImages()

void CGUIClock::GetImages	(	ImageResource_t &	eImageBG,
		ImageResource_t &	eImageHour,
		ImageResource_t &	eImageMinute,
		ImageResource_t &	eImageSecond
	)		const

GetImages

Parameters

eImageBG	Image-ID of background image
eImageHour	Image-ID for hour-handle
eImageMinute	Image-ID for minute-handle
eImageSecond	Image-ID for second-handle

◆ GetMinute()

eC_UByte CGUIClock::GetMinute ( ) const

GetMinutes This method gets the minutes

Returns: minutes

◆ GetMinuteNeedleColor()

eC_UInt CGUIClock::GetMinuteNeedleColor ( ) const

Get Color for hour-needle

Returns: color

◆ GetMinuteNeedleLength()

eC_Value CGUIClock::GetMinuteNeedleLength ( ) const

get length of minute-needle

Returns: the length of the needle

◆ GetMinuteNeedleWidth()

eC_Value CGUIClock::GetMinuteNeedleWidth ( ) const

This method gets the width of the minute handle

Returns: the width of the needle

◆ GetSecond()

eC_UByte CGUIClock::GetSecond ( ) const

GetSeconds This method gets the seconds

Returns: m_ubSecond for seconds

◆ GetSecondNeedleColor()

eC_UInt CGUIClock::GetSecondNeedleColor ( ) const

Get Color for hour-needle

Returns: color

◆ GetSecondNeedleLength()

eC_Value CGUIClock::GetSecondNeedleLength ( ) const

get length of second-needle

Returns: the length of the needle

◆ GetSecondNeedleWidth()

eC_Value CGUIClock::GetSecondNeedleWidth ( ) const

This method gets the width of the second handle

Returns: the width of the needle

◆ GetShadowColor()

eC_UInt CGUIClock::GetShadowColor ( ) const

This method gets the color of the shadows (in case they are turned on)

Returns: the color of the shadow as a property

◆ GetTime()

void CGUIClock::GetTime	(	eC_UByte &	ubHours,
		eC_UByte &	ubMinutes,
		eC_UByte &	ubSeconds
	)		const

GetTime This method returns the time of the clock

Parameters

ubHours
ubMinutes
ubSeconds

◆ GetTimeInSeconds()

eC_UInt CGUIClock::GetTimeInSeconds ( ) const

Get time in seconds

Returns: time in seconds till midnight

◆ IsHighlightable()

virtual eC_Bool CGUIClock::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.

◆ ReadFromStream()

virtual void CGUIClock::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 CGUIObject.

◆ SetAutoStart()

void CGUIClock::SetAutoStart ( const eC_Bool & bAutoStart )

Set autostart

Parameters

bAutoStart set to true if autostart

◆ SetHour()

void CGUIClock::SetHour ( const eC_UByte & uiHour )

setHours This method sets the hours

Parameters

uiHour for hours

◆ SetHourNeedleColor() [1/2]

void CGUIClock::SetHourNeedleColor ( const eC_UInt & uiNeedleColor )

SetHourNeedleColor This method sets the color of the hour handle

Parameters

uiNeedleColor HEX color example - 0xFFFF0000 for red

◆ SetHourNeedleColor() [2/2]

void CGUIClock::SetHourNeedleColor ( const GlobalProperty_t & eNeedleColor )

SetHourNeedleColor This method sets the color of the hour handle

Parameters

eNeedleColor

◆ SetHourNeedleLength()

void CGUIClock::SetHourNeedleLength ( const eC_Value & vNeedleLength )

This method sets the length of the hour handle

Parameters

vNeedleLength the length of the needle

◆ SetHourNeedleWidth()

void CGUIClock::SetHourNeedleWidth ( const eC_Value & vNeedleWidth )

This method sets the width of the hour handle

Parameters

vNeedleWidth the width of the needle

◆ SetImages()

void CGUIClock::SetImages	(	const ImageResource_t &	eImageBG,
		const ImageResource_t &	eImageHour,
		const ImageResource_t &	eImageMinute,
		const ImageResource_t &	eImageSecond
	)

SetImages Method to change the images used for the chart background. If the chart 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 chart is to be displayed bigger than the original image.

Parameters

eImageBG	Image-ID of background image
eImageHour	Image-ID for hour-handle
eImageMinute	Image-ID for minute-handle
eImageSecond	Image-ID for second-handle

◆ SetMinute()

void CGUIClock::SetMinute ( const eC_UByte & uiMinute )

SetMinutes This method sets the minutes

Parameters

uiMinute for minutes

◆ SetMinuteNeedleColor() [1/2]

void CGUIClock::SetMinuteNeedleColor ( const eC_UInt & uiNeedleColor )

SetMinuteNeedleColor This method sets the color of the minute handle

Parameters

uiNeedleColor HEX color example - 0xFFFF0000 for red

◆ SetMinuteNeedleColor() [2/2]

void CGUIClock::SetMinuteNeedleColor ( const GlobalProperty_t & eNeedleColor )

SetMinuteNeedleColor This method sets the color of the minute handle

Parameters

eNeedleColor

◆ SetMinuteNeedleLength()

void CGUIClock::SetMinuteNeedleLength ( const eC_Value & vNeedleLength )

This method sets the length of the minute handle

Parameters

vNeedleLength the length of the needle

◆ SetMinuteNeedleWidth()

void CGUIClock::SetMinuteNeedleWidth ( const eC_Value & vNeedleWidth )

This method sets the width of the minute handle

Parameters

vNeedleWidth the width of the needle

◆ SetSecond()

void CGUIClock::SetSecond ( const eC_UByte & uiSecond )

SetSeconds This method sets the seconds

Parameters

uiSecond for seconds

◆ SetSecondNeedleColor() [1/2]

void CGUIClock::SetSecondNeedleColor ( const eC_UInt & uiNeedleColor )

SetSecondNeedleColor This method sets the color of the second handle

Parameters

uiNeedleColor HEX color example - 0xFFFF0000 for red

◆ SetSecondNeedleColor() [2/2]

void CGUIClock::SetSecondNeedleColor ( const GlobalProperty_t & eNeedleColor )

SetSecondNeedleColor This method sets the color of the second handle

Parameters

eNeedleColor

◆ SetSecondNeedleLength()

void CGUIClock::SetSecondNeedleLength ( const eC_Value & vNeedleLength )

SetSecondNeedlelength This method sets the length of the second handle

Parameters

vNeedleLength the length of the needle

◆ SetSecondNeedleWidth()

void CGUIClock::SetSecondNeedleWidth ( const eC_Value & vNeedleWidth )

This method sets the width of the second handle

Parameters

vNeedleWidth the width of the needle

◆ SetShadowColor() [1/2]

void CGUIClock::SetShadowColor ( const eC_UInt & uiShadowColor )

This method sets the color of the shadows (in case they are turned on)

Parameters

uiShadowColor the color of the shadow in HEX example - 0xFF000000 for black (which is default)

◆ SetShadowColor() [2/2]

void CGUIClock::SetShadowColor ( const GlobalProperty_t & eShadowColor )

This method sets the color of the shadows (in case they are turned on)

Parameters

eShadowColor the color of the shadow as a property

◆ SetStandardImages()

void CGUIClock::SetStandardImages ( )

SetStandardImages Sets standard images.

◆ SetTime()

void CGUIClock::SetTime	(	const eC_UByte &	ubHours,
		const eC_UByte &	ubMinutes,
		const eC_UByte &	ubSeconds
	)

SetTime This method sets the time of the clock

Parameters

ubHours	for hours
ubMinutes	for minutes
ubSeconds	for seconds

◆ SetTimeInSeconds()

void CGUIClock::SetTimeInSeconds ( const eC_UInt & uiTimeInSeconds )

Set time in seconds

Parameters

uiTimeInSeconds number of seconds till midnight

◆ SetValue()

virtual eC_Bool CGUIClock::SetValue ( const CGUIValue & rkValue )

virtual

Sets Clock Value. Converts rkValue to hours minutes and seconds

Parameters

rkValue altrought the input parameter can be eC_Value(float) it is later converted to the uint.

Returns: boolean

Reimplemented from CGUIObject.

◆ ShowSecondHandle() [1/2]

eC_Bool CGUIClock::ShowSecondHandle ( ) const

Return if the second-handle is shown

Returns: true if second-handle is shown

◆ ShowSecondHandle() [2/2]

void CGUIClock::ShowSecondHandle ( const eC_Bool & bShowSecondHandle )

This method turns the second handle on and off

Parameters

bShowSecondHandle True if second-handle should be displayed

◆ ShowShadows() [1/2]

eC_Bool CGUIClock::ShowShadows ( ) const

Return if shadows are shown

Returns: true if shadows are shown

◆ ShowShadows() [2/2]

void CGUIClock::ShowShadows ( const eC_Bool & bShowShadow )

ToggleShadows This method turns the shadows of the clock handles on and off

Parameters

bShowShadow True to show shadows

◆ WriteToStream()

virtual void CGUIClock::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

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

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

GUIClock.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUIClock() [1/6]

◆ CGUIClock() [2/6]

◆ CGUIClock() [3/6]

◆ CGUIClock() [4/6]

◆ CGUIClock() [5/6]

◆ CGUIClock() [6/6]

Member Function Documentation

◆ DoAnimate()

◆ DoDraw()

◆ GetAutoStart()

◆ GetHour()

◆ GetHourNeedleColor()

◆ GetHourNeedleLength()

◆ GetHourNeedleWidth()

◆ GetImages()

◆ GetMinute()

◆ GetMinuteNeedleColor()

◆ GetMinuteNeedleLength()

◆ GetMinuteNeedleWidth()

◆ GetSecond()

◆ GetSecondNeedleColor()

◆ GetSecondNeedleLength()

◆ GetSecondNeedleWidth()

◆ GetShadowColor()

◆ GetTime()

◆ GetTimeInSeconds()

◆ IsHighlightable()

◆ ReadFromStream()

◆ SetAutoStart()

◆ SetHour()

◆ SetHourNeedleColor() [1/2]

◆ SetHourNeedleColor() [2/2]

◆ SetHourNeedleLength()

◆ SetHourNeedleWidth()

◆ SetImages()

◆ SetMinute()

◆ SetMinuteNeedleColor() [1/2]

◆ SetMinuteNeedleColor() [2/2]

◆ SetMinuteNeedleLength()

◆ SetMinuteNeedleWidth()

◆ SetSecond()

◆ SetSecondNeedleColor() [1/2]

◆ SetSecondNeedleColor() [2/2]

◆ SetSecondNeedleLength()

◆ SetSecondNeedleWidth()

◆ SetShadowColor() [1/2]

◆ SetShadowColor() [2/2]

◆ SetStandardImages()

◆ SetTime()

◆ SetTimeInSeconds()

◆ SetValue()

◆ ShowSecondHandle() [1/2]

◆ ShowSecondHandle() [2/2]

◆ ShowShadows() [1/2]

◆ ShowShadows() [2/2]

◆ WriteToStream()