Repository navigation
Expand file tree
/
Copy pathTextList.cpp
More file actions
805 lines (740 loc) · 19 KB
/
Copy pathTextList.cpp
File metadata and controls
805 lines (740 loc) · 19 KB
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
/*
* Copyright 2010-2012 OpenXcom Developers.
*
* This file is part of OpenXcom.
*
* OpenXcom 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 3 of the License, or
* (at your option) any later version.
*
* OpenXcom 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 OpenXcom. If not, see <http://www.gnu.org/licenses/>.
*/
#include "TextList.h"
#include <cstdarg>
#include <cmath>
#include "../Engine/Action.h"
#include "../Engine/Font.h"
#include "../Engine/Palette.h"
#include "ArrowButton.h"
namespace OpenXcom
{
/**
* Sets up a blank list with the specified size and position.
* @param width Width in pixels.
* @param height Height in pixels.
* @param x X position in pixels.
* @param y Y position in pixels.
*/
TextList::TextList(int width, int height, int x, int y) : InteractiveSurface(width, height, x, y), _texts(), _columns(), _big(0), _small(0), _font(0), _scroll(0), _visibleRows(0), _color(0), _align(ALIGN_LEFT), _dot(false), _selectable(false), _condensed(false), _contrast(false),
_selRow(0), _bg(0), _selector(0), _margin(0), _arrowLeft(), _arrowRight(), _arrowPos(-1), _arrowType(ARROW_VERTICAL), _leftClick(0), _leftPress(0), _leftRelease(0), _rightClick(0), _rightPress(0), _rightRelease(0)
{
_up = new ArrowButton(ARROW_BIG_UP, 13, 14, getX() + getWidth() + 4, getY() + 1);
_up->setVisible(false);
_up->setTextList(this);
_down = new ArrowButton(ARROW_BIG_DOWN, 13, 14, getX() + getWidth() + 4, getY() + getHeight() - 12);
_down->setVisible(false);
_down->setTextList(this);
}
/**
* Deletes all the stuff contained in the list.
*/
TextList::~TextList()
{
for (std::vector< std::vector<Text*> >::iterator u = _texts.begin(); u < _texts.end(); ++u)
{
for (std::vector<Text*>::iterator v = (*u).begin(); v < (*u).end(); ++v)
{
delete *v;
}
}
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
delete *i;
}
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
delete *i;
}
delete _selector;
delete _up;
delete _down;
}
/**
* Unpresses all the arrow buttons.
* @param state Pointer to running state.
*/
void TextList::unpress(State *state)
{
InteractiveSurface::unpress(state);
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
(*i)->unpress(state);
}
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
(*i)->unpress(state);
}
}
/**
* Changes the color of a specific Text object in the list.
* @param row Row number.
* @param column Column number.
* @param color Text color.
*/
void TextList::setCellColor(int row, int column, Uint8 color)
{
_texts[row][column]->setColor(color);
}
/**
* Changes the text color of a whole row in the list.
* @param row Row number.
* @param color Text color.
*/
void TextList::setRowColor(int row, Uint8 color)
{
for (std::vector<Text*>::iterator i = _texts[row].begin(); i < _texts[row].end(); ++i)
{
(*i)->setColor(color);
}
_redraw = true;
}
/**
* Returns the text of a specific Text object in the list.
* @param row Row number.
* @param column Column number.
* @return Text string.
*/
std::wstring TextList::getCellText(int row, int column) const
{
return _texts[row][column]->getText();
}
/**
* Changes the text of a specific Text object in the list.
* @param row Row number.
* @param column Column number.
* @param text Text string.
*/
void TextList::setCellText(int row, int column, const std::wstring &text)
{
_texts[row][column]->setText(text);
_redraw = true;
}
/**
* Adds a new row of text to the list, automatically creating
* the required Text objects lined up where they need to be.
* @param cols Number of columns.
* @param ... Text for each cell in the new row.
*/
void TextList::addRow(int cols, ...)
{
va_list args;
va_start(args, cols);
std::vector<Text*> temp;
int rowX = 0;
for (int i = 0; i < cols; ++i)
{
// Place text
Text* txt = new Text(_columns[i], _font->getHeight(), _margin + rowX, getY());
txt->setPalette(this->getPalette());
txt->setFonts(_big, _small);
txt->setColor(_color);
txt->setSecondaryColor(_color2);
txt->setAlign(_align);
txt->setHighContrast(_contrast);
if (_font == _big)
{
txt->setBig();
}
else
{
txt->setSmall();
}
txt->setText(va_arg(args, wchar_t*));
// Places dots between text
if (_dot && i < cols - 1)
{
std::wstring buf = txt->getText();
int w = txt->getTextWidth();
while (w < _columns[i])
{
w += _font->getChar('.')->getCrop()->w + _font->getSpacing();
buf += '.';
}
txt->setText(buf);
}
temp.push_back(txt);
if (_condensed)
{
rowX += txt->getTextWidth();
}
else
{
rowX += _columns[i];
}
}
_texts.push_back(temp);
// Place arrow buttons
if (_arrowPos != -1)
{
ArrowShape shape1, shape2;
if (_arrowType == ARROW_VERTICAL)
{
shape1 = ARROW_SMALL_UP;
shape2 = ARROW_SMALL_DOWN;
}
else
{
shape1 = ARROW_SMALL_LEFT;
shape2 = ARROW_SMALL_RIGHT;
}
ArrowButton *a1 = new ArrowButton(shape1, 11, 8, getX() + _arrowPos, getY());
a1->setPalette(this->getPalette());
a1->setColor(_up->getColor());
a1->onMouseClick(_leftClick);
a1->onMousePress(_leftPress);
a1->onMouseRelease(_leftRelease);
_arrowLeft.push_back(a1);
ArrowButton *a2 = new ArrowButton(shape2, 11, 8, getX() + _arrowPos + 12, getY());
a2->setPalette(this->getPalette());
a2->setColor(_up->getColor());
a2->onMouseClick(_rightClick);
a2->onMousePress(_rightPress);
a2->onMouseRelease(_rightRelease);
_arrowRight.push_back(a2);
}
_redraw = true;
va_end(args);
updateArrows();
}
/**
* Changes the columns that the list contains.
* While rows can be unlimited, columns need to be specified
* since they can have various widths for lining up the text.
* @param cols Number of columns.
* @param ... Width of each column.
*/
void TextList::setColumns(int cols, ...)
{
va_list args;
va_start(args, cols);
for (int i = 0; i < cols; ++i)
{
_columns.push_back(va_arg(args, int));
}
va_end(args);
}
/**
* Replaces a certain amount of colors in the palette of all
* the text contained in the list.
* @param colors Pointer to the set of colors.
* @param firstcolor Offset of the first color to replace.
* @param ncolors Amount of colors to replace.
*/
void TextList::setPalette(SDL_Color *colors, int firstcolor, int ncolors)
{
Surface::setPalette(colors, firstcolor, ncolors);
for (std::vector< std::vector<Text*> >::iterator u = _texts.begin(); u < _texts.end(); ++u)
{
for (std::vector<Text*>::iterator v = u->begin(); v < u->end(); ++v)
{
(*v)->setPalette(colors, firstcolor, ncolors);
}
}
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
(*i)->setPalette(colors, firstcolor, ncolors);
}
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
(*i)->setPalette(colors, firstcolor, ncolors);
}
if (_selector != 0)
{
_selector->setPalette(colors, firstcolor, ncolors);
}
_up->setPalette(colors, firstcolor, ncolors);
_down->setPalette(colors, firstcolor, ncolors);
}
/**
* Changes the various fonts of the text in the list
* and calculates the selector and visible amount of rows.
* @param big Pointer to large-size font.
* @param small Pointer to small-size font.
*/
void TextList::setFonts(Font *big, Font *small)
{
_big = big;
_small = small;
_font = small;
delete _selector;
_selector = new Surface(getWidth(), _font->getHeight() + _font->getSpacing(), getX(), getY());
_selector->setPalette(getPalette());
_selector->setVisible(false);
for (int y = 0; y < getHeight(); y += _font->getHeight() + _font->getSpacing())
{
_visibleRows++;
}
}
/**
* Changes the color of the text in the list. This doesn't change
* the color of existing text, just the color of text added from then on.
* @param color Color value.
*/
void TextList::setColor(Uint8 color)
{
_color = color;
_up->setColor(color);
_down->setColor(color);
}
/**
* Returns the color of the text in the list.
* @return Color value.
*/
Uint8 TextList::getColor() const
{
return _color;
}
/**
* Changes the secondary color of the text in the list.
* @param color Color value.
*/
void TextList::setSecondaryColor(Uint8 color)
{
_color2 = color;
}
/**
* Returns the secondary color of the text in the list.
* @return Color value.
*/
Uint8 TextList::getSecondaryColor() const
{
return _color2;
}
/**
* Enables/disables high contrast color. Mostly used for
* Battlescape text.
* @param contrast High contrast setting.
*/
void TextList::setHighContrast(bool contrast)
{
_contrast = contrast;
}
/**
* Changes the horizontal alignment of the text in the list. This doesn't change
* the alignment of existing text, just the alignment of text added from then on.
* @param align Horizontal alignment.
*/
void TextList::setAlign(TextHAlign align)
{
_align = align;
}
/**
* If enabled, the text in different columns will be separated by dots.
* Otherwise, it will only be separated by blank space.
* @param dot True for dots, False for spaces.
*/
void TextList::setDot(bool dot)
{
_dot = dot;
}
/**
* If enabled, the list will respond to player input,
* highlighting selected rows and receiving clicks.
* @param selectable Selectable setting.
*/
void TextList::setSelectable(bool selectable)
{
_selectable = selectable;
}
/**
* Changes the text list to use the big-size font.
*/
void TextList::setBig()
{
_font = _big;
delete _selector;
_selector = new Surface(getWidth(), _font->getHeight() + _font->getSpacing(), getX(), getY());
_selector->setPalette(getPalette());
_selector->setVisible(false);
for (int y = 0; y < getHeight(); y += _font->getHeight() + _font->getSpacing())
{
_visibleRows++;
}
}
/**
* Changes the text list to use the small-size font.
*/
void TextList::setSmall()
{
_font = _small;
delete _selector;
_selector = new Surface(getWidth(), _font->getHeight() + _font->getSpacing(), getX(), getY());
_selector->setPalette(getPalette());
_selector->setVisible(false);
for (int y = 0; y < getHeight(); y += _font->getHeight() + _font->getSpacing())
{
_visibleRows++;
}
}
/**
* If enabled, the columns will match the text width.
* Otherwise, they will have a fixed width.
* @param condensed True for condensed layout, False for table layout.
*/
void TextList::setCondensed(bool condensed)
{
_condensed = condensed;
}
/**
* Returns the currently selected row if the text
* list is selectable.
* @return Selected row.
*/
int TextList::getSelectedRow() const
{
return _selRow;
}
/**
* Changes the surface used to draw the background of the selector.
* @param bg New background.
*/
void TextList::setBackground(Surface *bg)
{
_bg = bg;
}
/**
* Changes the horizontal margin placed around the text.
* @param margin Margin in pixels.
*/
void TextList::setMargin(int margin)
{
_margin = margin;
}
/**
* Returns the margin of the text in the list.
* @return Margin in pixels.
*/
int TextList::getMargin() const
{
return _margin;
}
/**
* Changes the color of the arrow buttons in the list.
* @param color Color value.
*/
void TextList::setArrowColor(Uint8 color)
{
_up->setColor(color);
_down->setColor(color);
}
/**
* Sets the position of the column of arrow buttons
* in the text list.
* @param pos X in pixels (-1 to disable).
* @param type Arrow orientation type.
*/
void TextList::setArrowColumn(int pos, ArrowOrientation type)
{
_arrowPos = pos;
_arrowType = type;
}
/**
* Sets a function to be called every time the left arrows are mouse clicked.
* @param handler Action handler.
*/
void TextList::onLeftArrowClick(ActionHandler handler)
{
_leftClick = handler;
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
(*i)->onMouseClick(handler);
}
}
/**
* Sets a function to be called every time the left arrows are mouse pressed.
* @param handler Action handler.
*/
void TextList::onLeftArrowPress(ActionHandler handler)
{
_leftPress = handler;
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
(*i)->onMousePress(handler);
}
}
/**
* Sets a function to be called every time the left arrows are mouse released.
* @param handler Action handler.
*/
void TextList::onLeftArrowRelease(ActionHandler handler)
{
_leftRelease = handler;
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
(*i)->onMouseRelease(handler);
}
}
/**
* Sets a function to be called every time the right arrows are mouse clicked.
* @param handler Action handler.
*/
void TextList::onRightArrowClick(ActionHandler handler)
{
_rightClick = handler;
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
(*i)->onMouseClick(handler);
}
}
/**
* Sets a function to be called every time the right arrows are mouse pressed.
* @param handler Action handler.
*/
void TextList::onRightArrowPress(ActionHandler handler)
{
_rightPress = handler;
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
(*i)->onMousePress(handler);
}
}
/**
* Sets a function to be called every time the right arrows are mouse released.
* @param handler Action handler.
*/
void TextList::onRightArrowRelease(ActionHandler handler)
{
_rightRelease = handler;
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
(*i)->onMouseRelease(handler);
}
}
/**
* Removes all the rows currently stored in the list.
*/
void TextList::clearList()
{
for (std::vector< std::vector<Text*> >::iterator u = _texts.begin(); u < _texts.end(); ++u)
{
for (std::vector<Text*>::iterator v = u->begin(); v < u->end(); ++v)
{
delete (*v);
}
u->clear();
}
_texts.clear();
}
/**
* Scrolls the text in the list up by one row.
*/
void TextList::scrollUp()
{
if (_texts.size() > _visibleRows && _scroll > 0)
{
_scroll--;
_redraw = true;
}
updateArrows();
}
/**
* Scrolls the text in the list down by one row.
*/
void TextList::scrollDown()
{
if (_texts.size() > _visibleRows && _scroll < _texts.size() - _visibleRows)
{
_scroll++;
_redraw = true;
}
updateArrows();
}
/**
* Updates the visibility of the arrow buttons according to
* the current scroll position.
*/
void TextList::updateArrows()
{
_up->setVisible((_texts.size() > _visibleRows && _scroll > 0));
_down->setVisible((_texts.size() > _visibleRows && _scroll < _texts.size() - _visibleRows));
}
/**
* Draws the text list and all the text contained within.
*/
void TextList::draw()
{
Surface::draw();
for (unsigned int i = _scroll; i < _texts.size() && i < _scroll + _visibleRows; ++i)
{
for (std::vector<Text*>::iterator j = _texts[i].begin(); j < _texts[i].end(); ++j)
{
(*j)->setY((i - _scroll) * (_font->getHeight() + _font->getSpacing()));
(*j)->blit(this);
}
}
}
/**
* Blits the text list and selector.
* @param surface Pointer to surface to blit onto.
*/
void TextList::blit(Surface *surface)
{
if (_visible && !_hidden)
{
_selector->blit(surface);
}
Surface::blit(surface);
if (_visible && !_hidden)
{
_up->blit(surface);
_down->blit(surface);
if (_arrowPos != -1)
{
for (unsigned int i = _scroll; i < _texts.size() && i < _scroll + _visibleRows; ++i)
{
_arrowLeft[i]->setY(getY() + (i - _scroll) * (_font->getHeight() + _font->getSpacing()));
_arrowLeft[i]->blit(surface);
_arrowRight[i]->setY(getY() + (i - _scroll) * (_font->getHeight() + _font->getSpacing()));
_arrowRight[i]->blit(surface);
}
}
}
}
/**
* Passes events to arrow buttons.
* @param action Pointer to an action.
* @param state State that the action handlers belong to.
*/
void TextList::handle(Action *action, State *state)
{
InteractiveSurface::handle(action, state);
_up->handle(action, state);
_down->handle(action, state);
if (_arrowPos != -1)
{
for (unsigned int i = _scroll; i < _texts.size() && i < _scroll + _visibleRows; ++i)
{
_arrowLeft[i]->handle(action, state);
_arrowRight[i]->handle(action, state);
}
}
}
/**
* Passes ticks to arrow buttons.
*/
void TextList::think()
{
InteractiveSurface::think();
_up->think();
_down->think();
for (std::vector<ArrowButton*>::iterator i = _arrowLeft.begin(); i < _arrowLeft.end(); ++i)
{
(*i)->think();
}
for (std::vector<ArrowButton*>::iterator i = _arrowRight.begin(); i < _arrowRight.end(); ++i)
{
(*i)->think();
}
}
/**
* Ignores any mouse clicks that aren't on a row with the left mouse button.
* @param action Pointer to an action.
* @param state State that the action handlers belong to.
*/
void TextList::mousePress(Action *action, State *state)
{
if (_selectable && action->getDetails()->button.button == SDL_BUTTON_LEFT)
{
if (_selRow < _texts.size())
{
InteractiveSurface::mousePress(action, state);
}
}
else if (action->getDetails()->button.button == SDL_BUTTON_WHEELUP)
{
scrollUp();
}
else if (action->getDetails()->button.button == SDL_BUTTON_WHEELDOWN)
{
scrollDown();
}
}
/*
* Ignores any mouse clicks that aren't on a row with the left mouse button.
* @param action Pointer to an action.
* @param state State that the action handlers belong to.
*/
void TextList::mouseRelease(Action *action, State *state)
{
if (_selectable && action->getDetails()->button.button == SDL_BUTTON_LEFT)
{
if (_selRow < _texts.size())
{
InteractiveSurface::mouseRelease(action, state);
}
}
}
/**
* Ignores any mouse clicks that aren't on a row with the left mouse button.
* @param action Pointer to an action.
* @param state State that the action handlers belong to.
*/
void TextList::mouseClick(Action *action, State *state)
{
if (_selectable && action->getDetails()->button.button == SDL_BUTTON_LEFT)
{
if (_selRow < _texts.size())
{
InteractiveSurface::mouseClick(action, state);
}
}
}
/**
* Selects the row the mouse is over.
* @param action Pointer to an action.
* @param state State that the action handlers belong to.
*/
void TextList::mouseOver(Action *action, State *state)
{
if (_selectable)
{
int h = _font->getHeight() + _font->getSpacing();
_selRow = _scroll + (int)floor(action->getRelativeYMouse() / (h * action->getYScale()));
if (_selRow < _texts.size())
{
_selector->setY(getY() + (_selRow - _scroll) * h);
_selector->copy(_bg);
if (_contrast)
_selector->offset(-10, 1);
else
_selector->offset(-10, Palette::backPos);
_selector->setVisible(true);
}
else
{
_selector->setVisible(false);
}
}
InteractiveSurface::mouseOver(action, state);
}
/**
* Deselects the row.
* @param action Pointer to an action.
* @param state State that the action handlers belong to.
*/
void TextList::mouseOut(Action *action, State *state)
{
if (_selectable)
{
_selector->setVisible(false);
}
InteractiveSurface::mouseOut(action, state);
}
}