EmuWindow: Better document the purpose of OnMinimalClientAreaChangeRequest.

This commit is contained in:
Tony Wasserka 2014-11-13 18:24:15 +01:00
parent 182476c96a
commit 19bb01c223

View File

@ -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;