scummvm/engines/avalanche/help.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

/*
* This code is based on the original source code of Lord Avalot d'Argent version 1.3.
* Copyright (c) 1994-1995 Mike, Mark and Thomas Thurman.
*/

/* Original name: HELPER	The help system unit. */

#ifndef AVALANCHE_HELP_H
#define AVALANCHE_HELP_H

namespace Avalanche {
class AvalancheEngine;

class Help {
public:
	Help(AvalancheEngine *vm);

	void run();

private:
	struct Button {
		Common::KeyCode _trigger;
		byte _whither;
	};

	AvalancheEngine *_vm;

	Button _buttons[10];
	byte _highlightWas;
	byte _buttonNum; // How many buttons do we have on the screen at the moment?
	bool _holdLeft; // Is the left mouse button is still being held?

	void switchPage(byte which);
	Common::String getLine(Common::File &file); // It was a nested function in getMe().

	// These two return true if we have to leave the Help:
	bool handleMouse(const Common::Event &event);
	bool handleKeyboard(const Common::Event &event);
};

} // End of namespace Avalanche

#endif // AVALANCHE_HELP_H