diff options
author | JF002 <JF002@users.noreply.github.com> | 2020-10-11 17:05:01 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-11 17:05:01 +0200 |
commit | da73938f4d3fe04cc116bdb4d4885c5916aacb0e (patch) | |
tree | 183422265545e6db4e20a7b263a505d3f59f729c /src/displayapp/screens/Screen.h | |
parent | bb72712d376685143b57d321c6f967cbbca4c28e (diff) | |
parent | fd110dabe82f100550a7538c0e3eb3a439c9a7d2 (diff) |
Merge pull request #82 from Avamander/patch-6
Minor formatting, diagnostic and documentation changes
Diffstat (limited to 'src/displayapp/screens/Screen.h')
-rw-r--r-- | src/displayapp/screens/Screen.h | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/src/displayapp/screens/Screen.h b/src/displayapp/screens/Screen.h index 0a17b4da..6b1d0eec 100644 --- a/src/displayapp/screens/Screen.h +++ b/src/displayapp/screens/Screen.h @@ -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; } |