Calendar-widget for easy access. More...

#include <GUICalendar.h>

Inheritance diagram for CGUICalendar:

[legend]

Public Member Functions
	CGUICalendar ()
	Default constructor to be used by the factory.

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

virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX, const eC_Value &vAbsY)

CGUINinePatch	GetBackgroundNinePatch ()

void	GetDate (eC_UByte &ubDay, eC_UByte &ubMonth, eC_UInt &uiYear)

void	GetDaySize (eC_Value &vDayWidth, eC_Value &vDayHeight) const

eC_String	GetDayText (const eC_UByte &ubIndex) const

eC_Bool	GetFillEmptySpaces () const

eC_UByte	GetFirstDayOfWeek () const

FontResource_t	GetFont () const

eC_UInt	GetFontColor () const

eC_UInt	GetHeadlineColor () const

FontResource_t	GetHeadlineFont () const

eC_Value	GetHeadlineHeight () const

void	GetImages (ImageResource_t &eBackgroundImage, ImageResource_t &eMarkerImage) const

FontResource_t	GetInactiveFont () const

eC_UInt	GetInactiveFontColor () const

CGUINinePatch	GetMarkerNinePatch ()

eC_String	GetMonthText (const eC_UByte &ubIndex) const

eC_Bool	GetShowHeadLine () const

eC_Bool	GetShowWeekDays () const

eC_Bool	GetTouchControl () const

virtual eC_Bool	IsHighlightable () const

void	NextMonth ()

void	NextYear ()

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

void	PreviousMonth ()

void	PreviousYear ()

virtual void	ReadFromStream ()

void	SetDate (const eC_UByte &ubDay, const eC_UByte &ubMonth, const eC_UInt &uiYear)

void	SetDaySize (const eC_Value &vDayWidth, const eC_Value &vDayHeight)

void	SetDayText (const eC_UByte &ubIndex, const eC_String &kTextString)

void	SetDayText (const eC_UByte &ubIndex, const TextResource_t &eTextID)

void	SetFillEmptySpaces (const eC_Bool &bFillEmptySpaces)

void	SetFirstDayOfWeek (const eC_UByte &ubFirstDayOfWeek)

void	SetFont (const FontResource_t &eFont)

void	SetFontColor (const eC_UInt &uiFontColor)

void	SetFontColor (const GlobalProperty_t &eFontColor)

void	SetHeadlineColor (const eC_UInt &uiHeadlineColor)

void	SetHeadlineColor (const GlobalProperty_t &eHeadlineColor)

void	SetHeadlineFont (const FontResource_t &eHeadlineFont)

void	SetHeadlineHeight (const eC_Value &vHeadlineHeight)

virtual void	SetHeight (const eC_Value &vY)

void	SetImages (const ImageResource_t &eBackgroundImage, const ImageResource_t &eMarkerImage)

void	SetInactiveFont (const FontResource_t &eInactiveFont)

void	SetInactiveFontColor (const eC_UInt &uiInactiveFontColor)

void	SetInactiveFontColor (const GlobalProperty_t &eInactiveFontColor)

void	SetMonthText (const eC_UByte &ubIndex, const eC_String &kTextString)

void	SetMonthText (const eC_UByte &ubIndex, const TextResource_t &eTextID)

void	SetShowHeadLine (const eC_Bool &bShowHeadLine)

void	SetShowWeekDays (const eC_Bool &bShowWeekDays)

void	SetTouchControl (const eC_Bool &bTouchControl)

virtual void	SetWidth (const eC_Value &vX)

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

Protected Member Functions
virtual eC_Bool	DoDraw ()

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)

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

Calendar-widget for easy access.

A calendar-widget which can be used to display the current date and select a new one

background-image and marker-image can be chosen
show also last days of previous month and first days of next month
width and height of one entry. if set to 0 they get calculated using the current size
weekday to start with. 0 = sunday, 1 = monday, etc.
font and color of headline
font and color for days of current month
font and color for days outside current month

swipe right for previous year, left for next year swipe down for previous month, up for next month

Constructor & Destructor Documentation

◆ CGUICalendar()

CGUICalendar::CGUICalendar	(	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 CGUICalendar::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 CGUICalendar::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 CGUICalendar::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.

◆ DoDragEnd()

virtual eC_Bool CGUICalendar::DoDragEnd	(	const eC_Value &	vAbsX,
		const eC_Value &	vAbsY
	)

virtual

Called on the dragged object (=the object on which the initial ButtonDown-event occurred) when the mouse button is released after a drag event.

Parameters

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 CGUICalendar::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.

◆ GetBackgroundNinePatch()

CGUINinePatch CGUICalendar::GetBackgroundNinePatch ( )

Get ninepatch of background-image

Returns: ninepatch

◆ GetDate()

void CGUICalendar::GetDate	(	eC_UByte &	ubDay,
		eC_UByte &	ubMonth,
		eC_UInt &	uiYear
	)

Get the current date

Parameters

ubDay	day
ubMonth	month
uiYear	year

◆ GetDaySize()

void CGUICalendar::GetDaySize	(	eC_Value &	vDayWidth,
		eC_Value &	vDayHeight
	)		const

Return size of day

Parameters

vDayWidth	width of day
vDayHeight	height of day

◆ GetDayText()

eC_String CGUICalendar::GetDayText ( const eC_UByte & ubIndex ) const

Return the Text of the specified day

Parameters

ubIndex index of day

Returns: text of day as string

◆ GetFillEmptySpaces()

eC_Bool CGUICalendar::GetFillEmptySpaces ( ) const

Returns if empty spaces are filled

Returns: true if empty spaces are filled

◆ GetFirstDayOfWeek()

eC_UByte CGUICalendar::GetFirstDayOfWeek ( ) const

Returns first day of week

Returns: first day of week (0 = sunday)

◆ GetFont()

FontResource_t CGUICalendar::GetFont ( ) const

Return the currently set font for entries

Returns: entry-font

◆ GetFontColor()

eC_UInt CGUICalendar::GetFontColor ( ) const

Returns the currently set color for the active entry

Returns: currently set color

◆ GetHeadlineColor()

eC_UInt CGUICalendar::GetHeadlineColor ( ) const

Returns the currently set color for the headline

Returns: currently set color

◆ GetHeadlineFont()

FontResource_t CGUICalendar::GetHeadlineFont ( ) const

Return the currently set font for the headline

Returns: headline-font

◆ GetHeadlineHeight()

eC_Value CGUICalendar::GetHeadlineHeight ( ) const

Return the current height of the headline

Returns: height of headline

◆ GetImages()

void CGUICalendar::GetImages	(	ImageResource_t &	eBackgroundImage,
		ImageResource_t &	eMarkerImage
	)		const

Return the images which are used for display

Parameters

eBackgroundImage	background-image
eMarkerImage	marker-image

◆ GetInactiveFont()

FontResource_t CGUICalendar::GetInactiveFont ( ) const

Return the currently set font for inactive entries

Returns: inactive entry-font

◆ GetInactiveFontColor()

eC_UInt CGUICalendar::GetInactiveFontColor ( ) const

Returns the currently set color for inactive fentries

Returns: currently set color

◆ GetMarkerNinePatch()

CGUINinePatch CGUICalendar::GetMarkerNinePatch ( )

Get ninepatch of marker-image

Returns: ninepatch

◆ GetMonthText()

eC_String CGUICalendar::GetMonthText ( const eC_UByte & ubIndex ) const

Return the Text of the specified month

Parameters

ubIndex index of month

Returns: text of month as string

◆ GetShowHeadLine()

eC_Bool CGUICalendar::GetShowHeadLine ( ) const

Return if headline is shown

Returns: true if headline is shown

◆ GetShowWeekDays()

eC_Bool CGUICalendar::GetShowWeekDays ( ) const

Returns if weekdays are shown

Returns: true if weekdays are shown

◆ GetTouchControl()

eC_Bool CGUICalendar::GetTouchControl ( ) const

Return if touch-control is active

Returns: true if touch-control is active

◆ IsHighlightable()

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

◆ NextMonth()

void CGUICalendar::NextMonth ( )

navigate to the next month

◆ NextYear()

void CGUICalendar::NextYear ( )

navigate to the next year

◆ OnNotification()

virtual void CGUICalendar::OnNotification ( )

virtual

Called by CGUISubject whenever an observed object triggers an update.

Reimplemented from CGUIColorPropertyObserver.

◆ PreviousMonth()

void CGUICalendar::PreviousMonth ( )

navigate to the previous month

◆ PreviousYear()

void CGUICalendar::PreviousYear ( )

navigate to the previous year

◆ ReadFromStream()

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

◆ SetDate()

void CGUICalendar::SetDate	(	const eC_UByte &	ubDay,
		const eC_UByte &	ubMonth,
		const eC_UInt &	uiYear
	)

Set the current date

Parameters

ubDay	day
ubMonth	month
uiYear	year

◆ SetDaySize()

void CGUICalendar::SetDaySize	(	const eC_Value &	vDayWidth,
		const eC_Value &	vDayHeight
	)

Set size of day

Parameters

vDayWidth	width of day
vDayHeight	height of day

◆ SetDayText() [1/2]

void CGUICalendar::SetDayText	(	const eC_UByte &	ubIndex,
		const eC_String &	kTextString
	)

Set Text for specified day to text-string

Parameters

ubIndex	index of day
kTextString	text-string to be used for day

◆ SetDayText() [2/2]

void CGUICalendar::SetDayText	(	const eC_UByte &	ubIndex,
		const TextResource_t &	eTextID
	)

Set Text for specified day to text-ID

Parameters

ubIndex	index of day
eTextID	text-id to be used for day

◆ SetFillEmptySpaces()

void CGUICalendar::SetFillEmptySpaces ( const eC_Bool & bFillEmptySpaces )

Set to fill empty spaces with days from previous or next month

Parameters

bFillEmptySpaces fill empty spaces

◆ SetFirstDayOfWeek()

void CGUICalendar::SetFirstDayOfWeek ( const eC_UByte & ubFirstDayOfWeek )

Sets the first day of week

Parameters

ubFirstDayOfWeek first day of week (0 = sunday)

◆ SetFont()

void CGUICalendar::SetFont ( const FontResource_t & eFont )

Set font for an entry

Parameters

eFont Font-ID

◆ SetFontColor() [1/2]

void CGUICalendar::SetFontColor ( const eC_UInt & uiFontColor )

Sets the color of the active entry as a 32 Bit hexadecimal value (0xAARRGGBB).

Parameters

uiFontColor Color of drawing

◆ SetFontColor() [2/2]

void CGUICalendar::SetFontColor ( const GlobalProperty_t & eFontColor )

Sets the color of the active entry as a property

Parameters

eFontColor property to use

◆ SetHeadlineColor() [1/2]

void CGUICalendar::SetHeadlineColor ( const eC_UInt & uiHeadlineColor )

Sets the color of the primitive as a 32 Bit hexadecimal value (0xAARRGGBB).

Parameters

uiHeadlineColor Color of drawing

◆ SetHeadlineColor() [2/2]

void CGUICalendar::SetHeadlineColor ( const GlobalProperty_t & eHeadlineColor )

Sets the color of the primitive as a property

Parameters

eHeadlineColor property to use

◆ SetHeadlineFont()

void CGUICalendar::SetHeadlineFont ( const FontResource_t & eHeadlineFont )

Set font for the headline

Parameters

eHeadlineFont Font-ID

◆ SetHeadlineHeight()

void CGUICalendar::SetHeadlineHeight ( const eC_Value & vHeadlineHeight )

Set the height of the headline

Parameters

vHeadlineHeight

◆ SetHeight()

virtual void CGUICalendar::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 CGUICalendar::SetImages	(	const ImageResource_t &	eBackgroundImage,
		const ImageResource_t &	eMarkerImage
	)

Set the images which are used for display

Parameters

eBackgroundImage	background-image
eMarkerImage	marker-image

◆ SetInactiveFont()

void CGUICalendar::SetInactiveFont ( const FontResource_t & eInactiveFont )

Set font for an inactive entry

Parameters

eInactiveFont Font-ID

◆ SetInactiveFontColor() [1/2]

void CGUICalendar::SetInactiveFontColor ( const eC_UInt & uiInactiveFontColor )

Sets the color of the inactive entries as a 32 Bit hexadecimal value (0xAARRGGBB).

Parameters

uiInactiveFontColor Color of drawing

◆ SetInactiveFontColor() [2/2]

void CGUICalendar::SetInactiveFontColor ( const GlobalProperty_t & eInactiveFontColor )

Sets the color of the inactive entries as a property

Parameters

eInactiveFontColor property to use

◆ SetMonthText() [1/2]

void CGUICalendar::SetMonthText	(	const eC_UByte &	ubIndex,
		const eC_String &	kTextString
	)

Set Text for specified month to text-string

Parameters

ubIndex	index of month
kTextString	text-string to be used for month

◆ SetMonthText() [2/2]

void CGUICalendar::SetMonthText	(	const eC_UByte &	ubIndex,
		const TextResource_t &	eTextID
	)

Set Text for specified month to text-ID

Parameters

ubIndex	index of month
eTextID	text-id to be used for month

◆ SetShowHeadLine()

void CGUICalendar::SetShowHeadLine ( const eC_Bool & bShowHeadLine )

Sets to show the headline or not

Parameters

bShowHeadLine show headline

◆ SetShowWeekDays()

void CGUICalendar::SetShowWeekDays ( const eC_Bool & bShowWeekDays )

Sets to show weekdays or not

Parameters

bShowWeekDays show weekdays

◆ SetTouchControl()

void CGUICalendar::SetTouchControl ( const eC_Bool & bTouchControl )

Sets if touch-control is active this will enable the user to swipe horizontally to change years and vertically to change months

Parameters

bTouchControl if true touch-control is active

◆ SetWidth()

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

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

GUICalendar.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUICalendar()

Member Function Documentation

◆ DoButtonDown()

◆ DoClick()

◆ DoDrag()

◆ DoDragEnd()

◆ DoDraw()

◆ GetBackgroundNinePatch()

◆ GetDate()

◆ GetDaySize()

◆ GetDayText()

◆ GetFillEmptySpaces()

◆ GetFirstDayOfWeek()

◆ GetFont()

◆ GetFontColor()

◆ GetHeadlineColor()

◆ GetHeadlineFont()

◆ GetHeadlineHeight()

◆ GetImages()

◆ GetInactiveFont()

◆ GetInactiveFontColor()

◆ GetMarkerNinePatch()

◆ GetMonthText()

◆ GetShowHeadLine()

◆ GetShowWeekDays()

◆ GetTouchControl()

◆ IsHighlightable()

◆ NextMonth()

◆ NextYear()

◆ OnNotification()

◆ PreviousMonth()

◆ PreviousYear()

◆ ReadFromStream()

◆ SetDate()

◆ SetDaySize()

◆ SetDayText() [1/2]

◆ SetDayText() [2/2]

◆ SetFillEmptySpaces()

◆ SetFirstDayOfWeek()

◆ SetFont()

◆ SetFontColor() [1/2]

◆ SetFontColor() [2/2]

◆ SetHeadlineColor() [1/2]

◆ SetHeadlineColor() [2/2]

◆ SetHeadlineFont()

◆ SetHeadlineHeight()

◆ SetHeight()

◆ SetImages()

◆ SetInactiveFont()

◆ SetInactiveFontColor() [1/2]

◆ SetInactiveFontColor() [2/2]

◆ SetMonthText() [1/2]

◆ SetMonthText() [2/2]

◆ SetShowHeadLine()

◆ SetShowWeekDays()

◆ SetTouchControl()

◆ SetWidth()

◆ WriteToStream()