tcMenu
Public Member Functions | List of all members
DrawableDashboardDelegate Class Reference

#include <DrawableDashboard.h>

Public Member Functions

virtual void dashboardDidClose ()
 
virtual bool dashboardWillOpen (BaseMenuRenderer *)
 
virtual void dashboardDidOpen (BaseMenuRenderer *)
 
virtual void dashboardWillDraw (unsigned int, RenderPressMode)
 
virtual void dashboardDidDraw (unsigned int, RenderPressMode)
 
virtual void displayDidReset ()
 

Detailed Description

Allows for easy extension of the below drawable dashboard by providing callbacks when important events occur, mainly before and after a dashboard is opened or drawn to. It also tells you when a dashboard was closed, and if the display has reset due to a timeout. This provides an easy way to customize further the dashboard support in nearly all cases. The two "draw" functions are called in the rendering loop, one before any drawing, the other afterwards.

Member Function Documentation

◆ dashboardDidClose()

virtual void DrawableDashboardDelegate::dashboardDidClose ( )
inlinevirtual

Indicates that the dashboard has closed and no longer displayed

◆ dashboardWillOpen()

virtual bool DrawableDashboardDelegate::dashboardWillOpen ( BaseMenuRenderer *  )
inlinevirtual

Indicates that the dashboard will open, called before any other work is done by the dashboard.

Returns
true if you have already cleared the screen, otherwise false to have the core code do it.

◆ dashboardDidOpen()

virtual void DrawableDashboardDelegate::dashboardDidOpen ( BaseMenuRenderer *  )
inlinevirtual

Indicates that the dashboard has already opened, called after any other work is done by the dashboard.

◆ dashboardWillDraw()

virtual void DrawableDashboardDelegate::dashboardWillDraw ( unsigned int  ,
RenderPressMode   
)
inlinevirtual

Indicates that the dashboard will start drawing, called before any other work is done by the dashboard. The current value of the rotary encoder and state of the button are provided.

◆ dashboardDidDraw()

virtual void DrawableDashboardDelegate::dashboardDidDraw ( unsigned int  ,
RenderPressMode   
)
inlinevirtual

Indicates that the dashboard drawing is completed, called after any other work is done by the dashboard. The current value of the rotary encoder and state of the button are provided.

◆ displayDidReset()

virtual void DrawableDashboardDelegate::displayDidReset ( )
inlinevirtual

Indicates that the display reset has been received from the renderer.

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