aboutsummaryrefslogtreecommitdiff
path: root/backends
diff options
context:
space:
mode:
authorAlexander Tkachev2016-06-04 20:37:47 +0600
committerAlexander Tkachev2016-08-24 16:07:55 +0600
commit602d17f5fd3f3d89716be9f2975f644512aeb12d (patch)
tree000fe0ef8c01b00cfd37454a0c8147b903aa2d4b /backends
parent45e83d06c2a42ceb557e1765b15b9200853fcfae (diff)
downloadscummvm-rg350-602d17f5fd3f3d89716be9f2975f644512aeb12d.tar.gz
scummvm-rg350-602d17f5fd3f3d89716be9f2975f644512aeb12d.tar.bz2
scummvm-rg350-602d17f5fd3f3d89716be9f2975f644512aeb12d.zip
CLOUD: Document CloudIcon::draw() more precisely
Diffstat (limited to 'backends')
-rw-r--r--backends/networking/curl/cloudicon.h16
1 files changed, 15 insertions, 1 deletions
diff --git a/backends/networking/curl/cloudicon.h b/backends/networking/curl/cloudicon.h
index e981dda611..9b30a8640d 100644
--- a/backends/networking/curl/cloudicon.h
+++ b/backends/networking/curl/cloudicon.h
@@ -42,7 +42,21 @@ public:
CloudIcon();
~CloudIcon();
- /** Returns true if ConnMan's timer could be stopped. */
+ /**
+ * This method is called from ConnectionManager every time
+ * its own timer calls the handle() method. The primary
+ * responsibility of this draw() method is to draw cloud icon
+ * on ScummVM's OSD when current cloud Storage is working.
+ *
+ * As we don't want ConnectionManager to work when no
+ * Requests are running, we'd like to stop the timer. But then
+ * this icon wouldn't have time to disappear smoothly. So,
+ * in order to do that, ConnectionManager stop its timer
+ * only when this draw() method returns true, indicating that
+ * the CloudIcon has disappeared and the timer could be stopped.
+ *
+ * @return true if ConnMan's timer could be stopped.
+ */
bool draw();
};