thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

SHERLOCK: Extra method comments

Browse source
This commit is contained in:
Paul Gilbert 2015-05-01 17:17:24 -10:00
parent 42a99354f9
commit b4c3d9840c
14 changed files with 132 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

17
engines/sherlock/user_interface.cpp
View file

@ -188,6 +188,9 @@ void Settings::drawInteface(bool flag) {
}
}
/**
* Draws the buttons for the settings dialog
*/
int Settings::drawButtons(const Common::Point &pt, int _key) {
Events &events = *_vm->_events;
People &people = *_vm->_people;
@ -259,7 +262,6 @@ int Settings::drawButtons(const Common::Point &pt, int _key) {
return found;
}
/*----------------------------------------------------------------*/
UserInterface::UserInterface(SherlockEngine *vm) : _vm(vm) {
@ -298,6 +300,9 @@ UserInterface::~UserInterface() {
delete _controlPanel;
}
/**
* Resets the user interface
*/
void UserInterface::reset() {
_oldKey = -1;
_help = _oldHelp = -1;
@ -1962,6 +1967,12 @@ void UserInterface::doTalkControl() {
}
}
/**
* Handles events when the Journal is active.
* @remarks Whilst this would in theory be better in the Journal class, since it displays in
* the user interface, it uses so many internal UI fields, that it sort of made some sense
* to put it in the UserInterface class.
*/
void UserInterface::journalControl() {
Events &events = *_vm->_events;
Journal &journal = *_vm->_journal;
@ -2013,6 +2024,9 @@ void UserInterface::journalControl() {
/**
* Handles input when the settings window is being shown
* @remarks Whilst this would in theory be better in the Journal class, since it displays in
* the user interface, it uses so many internal UI fields, that it sort of made some sense
* to put it in the UserInterface class.
*/
void UserInterface::doControls() {
Events &events = *_vm->_events;
@ -2702,5 +2716,4 @@ void UserInterface::checkAction(ActionType &action, const char *const messages[]
events.setCursor(ARROW);
}
} // End of namespace Sherlock