From 19bb01c223a36b7c02253cfedeb9e07c0d5a692b Mon Sep 17 00:00:00 2001 From: Tony Wasserka Date: Thu, 13 Nov 2014 18:24:15 +0100 Subject: EmuWindow: Better document the purpose of OnMinimalClientAreaChangeRequest. --- src/common/emu_window.h | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'src/common/emu_window.h') diff --git a/src/common/emu_window.h b/src/common/emu_window.h index 3817a773..a9cf7169 100644 --- a/src/common/emu_window.h +++ b/src/common/emu_window.h @@ -100,6 +100,8 @@ protected: /** * Processes any pending configuration changes from the last SetConfig call. + * This method invokes OnMinimalClientAreaChangeRequest if the corresponding configuration + * field changed. * @note Implementations will usually want to call this from the GUI thread. */ void ProcessConfigurationChanges() { @@ -130,7 +132,12 @@ protected: } private: + /** + * Handler called when the minimal client area was requested to be changed via SetConfig. + * For the request to be honored, EmuWindow implementations will usually reimplement this function. + */ virtual void OnMinimalClientAreaChangeRequest(const std::pair& minimal_size) { + // By default, ignore this request and do nothing. } std::pair framebuffer_size; -- cgit v1.2.3