aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/gfx/text_control.h
blob: d4ef19a7cf6e5f331f2efdab52bf8e4d6a5ccc91 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/* 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 TITANIC_TEXT_CONTROL_H
#define TITANIC_TEXT_CONTROL_H

#include "common/keyboard.h"
#include "titanic/support/simple_file.h"
#include "titanic/support/screen_manager.h"
#include "titanic/support/text_cursor.h"

namespace Titanic {

class CTextControl {
	struct ArrayEntry {
		CString _line;
		CString _rgb;
		CString _string3;
	};
private:
	Common::Array<ArrayEntry> _array;
	CString _lines;
	bool _stringsMerged;
	Rect _bounds;
	int _maxCharsPerLine;
	int _lineCount;
	int _displayEndCharIndex;
	int _unused1;
	int _unused2;
	int _unused3;
	int _backR;
	int _backG;
	int _backB;
	int _textR;
	int _textG;
	int _textB;
	int _fontNumber;
	int _npcFlag;
	int _npcId;
	bool _hasBorder;
	int _scrollTop;
	CTextCursor *_textCursor;
private:
	void setupArrays(int count);

	void freeArrays();

	/**
	 * Merges the strings in the strings array
	 */
	void mergeStrings();

	/**
	 * Append text to the current text line
	 */
	void appendText(const CString &str);

	void updateStr3(int lineNum);

	/**
	 * Ensures the Y scrolling for the text is in the valid range
	 */
	void constrainScrollUp(CScreenManager *screenManager);

	/**
	 * Ensures the Y scrolling for the text is in the valid range
	 */
	void constrainScrollDown(CScreenManager *screenManager);

	/**
	 * Get the page height for paging up and down
	 */
	int getPageHeight(CScreenManager *screenManager);
public:
	CTextControl(uint count = 10);

	/**
	 * Set up the control
	 */
	void setup();

	/**
	 * Load the data for the control
	 */
	void load(SimpleFile *file, int param);

	/**
	 * Save the data for the control
	 */
	void save(SimpleFile *file, int indent);

	/**
	 * Set the bounds for the control
	 */
	void setBounds(const Rect &bounds) { _bounds = bounds; }

	/**
	 * Sets the flag for whether to draw a frame border around the control
	 */
	void setHasBorder(bool val) { _hasBorder = val; }

	/**
	 * Draw the control
	 */
	void draw(CScreenManager *screenManager);

	void resize(uint count);

	/**
	 * Returns the text from all the lines as a single string
	 */
	CString getText() const;

	/**
	 * Set the text
	 */
	void setText(const CString &str);

	/**
	 * Set the text
	 */
	void setText(StringId stringId);

	/**
	 * Set text color
	 */
	void setColor(uint col);

	/**
	 * Set text color
	 */
	void setColor(byte r, byte g, byte b);

	/**
	 * Set the color for a line
	 */
	void setLineColor(uint lineNum, byte r, byte g, byte b);

	/**
	 * Gets the text string representing a color encoding
	 */
	static CString getColorText(byte r, byte g, byte b);

	/**
	 * Set the color for a line
	 */
	void setLineColor(uint lineNum, uint col);

	/**
	 * Sets the maximum number of characters per line
	 */
	void setMaxCharsPerLine(int maxChars);

	/**
	 * Delete the last character from the last line
	 */
	void deleteLastChar();

	/**
	 * Sets the current NPC text is being added for
	 */
	void setNPC(int npcFlag, int npcId);

	/**
	 * Returns the character index into _lines of the last
	 * character to be displayed on-screen
	 */
	int displayEndIndex() const { return _displayEndCharIndex; }

	/**
	 * Scroll the text up
	 */
	void scrollUp(CScreenManager *screenManager);

	/**
	 * Scroll the text down
	 */
	void scrollDown(CScreenManager *screenManager);

	/**
	 * Scroll the text up one page
	 */
	void scrollUpPage(CScreenManager *screenManager);

	/**
	 * Scroll the text down one page
	 */
	void scrollDownPage(CScreenManager *screenManager);

	/**
	 * Scroll to the top of the text
	 */
	void scrollToTop(CScreenManager *screenManager);

	/**
	 * Scroll to the bottom of the text
	 */
	void scrollToBottom(CScreenManager *screenManager);

	/**
	 * Add a line to the text
	 */
	void addLine(const CString &str);

	/**
	 * Add a line to the text
	 */
	void addLine(const CString &str, uint color);

	/**
	 * Add a line to the text
	 */
	void addLine(const CString &str, byte r, byte g, byte b);

	/**
	 * Handles character processing to add or remove characters to
	 * the current text line
	 * @returns		True if the Enter key was pressed
	 */
	bool handleKey(char c);

	/**
	 * Attaches the current system cursor to the text control,
	 * and give it suitable defaults
	 */
	void showCursor(int mode);

	/**
	 * Removes the cursor attached to the text
	 */
	void hideCursor();

	/**
	 * Get an NPC Number embedded within on-screen text.
	 * Used by the PET log to encode which NPC spoke
	 * @param ident			Npc Type. Always passed as 1
	 * @param startIndex	Starting index to scan backwards
	 *		through the log text to find an NPC ident sequence
	 */
	int getNPCNum(uint ident, uint startIndex);

	/**
	 * Replaces any occurances of line colors that appear in the
	 * first list with the entry at the same index in the dest list
	 */
	void remapColors(uint count, uint *srcColors, uint *destColors);

	/**
	 * Set the font number to use
	 */
	void setFontNumber(int fontNumber);

	/**
	 * Get the width of the text
	 */
	int getTextWidth(CScreenManager *screenManager);

	/**
	 * Get the required height to draw the text
	 */
	int getTextHeight(CScreenManager *screenManager);
};

} // End of namespace Titanic

#endif /* TITANIC_TEXT_CONTROL_H */