Minor formatting, diagnostic and documentation changes

This commit is contained in:
Avamander
2020-10-04 15:08:48 +03:00
parent bb72712d37
commit f68c7b65b3
5 changed files with 31 additions and 11 deletions

View File

@@ -12,13 +12,25 @@ namespace Pinetime {
explicit Screen(DisplayApp* app) : app{app} {}
virtual ~Screen() = default;
// Return false if the app can be closed, true if it must continue to run
/**
* Most of the time, apps only react to events (touch events, for example).
* In this case you don't need to do anything in this method.
*
* For example, InfiniPaint does nothing in Refresh().
* But, if you want to update your display periodically, draw an animation...
* you cannot do it in a touch event handler because these handlers are not
* called if the user does not touch the screen.
*
* That's why Refresh() is there: update the display periodically.
*
* @return false if the app can be closed, true if it must continue to run
**/
virtual bool Refresh() = 0;
// Return false if the button hasn't been handled by the app, true if it has been handled
/** @return false if the button hasn't been handled by the app, true if it has been handled */
virtual bool OnButtonPushed() { return false; }
// Return false if the event hasn't been handled by the app, true if it has been handled
/** @return false if the event hasn't been handled by the app, true if it has been handled */
virtual bool OnTouchEvent(TouchEvents event) { return false; }
virtual bool OnTouchEvent(uint16_t x, uint16_t y) { return false; }