ScummVM API documentation
help.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22/*
23* This code is based on the original source code of Lord Avalot d'Argent version 1.3.
24* Copyright (c) 1994-1995 Mike, Mark and Thomas Thurman.
25*/
26
27/* Original name: HELPER The help system unit. */
28
29#ifndef AVALANCHE_HELP_H
30#define AVALANCHE_HELP_H
31
32namespace Avalanche {
33class AvalancheEngine;
34
35class Help {
36public:
38
39 void run();
40
41private:
42 struct Button {
43 Common::KeyCode _trigger;
44 byte _whither;
45 };
46
47 AvalancheEngine *_vm;
48
49 Button _buttons[10];
50 byte _highlightWas;
51 byte _buttonNum; // How many buttons do we have on the screen at the moment?
52 bool _holdLeft; // Is the left mouse button is still being held?
53
54 void switchPage(byte which);
55 Common::String getLine(Common::File &file); // It was a nested function in getMe().
56
57 // These two return true if we have to leave the Help:
58 bool handleMouse(const Common::Event &event);
59 bool handleKeyboard(const Common::Event &event);
60};
61
62} // End of namespace Avalanche
63
64#endif // AVALANCHE_HELP_H
Definition: avalanche.h:78
Definition: help.h:35
Definition: file.h:47
Definition: str.h:59
Definition: events.h:218