aboutsummaryrefslogtreecommitdiff
path: root/engines/sherlock/tattoo/tattoo_journal.h
blob: 9f0fa1fc9b5b1ecd35cc322f1397d83b472bc960 (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
/* 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_TATTOO_JOURNAL_H
#define SHERLOCK_TATTOO_JOURNAL_H

#include "sherlock/journal.h"
#include "sherlock/image_file.h"

namespace Sherlock {

namespace Tattoo {

enum JournalHighlight {
	JH_NONE = -1, JH_CLOSE = 0, JH_SEARCH = 1, JH_SAVE = 2,
	JH_SCROLL_LEFT = 3, JH_PAGE_LEFT = 4, JH_PAGE_RIGHT = 5, JH_SCROLL_RIGHT = 6, JH_THUMBNAIL = 7
};

class TattooJournal : public Journal {
private:
	ImageFile *_journalImages;
	int _selector, _oldSelector;
	bool _wait;
	bool _exitJournal;
	uint32 _scrollingTimer;
	int _savedIndex, _savedSub, _savedPage;

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

	/**
	 * Displays the controls used by the journal
	 * @param mode	0: Normal journal buttons, 1: Search interface
	 */
	void drawControls(int mode);

	/**
	 * Draw the journal controls used by the journal
	 */
	void highlightJournalControls(bool slamIt);

	/**
	 * Draw the journal controls used in search mode
	 */
	void highlightSearchControls(bool slamIt);

	void drawScrollBar();

	/**
	 * Check for and handle any pending keyboard events
	 */
	void handleKeyboardEvents();

	/**
	 * Handle mouse presses on interface buttons
	 */
	void handleButtons();

	/**
	 * Disable the journal controls
	 */
	void disableControls();

	/**
	 * Get in a name to search through the journal for
	 */
	int getFindName(bool printError);

	/**
	 * Save the journal to file
	 */
	void saveJournal();

	/**
	 * Show a message that the journal has been saved to file
	 */
	void showSavedDialog();
public:
	TattooJournal(SherlockEngine *vm);
	virtual ~TattooJournal() {}

	/**
	 * Show the journal
	 */
	void show();
public:
	/**
	 * Draw the journal background, frame, and interface buttons
	 */
	virtual void drawFrame();

	/**
	 * 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 Tattoo

} // End of namespace Sherlock

#endif