-
-
Notifications
You must be signed in to change notification settings - Fork 992
/
styled_widget.cpp
731 lines (603 loc) · 21.2 KB
/
styled_widget.cpp
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
/*
Copyright (C) 2008 - 2017 by Mark de Wever <koraq@xs4all.nl>
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
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.
See the COPYING file for more details.
*/
#define GETTEXT_DOMAIN "wesnoth-lib"
#include "gui/widgets/styled_widget.hpp"
#include "formula/string_utils.hpp"
#include "gui/auxiliary/iterator/walker_widget.hpp"
#include "gui/core/log.hpp"
#include "gui/core/event/message.hpp"
#include "gui/dialogs/tooltip.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/window.hpp"
#include "hotkey/hotkey_item.hpp"
#include "formatter.hpp"
#include "gettext.hpp"
#include "sdl/rect.hpp"
#include "wml_exception.hpp"
#include "utils/functional.hpp"
#include <algorithm>
#include <iomanip>
#define LOG_SCOPE_HEADER \
"styled_widget(" + get_control_type() + ") [" + id() + "] " + __func__
#define LOG_HEADER LOG_SCOPE_HEADER + ':'
namespace gui2
{
// ------------ WIDGET -----------{
styled_widget::styled_widget()
: definition_("default")
, label_()
, use_markup_(false)
, use_tooltip_on_label_overflow_(true)
, tooltip_()
, help_message_()
, canvas_()
, config_(nullptr)
, renderer_()
, text_maximum_width_(0)
, text_alignment_(PANGO_ALIGN_LEFT)
, text_ellipse_mode_(PANGO_ELLIPSIZE_END)
, shrunken_(false)
{
connect_signal<event::SHOW_TOOLTIP>(std::bind(
&styled_widget::signal_handler_show_tooltip, this, _2, _3, _5));
connect_signal<event::SHOW_HELPTIP>(std::bind(
&styled_widget::signal_handler_show_helptip, this, _2, _3, _5));
connect_signal<event::NOTIFY_REMOVE_TOOLTIP>(std::bind(
&styled_widget::signal_handler_notify_remove_tooltip, this, _2, _3));
}
styled_widget::styled_widget(const implementation::builder_styled_widget& builder,
const std::string& control_type)
: widget(builder)
, definition_(builder.definition)
, label_(builder.label_string)
, use_markup_(false)
, use_tooltip_on_label_overflow_(builder.use_tooltip_on_label_overflow)
, tooltip_(builder.tooltip)
, help_message_(builder.help)
, canvas_()
, config_(nullptr)
, renderer_()
, text_maximum_width_(0)
, text_alignment_(PANGO_ALIGN_LEFT)
, text_ellipse_mode_(PANGO_ELLIPSIZE_END)
, shrunken_(false)
{
definition_load_configuration(control_type);
connect_signal<event::SHOW_TOOLTIP>(std::bind(
&styled_widget::signal_handler_show_tooltip, this, _2, _3, _5));
connect_signal<event::SHOW_HELPTIP>(std::bind(
&styled_widget::signal_handler_show_helptip, this, _2, _3, _5));
connect_signal<event::NOTIFY_REMOVE_TOOLTIP>(std::bind(
&styled_widget::signal_handler_notify_remove_tooltip, this, _2, _3));
}
void styled_widget::set_members(const string_map& data)
{
/** @todo document this feature on the wiki. */
/** @todo do we need to add the debug colors here as well? */
string_map::const_iterator itor = data.find("id");
if(itor != data.end()) {
set_id(itor->second);
}
itor = data.find("linked_group");
if(itor != data.end()) {
set_linked_group(itor->second);
}
itor = data.find("label");
if(itor != data.end()) {
set_label(itor->second);
}
itor = data.find("tooltip");
if(itor != data.end()) {
set_tooltip(itor->second);
}
itor = data.find("help");
if(itor != data.end()) {
set_help_message(itor->second);
}
itor = data.find("use_markup");
if(itor != data.end()) {
set_use_markup(utils::string_bool(itor->second));
}
itor = data.find("text_alignment");
if(itor != data.end()) {
set_text_alignment(decode_text_alignment(itor->second));
}
}
bool styled_widget::disable_click_dismiss() const
{
return get_visible() == widget::visibility::visible && get_active();
}
iteration::walker_base* styled_widget::create_walker()
{
return new iteration::walker::widget(*this);
}
point styled_widget::get_config_minimum_size() const
{
assert(config_);
point result(config_->min_width, config_->min_height);
DBG_GUI_L << LOG_HEADER << " result " << result << ".\n";
return result;
}
point styled_widget::get_config_default_size() const
{
assert(config_);
point result(config_->default_width, config_->default_height);
DBG_GUI_L << LOG_HEADER << " result " << result << ".\n";
return result;
}
point styled_widget::get_config_maximum_size() const
{
assert(config_);
point result(config_->max_width, config_->max_height);
DBG_GUI_L << LOG_HEADER << " result " << result << ".\n";
return result;
}
unsigned styled_widget::get_characters_per_line() const
{
return 0;
}
bool styled_widget::get_link_aware() const
{
return false;
}
color_t styled_widget::get_link_color() const
{
return color_t::from_hex_string("ffff00");
}
void styled_widget::layout_initialize(const bool full_initialization)
{
// Inherited.
widget::layout_initialize(full_initialization);
if(full_initialization) {
shrunken_ = false;
}
}
void styled_widget::request_reduce_width(const unsigned maximum_width)
{
assert(config_);
if(!label_.empty() && can_wrap()) {
point size = get_best_text_size(
point(), point(maximum_width - config_->text_extra_width, 0));
size.x += config_->text_extra_width;
size.y += config_->text_extra_height;
set_layout_size(size);
DBG_GUI_L << LOG_HEADER << " label '" << debug_truncate(label_)
<< "' maximum_width " << maximum_width << " result " << size
<< ".\n";
} else if(label_.empty() || text_can_shrink()) {
point size = get_best_size();
point min_size = get_config_minimum_size();
size.x = std::min(size.x, std::max<int>(maximum_width, min_size.x));
set_layout_size(size);
DBG_GUI_L << LOG_HEADER << " styled_widget " << id()
<< " maximum_width " << maximum_width << " result " << size
<< ".\n";
} else {
DBG_GUI_L << LOG_HEADER << " label '" << debug_truncate(label_)
<< "' failed; either no label or wrapping not allowed.\n";
}
}
void styled_widget::request_reduce_height(const unsigned maximum_height)
{
if(!label_.empty()) {
// Do nothing
} else {
point size = get_best_size();
point min_size = get_config_minimum_size();
size.y = std::min(size.y, std::max<int>(maximum_height, min_size.y));
set_layout_size(size);
DBG_GUI_L << LOG_HEADER << " styled_widget " << id()
<< " maximum_height " << maximum_height << " result " << size
<< ".\n";
}
}
point styled_widget::calculate_best_size() const
{
assert(config_);
if(label_.empty()) {
DBG_GUI_L << LOG_HEADER << " empty label return default.\n";
return get_config_default_size();
}
const point minimum = get_config_default_size();
const point maximum = get_config_maximum_size();
/**
* @todo The value send should subtract the border size
* and read it after calculation to get the proper result.
*/
point result = get_best_text_size(minimum, maximum);
DBG_GUI_L << LOG_HEADER << " label '" << debug_truncate(label_)
<< "' result " << result << ".\n";
return result;
}
void styled_widget::place(const point& origin, const point& size)
{
// resize canvasses
for(auto & canvas : canvas_)
{
canvas.set_width(size.x);
canvas.set_height(size.y);
}
// Note we assume that the best size has been queried but otherwise it
// should return false.
if(renderer_.is_truncated() && use_tooltip_on_label_overflow_
&& tooltip_.empty()) {
set_tooltip(label_);
}
// inherited
widget::place(origin, size);
// update the state of the canvas after the sizes have been set.
update_canvas();
}
void styled_widget::load_config()
{
if(!config()) {
definition_load_configuration(get_control_type());
load_config_extra();
}
}
widget* styled_widget::find_at(const point& coordinate, const bool must_be_active)
{
return (widget::find_at(coordinate, must_be_active)
&& (!must_be_active || get_active()))
? this
: nullptr;
}
const widget* styled_widget::find_at(const point& coordinate,
const bool must_be_active) const
{
return (widget::find_at(coordinate, must_be_active)
&& (!must_be_active || get_active()))
? this
: nullptr;
}
widget* styled_widget::find(const std::string& id, const bool must_be_active)
{
return (widget::find(id, must_be_active)
&& (!must_be_active || get_active()))
? this
: nullptr;
}
const widget* styled_widget::find(const std::string& id, const bool must_be_active)
const
{
return (widget::find(id, must_be_active)
&& (!must_be_active || get_active()))
? this
: nullptr;
}
void styled_widget::set_definition(const std::string& definition)
{
assert(!config());
definition_ = definition;
load_config();
assert(config());
#ifdef GUI2_EXPERIMENTAL_LISTBOX
init();
#endif
}
void styled_widget::set_label(const t_string& label)
{
if(label == label_) {
return;
}
label_ = label;
set_layout_size(point());
update_canvas();
}
void styled_widget::set_use_markup(bool use_markup)
{
if(use_markup == use_markup_) {
return;
}
use_markup_ = use_markup;
update_canvas();
}
void styled_widget::set_text_alignment(const PangoAlignment text_alignment)
{
if(text_alignment_ == text_alignment) {
return;
}
text_alignment_ = text_alignment;
update_canvas();
}
void styled_widget::set_text_ellipse_mode(const PangoEllipsizeMode ellipse_mode)
{
if(text_ellipse_mode_ == ellipse_mode) {
return;
}
text_ellipse_mode_ = ellipse_mode;
update_canvas();
}
void styled_widget::update_canvas()
{
const int max_width = get_text_maximum_width();
const int max_height = get_text_maximum_height();
// set label in canvases
for(auto & canvas : canvas_)
{
canvas.set_variable("text", wfl::variant(label_));
canvas.set_variable("text_markup", wfl::variant(use_markup_));
canvas.set_variable("text_link_aware", wfl::variant(get_link_aware()));
// Possible TODO: Consider making a formula_callable for colours
color_t link_color = get_link_color();
std::vector<wfl::variant> link_color_as_list{wfl::variant(link_color.r), wfl::variant(link_color.g), wfl::variant(link_color.b), wfl::variant(link_color.a)};
canvas.set_variable("text_link_color", wfl::variant(link_color_as_list));
canvas.set_variable("text_alignment",
wfl::variant(encode_text_alignment(text_alignment_)));
canvas.set_variable("text_maximum_width", wfl::variant(max_width));
canvas.set_variable("text_maximum_height", wfl::variant(max_height));
canvas.set_variable("text_wrap_mode", wfl::variant(get_text_ellipse_mode()));
canvas.set_variable("text_characters_per_line",
wfl::variant(get_characters_per_line()));
}
}
int styled_widget::get_text_maximum_width() const
{
assert(config_);
return text_maximum_width_ != 0 ? text_maximum_width_
: get_width() - config_->text_extra_width;
}
int styled_widget::get_text_maximum_height() const
{
assert(config_);
return get_height() - config_->text_extra_height;
}
void styled_widget::impl_draw_background(surface& /*frame_buffer*/,
int x_offset,
int y_offset)
{
DBG_GUI_D << LOG_HEADER << " label '" << debug_truncate(label_) << "' size "
<< get_rectangle() << ".\n";
get_canvas(get_state()).render(calculate_blitting_rectangle(x_offset, y_offset));
}
void styled_widget::impl_draw_foreground(surface& /*frame_buffer*/
,
int /*x_offset*/
,
int /*y_offset*/)
{
/* DO NOTHING */
}
void styled_widget::definition_load_configuration(const std::string& control_type)
{
assert(!config_);
set_config(get_control(control_type, definition_));
/**
* Fill in each canvas from the widget state definitons.
*
* Most widgets have a single canvas. However, some widgets such as toggle_panel
* and toggle_button have a variable canvas count determined by their definitions.
*/
for(const auto& widget_state : config_->state) {
canvas_.emplace_back(std::move(widget_state.canvas_));
}
update_canvas();
}
point styled_widget::get_best_text_size(point minimum_size,
point maximum_size) const
{
log_scope2(log_gui_layout, LOG_SCOPE_HEADER);
assert(!label_.empty());
const point border(config_->text_extra_width, config_->text_extra_height);
point size = minimum_size - border;
renderer_.set_link_aware(get_link_aware())
.set_link_color(get_link_color());
renderer_.set_text(label_, use_markup_);
renderer_.set_family_class(config_->text_font_family);
renderer_.set_font_size(config_->text_font_size);
renderer_.set_font_style(config_->text_font_style);
renderer_.set_alignment(text_alignment_);
// Try with the minimum wanted size.
const int maximum_width = text_maximum_width_ != 0 ? text_maximum_width_
: maximum_size.x;
renderer_.set_maximum_width(maximum_width);
renderer_.set_ellipse_mode(get_text_ellipse_mode());
renderer_.set_characters_per_line(get_characters_per_line());
if(get_characters_per_line() != 0 && !can_wrap()) {
WRN_GUI_L
<< LOG_HEADER << " Limited the number of characters per line, "
<< "but wrapping is not set, output may not be as expected.\n";
}
DBG_GUI_L << LOG_HEADER << " label '" << debug_truncate(label_)
<< "' status: "
<< " minimum_size " << minimum_size << " maximum_size "
<< maximum_size << " text_maximum_width_ " << text_maximum_width_
<< " can_wrap " << can_wrap() << " characters_per_line "
<< get_characters_per_line() << " truncated "
<< renderer_.is_truncated() << " renderer size "
<< renderer_.get_size() << ".\n";
// If doesn't fit try the maximum.
if(renderer_.is_truncated() && !can_wrap()) {
// FIXME if maximum size is defined we should look at that
// but also we don't adjust for the extra text space yet!!!
maximum_size = point(config_->max_width, config_->max_height);
renderer_.set_maximum_width(maximum_size.x ? maximum_size.x - border.x
: -1);
}
size = renderer_.get_size() + border;
if(size.x < minimum_size.x) {
size.x = minimum_size.x;
}
if(size.y < minimum_size.y) {
size.y = minimum_size.y;
}
DBG_GUI_L << LOG_HEADER << " label '" << debug_truncate(label_)
<< "' result " << size << ".\n";
return size;
}
void styled_widget::signal_handler_show_tooltip(const event::ui_event event,
bool& handled,
const point& location)
{
DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";
if(!tooltip_.empty()) {
std::string tip = tooltip_;
if(!help_message_.empty()) {
utils::string_map symbols;
symbols["hotkey"] = hotkey::get_names(
hotkey::hotkey_command::get_command_by_command(
hotkey::GLOBAL__HELPTIP).command);
tip = tooltip_ + utils::interpolate_variables_into_string(
settings::has_helptip_message, &symbols);
}
event::message_show_tooltip message(tip, location, get_rectangle());
handled = fire(event::MESSAGE_SHOW_TOOLTIP, *this, message);
}
}
void styled_widget::signal_handler_show_helptip(const event::ui_event event,
bool& handled,
const point& location)
{
DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";
if(!help_message_.empty()) {
event::message_show_helptip message(help_message_, location, get_rectangle());
handled = fire(event::MESSAGE_SHOW_HELPTIP, *this, message);
}
}
void styled_widget::signal_handler_notify_remove_tooltip(const event::ui_event event,
bool& handled)
{
DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";
/*
* This makes the class know the tip code rather intimately. An
* alternative is to add a message to the window to remove the tip.
* Might be done later.
*/
dialogs::tip::remove();
handled = true;
}
std::string styled_widget::get_label_token(const gui2::point & position, const char * delim) const
{
return renderer_.get_token(position, delim);
}
std::string styled_widget::get_label_link(const gui2::point & position) const
{
return renderer_.get_link(position);
}
// }---------- BUILDER -----------{
/*WIKI
* @page = GUIWidgetInstanceWML
* @order = 1_widget
*
* = Widget =
* @begin{parent}{name="generic/"}
* @begin{tag}{name="widget_instance"}{min="0"}{max="-1"}
* All widgets placed in the cell have some values in common:
* @begin{table}{config}
* id & string & "" & This value is used for the engine to
* identify 'special' items. This means that
* for example a text_box can get the proper
* initial value. This value should be
* unique or empty. Those special values are
* documented at the window definition that
* uses them. NOTE items starting with an
* underscore are used for composed widgets
* and these should be unique per composed
* widget. $
*
* definition & string & "default" &
* The id of the widget definition to use.
* This way it's possible to select a
* specific version of the widget e.g. a
* title label when the label is used as
* title. $
*
* linked_group & string & "" & The linked group the styled_widget belongs
* to. $
*
* label & t_string & "" & Most widgets have some text associated
* with them, this field contain the value
* of that text. Some widgets use this value
* for other purposes, this is documented
* at the widget. E.g. an image uses the
* filename in this field. $
*
* tooltip & t_string & "" & If you hover over a widget a while (the
* time it takes can differ per widget) a
* short help can show up.This defines the
* text of that message. This field may not
* be empty when 'help' is set. $
*
*
* help & t_string & "" & If you hover over a widget and press F10
* (or the key the user defined for the help
* tip) a help message can show up. This
* help message might be the same as the
* tooltip but in general (if used) this
* message should show more help. This
* defines the text of that message. $
*
* use_tooltip_on_label_overflow & bool & true &
* If the text on the label is truncated and
* the tooltip is empty the label can be
* used for the tooltip. If this variable is
* set to true this will happen. $
*
* debug_border_mode & unsigned & 0 &
* The mode for showing the debug border.
* This border shows the area reserved for
* a widget. This function is only meant
* for debugging and might not be
* available in all Wesnoth binaries.
* Available modes:
* @* 0 no border.
* @* 1 1 pixel border.
* @* 2 floodfill the widget area. $
*
* debug_border_color & color & "" & The color of the debug border. $
* @end{table}
* @end{tag}{name="widget_instance"}
* @end{parent}{name="generic/"}
*/
namespace implementation
{
builder_styled_widget::builder_styled_widget(const config& cfg)
: builder_widget(cfg)
, definition(cfg["definition"])
, label_string(cfg["label"].t_str())
, tooltip(cfg["tooltip"].t_str())
, help(cfg["help"].t_str())
, use_tooltip_on_label_overflow(true)
, use_markup(cfg["use_markup"].to_bool(false))
{
if(definition.empty()) {
definition = "default";
}
VALIDATE_WITH_DEV_MESSAGE(
help.empty() || !tooltip.empty(),
_("Found a widget with a helptip and without a tooltip."),
formatter() << "id '" << id << "' label '" << label_string
<< "' helptip '" << help << "'.");
DBG_GUI_P << "Window builder: found styled_widget with id '" << id
<< "' and definition '" << definition << "'.\n";
}
void builder_styled_widget::init_control(styled_widget* control) const
{
assert(control);
control->set_id(id);
control->set_definition(definition);
control->set_linked_group(linked_group);
control->set_label(label_string);
control->set_tooltip(tooltip);
control->set_help_message(help);
control->set_use_tooltip_on_label_overflow(use_tooltip_on_label_overflow);
control->set_use_markup(use_markup);
control->set_debug_border_mode(debug_border_mode);
control->set_debug_border_color(debug_border_color);
}
widget* builder_styled_widget::build(const replacements_map& /*replacements*/) const
{
return build();
}
} // namespace implementation
// }------------ END --------------
} // namespace gui2