diff options
Diffstat (limited to 'common/system.h')
-rw-r--r-- | common/system.h | 31 |
1 files changed, 30 insertions, 1 deletions
diff --git a/common/system.h b/common/system.h index b584739b77..ad706b51fd 100644 --- a/common/system.h +++ b/common/system.h @@ -195,7 +195,13 @@ public: * engine queries for to assign keys to actions ("Here's my default key * map for these actions, what do you want them set to?"). */ - kFeatureDisableKeyFiltering + kFeatureDisableKeyFiltering, + + /** + * This feature indicates whether the displayLogFile() call + * is supported. + */ + kFeatureDisplayLogFile }; /** @@ -1010,6 +1016,29 @@ public: virtual void logMessage(LogMessageType::Type type, const char *message); /** + * Open the log file in a way that allows the user to review it, + * and possibly email it (or parts of it) to the ScummVM team, + * e.g. as part of a bug report. + * + * On a desktop operating system, this would typically launch + * some kind of (external) text editor / viewer. + * On a phone, it might also cause a context switch to another + * application. Finally, on some ports, it might not be supported. + * at all, and so do nothing. + * + * The kFeatureDisplayLogFile feature flag can be used to + * test whether this call has been implemented by the active + * backend. + * + * @return true if all seems to have gone fine, false if an error occurred + * + * @note An error could mean that the log file did not exist, + * or the editor could not launch. However, a return value of true does + * not guarantee that the user actually will the log file. + */ + virtual bool displayLogFile() { return false; } + + /** * Returns the locale of the system. * * This returns the currently set up locale of the system, on which |