aboutsummaryrefslogtreecommitdiff
path: root/engines/sherlock/scalpel/scalpel_journal.h
blob: 50f1917fca1151eb6a1f46feead255d73cd11732 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* 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.
 *
 */

#ifndef SHERLOCK_SCALPEL_JOURNAL_H
#define SHERLOCK_SCALPEL_JOURNAL_H

#include "sherlock/journal.h"
#include "sherlock/saveload.h"
#include "common/scummsys.h"
#include "common/array.h"
#include "common/rect.h"
#include "common/str-array.h"
#include "common/stream.h"

namespace Sherlock {

namespace Scalpel {

enum JournalButton {
	BTN_NONE, BTN_EXIT, BTN_BACK10, BTN_UP, BTN_DOWN, BTN_AHEAD110, BTN_SEARCH,
	BTN_FIRST_PAGE, BTN_LAST_PAGE, BTN_PRINT_TEXT
};

class ScalpelJournal: public Journal {
public:
	Common::String _fixedTextWatsonsJournal;
	Common::String _fixedTextExit;
	Common::String _fixedTextBack10;
	Common::String _fixedTextUp;
	Common::String _fixedTextDown;
	Common::String _fixedTextAhead10;
	Common::String _fixedTextSearch;
	Common::String _fixedTextFirstPage;
	Common::String _fixedTextLastPage;
	Common::String _fixedTextPrintText;

	byte _hotkeyExit;
	byte _hotkeyBack10;
	byte _hotkeyUp;
	byte _hotkeyDown;
	byte _hotkeyAhead10;
	byte _hotkeySearch;
	byte _hotkeyFirstPage;
	byte _hotkeyLastPage;
	byte _hotkeyPrintText;

	Common::String _fixedTextSearchExit;
	Common::String _fixedTextSearchBackward;
	Common::String _fixedTextSearchForward;
	Common::String _fixedTextSearchNotFound;

	byte _hotkeySearchExit;
	byte _hotkeySearchBackward;
	byte _hotkeySearchForward;

private:
	/**
	 * Load the list of journal locations
	 */
	void loadLocations();

	/**
	 * Display the arrows that can be used to scroll up and down pages
	 */
	void doArrows();

	/**
	 * Show the search submenu and allow the player to enter a search string
	 */
	int getSearchString(bool printError);

	/**
	 * Returns the button, if any, that is under the specified position
	 */
	JournalButton getHighlightedButton(const Common::Point &pt);
public:
	ScalpelJournal(SherlockEngine *vm);
	virtual ~ScalpelJournal() {}

	/**
	 * Display the journal
	 */
	void drawInterface();

	/**
	 * Handle events whilst the journal is being displayed
	 */
	bool handleEvents(int key);
public:
	/**
	 * Draw the journal background, frame, and interface buttons
	 */
	virtual void drawFrame();

	/**
	 * Reset viewing position to the start of the journal
	 */
	virtual void resetPosition();

	/**
	 * Records statements that are said, in the order which they are said. The player
	 * can then read the journal to review them
	 */
	virtual void record(int converseNum, int statementNum, bool replyOnly = false);
};

} // End of namespace Scalpel

} // End of namespace Sherlock

#endif