diff options
| author | Tony Wasserka <NeoBrainX@gmail.com> | 2014-11-13 18:24:15 +0100 |
|---|---|---|
| committer | Tony Wasserka <NeoBrainX@gmail.com> | 2014-11-18 13:09:01 +0100 |
| commit | 19bb01c223a36b7c02253cfedeb9e07c0d5a692b (patch) | |
| tree | 20e60f7e8fbd616e0f99f91fd9d747741600af0a /src/common/emu_window.h | |
| parent | 182476c96a6c75e90a90cbb52048bf754fdd786d (diff) | |
EmuWindow: Better document the purpose of OnMinimalClientAreaChangeRequest.
Diffstat (limited to 'src/common/emu_window.h')
| -rw-r--r-- | src/common/emu_window.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/common/emu_window.h b/src/common/emu_window.h index 3817a7734b..a9cf71690d 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<unsigned,unsigned>& minimal_size) { + // By default, ignore this request and do nothing. } std::pair<unsigned,unsigned> framebuffer_size; |