summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2010-01-23 19:30:53 +0000
committerrubidium <rubidium@openttd.org>2010-01-23 19:30:53 +0000
commit37b0a61b42b77422f7795a9ea01970220c80e9aa (patch)
treecbc0bf107eda908739052cc6ce5190c44b625ef8
parent2b82db72efa7d148699cbdbcffd2e7e2a1a75f20 (diff)
downloadopenttd-37b0a61b42b77422f7795a9ea01970220c80e9aa.tar.xz
(svn r18900) -Document: that an empty string for OnQueryTextFinished means 'use default'
-rw-r--r--src/window_gui.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/window_gui.h b/src/window_gui.h
index eb2a6ac7f..dccabc09a 100644
--- a/src/window_gui.h
+++ b/src/window_gui.h
@@ -719,8 +719,9 @@ public:
/**
* The query window opened from this window has closed.
- * @param str the new value of the string or NULL if the window
- * was cancelled.
+ * @param str the new value of the string, NULL if the window
+ * was cancelled or an empty string when the default
+ * button was pressed, i.e. StrEmpty(str).
*/
virtual void OnQueryTextFinished(char *str) {}