1
/* gui_list.c - GUI component to display a selectable list of items. */
3
* GRUB -- GRand Unified Bootloader
4
* Copyright (C) 2008,2009 Free Software Foundation, Inc.
6
* GRUB is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation, either version 3 of the License, or
9
* (at your option) any later version.
11
* GRUB is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with GRUB. If not, see <http://www.gnu.org/licenses/>.
21
#include <grub/misc.h>
23
#include <grub/gui_string_util.h>
24
#include <grub/gfxmenu_view.h>
25
#include <grub/gfxwidgets.h>
27
struct grub_gui_list_impl
29
struct grub_gui_list list;
31
grub_gui_container_t parent;
32
grub_video_rect_t bounds;
42
grub_font_t item_font;
43
grub_font_t selected_item_font;
44
grub_gui_color_t item_color;
45
int selected_item_color_set;
46
grub_gui_color_t selected_item_color;
49
int need_to_recreate_scrollbar;
50
char *scrollbar_frame_pattern;
51
char *scrollbar_thumb_pattern;
52
grub_gfxmenu_box_t scrollbar_frame;
53
grub_gfxmenu_box_t scrollbar_thumb;
56
int first_shown_index;
58
int need_to_recreate_boxes;
60
char *menu_box_pattern;
61
char *selected_item_box_pattern;
62
grub_gfxmenu_box_t menu_box;
63
grub_gfxmenu_box_t selected_item_box;
65
grub_gfxmenu_icon_manager_t icon_manager;
67
grub_gfxmenu_view_t view;
70
typedef struct grub_gui_list_impl *list_impl_t;
73
list_destroy (void *vself)
75
list_impl_t self = vself;
77
grub_free (self->theme_dir);
78
grub_free (self->menu_box_pattern);
79
grub_free (self->selected_item_box_pattern);
81
self->menu_box->destroy (self->menu_box);
82
if (self->selected_item_box)
83
self->selected_item_box->destroy (self->selected_item_box);
84
if (self->icon_manager)
85
grub_gfxmenu_icon_manager_destroy (self->icon_manager);
91
get_num_shown_items (list_impl_t self)
93
int boxpad = self->item_padding;
94
int item_vspace = self->item_spacing;
95
int item_height = self->item_height;
97
grub_gfxmenu_box_t box = self->menu_box;
98
int box_top_pad = box->get_top_pad (box);
99
int box_bottom_pad = box->get_bottom_pad (box);
101
return (self->bounds.height + item_vspace - 2 * boxpad
102
- box_top_pad - box_bottom_pad) / (item_height + item_vspace);
106
check_boxes (list_impl_t self)
108
if (self->need_to_recreate_boxes)
110
grub_gui_recreate_box (&self->menu_box,
111
self->menu_box_pattern,
114
grub_gui_recreate_box (&self->selected_item_box,
115
self->selected_item_box_pattern,
118
self->need_to_recreate_boxes = 0;
121
return (self->menu_box != 0 && self->selected_item_box != 0);
125
check_scrollbar (list_impl_t self)
127
if (self->need_to_recreate_scrollbar)
129
grub_gui_recreate_box (&self->scrollbar_frame,
130
self->scrollbar_frame_pattern,
133
grub_gui_recreate_box (&self->scrollbar_thumb,
134
self->scrollbar_thumb_pattern,
137
self->need_to_recreate_scrollbar = 0;
140
return (self->scrollbar_frame != 0 && self->scrollbar_thumb != 0);
144
list_get_id (void *vself)
146
list_impl_t self = vself;
151
list_is_instance (void *vself __attribute__((unused)), const char *type)
153
return (grub_strcmp (type, "component") == 0
154
|| grub_strcmp (type, "list") == 0);
157
static struct grub_video_bitmap *
158
get_item_icon (list_impl_t self, int item_index)
160
grub_menu_entry_t entry;
161
entry = grub_menu_get_entry (self->view->menu, item_index);
165
return grub_gfxmenu_icon_manager_get_icon (self->icon_manager, entry);
169
make_selected_item_visible (list_impl_t self)
171
int selected_index = self->view->selected;
172
if (selected_index < 0)
173
return; /* No item is selected. */
174
int num_shown_items = get_num_shown_items (self);
175
int last_shown_index = self->first_shown_index + (num_shown_items - 1);
176
if (selected_index < self->first_shown_index)
177
self->first_shown_index = selected_index;
178
else if (selected_index > last_shown_index)
179
self->first_shown_index = selected_index - (num_shown_items - 1);
182
/* Draw a scrollbar on the menu. */
184
draw_scrollbar (list_impl_t self,
185
int value, int extent, int min, int max,
186
int rightx, int topy, int height)
188
grub_gfxmenu_box_t frame = self->scrollbar_frame;
189
grub_gfxmenu_box_t thumb = self->scrollbar_thumb;
190
int frame_vertical_pad = (frame->get_top_pad (frame)
191
+ frame->get_bottom_pad (frame));
192
int frame_horizontal_pad = (frame->get_left_pad (frame)
193
+ frame->get_right_pad (frame));
194
int tracktop = topy + frame->get_top_pad (frame);
195
int tracklen = height - frame_vertical_pad;
196
frame->set_content_size (frame, self->scrollbar_width, tracklen);
197
int thumby = tracktop + tracklen * (value - min) / (max - min);
198
int thumbheight = tracklen * extent / (max - min) + 1;
199
thumb->set_content_size (thumb,
200
self->scrollbar_width - frame_horizontal_pad,
201
thumbheight - (thumb->get_top_pad (thumb)
202
+ thumb->get_bottom_pad (thumb)));
204
rightx - (self->scrollbar_width + frame_horizontal_pad),
207
rightx - (self->scrollbar_width - frame->get_right_pad (frame)),
211
/* Draw the list of items. */
213
draw_menu (list_impl_t self, int num_shown_items)
215
if (! self->menu_box || ! self->selected_item_box)
218
int boxpad = self->item_padding;
219
int icon_text_space = self->item_icon_space;
220
int item_vspace = self->item_spacing;
222
int ascent = grub_font_get_ascent (self->item_font);
223
int descent = grub_font_get_descent (self->item_font);
224
int item_height = self->item_height;
226
make_selected_item_visible (self);
228
grub_gfxmenu_box_t selbox = self->selected_item_box;
229
int sel_leftpad = selbox->get_left_pad (selbox);
230
int sel_toppad = selbox->get_top_pad (selbox);
231
int item_top = sel_toppad;
234
struct grub_video_rect oviewport;
236
grub_video_get_viewport (&oviewport.x, &oviewport.y,
237
&oviewport.width, &oviewport.height);
238
grub_video_set_viewport (oviewport.x + boxpad,
239
oviewport.y + boxpad,
240
oviewport.width - 2 * boxpad,
241
oviewport.height - 2 * boxpad);
243
for (visible_index = 0, menu_index = self->first_shown_index;
244
visible_index < num_shown_items && menu_index < self->view->menu->size;
245
visible_index++, menu_index++)
247
int is_selected = (menu_index == self->view->selected);
251
selbox->set_content_size (selbox, oviewport.width - 2 * boxpad - 2,
253
selbox->draw (selbox, 0,
254
item_top - sel_toppad);
257
struct grub_video_bitmap *icon;
258
if ((icon = get_item_icon (self, menu_index)) != 0)
259
grub_video_blit_bitmap (icon, GRUB_VIDEO_BLIT_BLEND,
261
item_top + (item_height - self->icon_height) / 2,
262
0, 0, self->icon_width, self->icon_height);
264
const char *item_title =
265
grub_menu_get_entry (self->view->menu, menu_index)->title;
267
(is_selected && self->selected_item_font
268
? self->selected_item_font
270
grub_gui_color_t text_color =
271
((is_selected && self->selected_item_color_set)
272
? self->selected_item_color
274
grub_font_draw_string (item_title,
276
grub_gui_map_color (text_color),
277
sel_leftpad + self->icon_width + icon_text_space,
278
(item_top + (item_height - (ascent + descent))
281
item_top += item_height + item_vspace;
283
grub_video_set_viewport (oviewport.x,
290
list_paint (void *vself, const grub_video_rect_t *region)
292
list_impl_t self = vself;
293
grub_video_rect_t vpsave;
297
if (!grub_video_have_common_points (region, &self->bounds))
302
if (! self->menu_box || ! self->selected_item_box)
305
grub_gui_set_viewport (&self->bounds, &vpsave);
307
grub_gfxmenu_box_t box = self->menu_box;
308
int box_left_pad = box->get_left_pad (box);
309
int box_top_pad = box->get_top_pad (box);
310
int box_right_pad = box->get_right_pad (box);
311
int box_bottom_pad = box->get_bottom_pad (box);
312
grub_video_rect_t vpsave2, content_rect;
313
int num_shown_items = get_num_shown_items (self);
314
int drawing_scrollbar = (self->draw_scrollbar
315
&& (num_shown_items < self->view->menu->size)
316
&& check_scrollbar (self));
318
content_rect.x = box_left_pad;
319
content_rect.y = box_top_pad;
320
content_rect.width = self->bounds.width - box_left_pad - box_right_pad;
321
content_rect.height = self->bounds.height - box_top_pad - box_bottom_pad;
323
box->set_content_size (box, content_rect.width, content_rect.height);
325
box->draw (box, 0, 0);
327
grub_gui_set_viewport (&content_rect, &vpsave2);
328
draw_menu (self, num_shown_items);
329
grub_gui_restore_viewport (&vpsave2);
331
if (drawing_scrollbar)
332
draw_scrollbar (self,
333
self->first_shown_index, num_shown_items,
334
0, self->view->menu->size,
335
self->bounds.width - box_right_pad
336
+ self->scrollbar_width,
338
self->bounds.height - box_top_pad - box_bottom_pad);
341
grub_gui_restore_viewport (&vpsave);
345
list_set_parent (void *vself, grub_gui_container_t parent)
347
list_impl_t self = vself;
348
self->parent = parent;
351
static grub_gui_container_t
352
list_get_parent (void *vself)
354
list_impl_t self = vself;
359
list_set_bounds (void *vself, const grub_video_rect_t *bounds)
361
list_impl_t self = vself;
362
self->bounds = *bounds;
366
list_get_bounds (void *vself, grub_video_rect_t *bounds)
368
list_impl_t self = vself;
369
*bounds = self->bounds;
373
list_get_minimal_size (void *vself, unsigned *width, unsigned *height)
375
list_impl_t self = vself;
377
if (check_boxes (self))
379
int boxpad = self->item_padding;
380
int item_vspace = self->item_spacing;
381
int item_height = self->item_height;
384
grub_gfxmenu_box_t box = self->menu_box;
385
int box_left_pad = box->get_left_pad (box);
386
int box_top_pad = box->get_top_pad (box);
387
int box_right_pad = box->get_right_pad (box);
388
int box_bottom_pad = box->get_bottom_pad (box);
391
grub_gfxmenu_box_t selbox = self->selected_item_box;
392
int sel_toppad = selbox->get_top_pad (selbox);
394
*width = grub_font_get_string_width (self->item_font, "Typical OS");
395
width_s = grub_font_get_string_width (self->selected_item_font,
397
if (*width < width_s)
400
*width += 2 * boxpad + box_left_pad + box_right_pad;
402
/* Set the menu box height to fit the items. */
403
*height = (item_height * num_items
404
+ item_vspace * (num_items - 1)
406
+ box_top_pad + box_bottom_pad + sel_toppad);
416
list_set_property (void *vself, const char *name, const char *value)
418
list_impl_t self = vself;
419
if (grub_strcmp (name, "item_font") == 0)
421
self->item_font = grub_font_get (value);
423
else if (grub_strcmp (name, "selected_item_font") == 0)
425
if (! value || grub_strcmp (value, "inherit") == 0)
426
self->selected_item_font = 0;
428
self->selected_item_font = grub_font_get (value);
430
else if (grub_strcmp (name, "item_color") == 0)
432
grub_gui_parse_color (value, &self->item_color);
434
else if (grub_strcmp (name, "selected_item_color") == 0)
436
if (! value || grub_strcmp (value, "inherit") == 0)
438
self->selected_item_color_set = 0;
442
if (grub_gui_parse_color (value, &self->selected_item_color)
444
self->selected_item_color_set = 1;
447
else if (grub_strcmp (name, "icon_width") == 0)
449
self->icon_width = grub_strtol (value, 0, 10);
450
grub_gfxmenu_icon_manager_set_icon_size (self->icon_manager,
454
else if (grub_strcmp (name, "icon_height") == 0)
456
self->icon_height = grub_strtol (value, 0, 10);
457
grub_gfxmenu_icon_manager_set_icon_size (self->icon_manager,
461
else if (grub_strcmp (name, "item_height") == 0)
463
self->item_height = grub_strtol (value, 0, 10);
465
else if (grub_strcmp (name, "item_padding") == 0)
467
self->item_padding = grub_strtol (value, 0, 10);
469
else if (grub_strcmp (name, "item_icon_space") == 0)
471
self->item_icon_space = grub_strtol (value, 0, 10);
473
else if (grub_strcmp (name, "item_spacing") == 0)
475
self->item_spacing = grub_strtol (value, 0, 10);
477
else if (grub_strcmp (name, "visible") == 0)
479
self->visible = grub_strcmp (value, "false") != 0;
481
else if (grub_strcmp (name, "menu_pixmap_style") == 0)
483
self->need_to_recreate_boxes = 1;
484
grub_free (self->menu_box_pattern);
485
self->menu_box_pattern = value ? grub_strdup (value) : 0;
487
else if (grub_strcmp (name, "selected_item_pixmap_style") == 0)
489
self->need_to_recreate_boxes = 1;
490
grub_free (self->selected_item_box_pattern);
491
self->selected_item_box_pattern = value ? grub_strdup (value) : 0;
493
else if (grub_strcmp (name, "scrollbar_frame") == 0)
495
self->need_to_recreate_scrollbar = 1;
496
grub_free (self->scrollbar_frame_pattern);
497
self->scrollbar_frame_pattern = value ? grub_strdup (value) : 0;
499
else if (grub_strcmp (name, "scrollbar_thumb") == 0)
501
self->need_to_recreate_scrollbar = 1;
502
grub_free (self->scrollbar_thumb_pattern);
503
self->scrollbar_thumb_pattern = value ? grub_strdup (value) : 0;
505
else if (grub_strcmp (name, "scrollbar_width") == 0)
507
self->scrollbar_width = grub_strtol (value, 0, 10);
509
else if (grub_strcmp (name, "scrollbar") == 0)
511
self->draw_scrollbar = grub_strcmp (value, "false") != 0;
513
else if (grub_strcmp (name, "theme_dir") == 0)
515
self->need_to_recreate_boxes = 1;
516
grub_free (self->theme_dir);
517
self->theme_dir = value ? grub_strdup (value) : 0;
519
else if (grub_strcmp (name, "id") == 0)
521
grub_free (self->id);
523
self->id = grub_strdup (value);
530
/* Set necessary information that the gfxmenu view provides. */
532
list_set_view_info (void *vself,
533
grub_gfxmenu_view_t view)
535
list_impl_t self = vself;
536
grub_gfxmenu_icon_manager_set_theme_path (self->icon_manager,
541
static struct grub_gui_component_ops list_comp_ops =
543
.destroy = list_destroy,
544
.get_id = list_get_id,
545
.is_instance = list_is_instance,
547
.set_parent = list_set_parent,
548
.get_parent = list_get_parent,
549
.set_bounds = list_set_bounds,
550
.get_bounds = list_get_bounds,
551
.get_minimal_size = list_get_minimal_size,
552
.set_property = list_set_property
555
static struct grub_gui_list_ops list_ops =
557
.set_view_info = list_set_view_info
561
grub_gui_list_new (void)
564
grub_font_t default_font;
565
grub_gui_color_t default_fg_color;
566
grub_gui_color_t default_bg_color;
568
self = grub_zalloc (sizeof (*self));
572
self->list.ops = &list_ops;
573
self->list.component.ops = &list_comp_ops;
577
default_font = grub_font_get ("Unknown Regular 16");
578
default_fg_color = grub_gui_color_rgb (0, 0, 0);
579
default_bg_color = grub_gui_color_rgb (255, 255, 255);
581
self->icon_width = 32;
582
self->icon_height = 32;
583
self->item_height = 42;
584
self->item_padding = 14;
585
self->item_icon_space = 4;
586
self->item_spacing = 16;
587
self->item_font = default_font;
588
self->selected_item_font = 0; /* Default to using the item_font. */
589
self->item_color = default_fg_color;
590
self->selected_item_color_set = 0; /* Default to using the item_color. */
591
self->selected_item_color = default_fg_color;
593
self->draw_scrollbar = 1;
594
self->need_to_recreate_scrollbar = 1;
595
self->scrollbar_frame = 0;
596
self->scrollbar_thumb = 0;
597
self->scrollbar_frame_pattern = 0;
598
self->scrollbar_thumb_pattern = 0;
599
self->scrollbar_width = 16;
601
self->first_shown_index = 0;
603
self->need_to_recreate_boxes = 0;
605
self->menu_box_pattern = 0;
606
self->selected_item_box_pattern = 0;
607
self->menu_box = grub_gfxmenu_create_box (0, 0);
608
self->selected_item_box = grub_gfxmenu_create_box (0, 0);
610
self->icon_manager = grub_gfxmenu_icon_manager_new ();
611
if (! self->icon_manager)
613
self->list.component.ops->destroy (self);
616
grub_gfxmenu_icon_manager_set_icon_size (self->icon_manager,
619
return (grub_gui_component_t) self;