2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/UI/LISTBOX.cpp $
15 * Code to implement a listbox gadget.
18 * Revision 1.5 2004/09/20 01:31:45 theoddone33
21 * Revision 1.4 2004/07/04 11:39:06 taylor
22 * fix missing debrief text, crash on exit, path separator's, warning fixes, no GR_SOFT
24 * Revision 1.3 2002/06/09 04:41:29 relnev
25 * added copyright header
27 * Revision 1.2 2002/05/07 03:16:53 theoddone33
28 * The Great Newline Fix
30 * Revision 1.1.1.1 2002/05/03 03:28:11 root
34 * 4 12/02/98 5:47p Dave
35 * Put in interface xstr code. Converted barracks screen to new format.
37 * 3 10/13/98 9:29a Dave
38 * Started neatening up freespace.h. Many variables renamed and
39 * reorganized. Added AlphaColors.[h,cpp]
41 * 2 10/07/98 10:54a Dave
44 * 1 10/07/98 10:51a Dave
46 * 20 3/23/98 5:48p Hoffoss
47 * Improved listbox handling. Most notibly the scrollbar arrows work now.
49 * 19 2/03/98 4:21p Hoffoss
50 * Made UI controls draw white text when disabled.
52 * 18 1/20/98 10:36a Hoffoss
53 * Fixed optimized warnings.
55 * 17 1/14/98 6:43p Hoffoss
56 * Massive changes to UI code. A lot cleaner and better now. Did all
57 * this to get the new UI_DOT_SLIDER to work properly, which the old code
58 * wasn't flexible enough to handle.
60 * 16 9/18/97 10:31p Lawrance
61 * allow listbox to change text
63 * 15 9/09/97 4:32p Dave
64 * Added sel_changed() function to UI_LISTBOX to check is the selection
67 * 14 9/09/97 3:39p Sandeep
68 * warning level 4 bugs
70 * 13 8/19/97 1:27p Dave
71 * Made it possible to create an empty list box and summarily add items.
73 * 12 8/14/97 5:23p Dave
74 * Added clear_all_items() to the UI_LISTBOX
76 * 11 6/26/97 5:53p Lawrance
77 * change code slightly, so current_item is not forced to 0 when was -1
79 * 10 6/12/97 12:39p John
80 * made ui use freespace colors
82 * 9 6/11/97 1:13p John
83 * Started fixing all the text colors in the game.
85 * 8 5/26/97 10:26a Lawrance
86 * get slider control working 100%
88 * 7 4/22/97 10:11a John
89 * Added checkbox lists to listboxes
91 * 6 4/15/97 3:47p Allender
92 * moved type selection of list box items into actual UI code. Made it
93 * behave more like windows listboxes do
95 * 5 12/23/96 2:42p Lawrance
96 * allowing keys to select list box items in the mission load screen
98 * 4 12/02/96 2:17p John
99 * Made right button drag UI gadgets around and
100 * Ctrl+Shift+Alt+F12 dumps out where they are.
102 * 3 12/01/96 3:48a Lawrance
103 * added function set_current to UI_LISTBOX
105 * 2 11/15/96 11:43a John
107 * 1 11/14/96 6:55p John
116 #include "alphacolors.h"
119 #define KEY_BUFFER_TIMEOUT 1000 // time to clear buffer in milliseconds
121 #define DEFAULT_LISTBOX_ITEM_LENGTH 40
123 // --------------------------------------------------------------------
124 // UI_LISTBOX::link_hotspot
127 void UI_LISTBOX::link_hotspot(int up_button_num, int down_button_num)
129 scrollbar.link_hotspot(up_button_num,down_button_num);
132 // --------------------------------------------------------------------
133 // UI_LISTBOX::set_bmaps
135 // Call the UI_SCROLLBAR::set_bmaps() function for the scroll bar gadget.
137 // returns: -1 ==> error
140 int UI_LISTBOX::set_bmaps(const char *lbox_fname, const char *b_up_fname, const char *b_down_fname, const char *sb_fname)
143 scrollbar.set_bmaps(b_up_fname, b_down_fname, sb_fname);
146 // set the bitmaps for the list box rectangle
147 UI_GADGET::set_bmaps(lbox_fname);
152 void UI_LISTBOX::create(UI_WINDOW *wnd, int _x, int _y, int _w, int _h, int _numitems, char **_list, char *_check_list, int _max_items)
157 gr_set_font(wnd->f_id);
158 gr_get_string_size(&tw, &th, "*");
163 base_create( wnd, UI_KIND_LISTBOX, _x, _y, _w, real_h );
165 max_items = _max_items;
167 num_items = _numitems;
168 check_list = _check_list;
169 num_items_displayed = nrows;
178 key_buffer_count = 0;
179 last_typed = timer_get_milliseconds();
181 if (_numitems > nrows) {
182 scrollbar.create( wnd, _x+_w+3, _y, real_h, 0, _numitems-nrows, 0, nrows );
183 scrollbar.set_parent(this);
191 void UI_LISTBOX::draw()
197 gr_set_font(my_wnd->f_id);
201 if ( bmap_ids[LBOX_DISABLED] >= 0 ) {
202 gr_set_bitmap(bmap_ids[LBOX_DISABLED], GR_ALPHABLEND_NONE, GR_BITBLT_MODE_NORMAL, 1.0f, -1, -1);
207 if ( bmap_ids[LBOX_NORMAL] >= 0 ) {
208 gr_set_bitmap(bmap_ids[LBOX_NORMAL], GR_ALPHABLEND_NONE, GR_BITBLT_MODE_NORMAL, 1.0f, -1, -1);
214 gr_set_color_fast(&CBLACK);
215 gr_set_clip( x, y, w, h );
216 ui_rect( 0, 0, w-1, h-1 );
219 ui_draw_sunken_border( x-2, y-2, x+w+scrollbar.w+4, y+h+1 );
222 ui_draw_sunken_border( x-2, y-2, x+w+4, y+h+1 );
226 stop = first_item+num_items_displayed;
227 if (stop>num_items) stop = num_items;
230 gr_set_clip( x, y, w, h );
232 for ( i=first_item; i<stop; i++ ) {
233 gr_get_string_size( &w1, &h1,list[i] );
238 if (i !=current_item) {
240 if ((current_item == -1) && (my_wnd->selected_gadget == this ) && (i == first_item) ) {
242 gr_set_color_fast( &CBLACK );
243 gr_rect( x1, y1, w1+2, h1 );
245 current_item = first_item;
246 gr_set_color_fast( &CBRIGHT_GREEN );
249 gr_set_color_fast( &CBLACK );
250 gr_rect( x1, y1, w1+2, h1 );
252 gr_set_color_fast( &CWHITE );
256 gr_set_color_fast( &CBLACK );
257 gr_rect( x1, y1, w1+2, h1 );
260 gr_set_color_fast(&CWHITE);
263 if (my_wnd->selected_gadget == this) {
264 gr_set_color_fast( &CGRAY );
265 gr_rect( x1, y1, w1+2, h1 );
266 gr_set_color_fast( &CBRIGHT_GREEN );
269 gr_set_color_fast( &CGRAY );
270 gr_rect( x1, y1, w1+2, h1 );
271 gr_set_color_fast( &CBLACK );
276 if ( check_list[i] ) {
277 gr_string( x1+2, y1, "X" );
280 gr_string( x1+16, y1, list[i] );
283 gr_string( x1+2, y1, list[i] );
286 gr_set_color_fast( &CGRAY );
288 gr_set_color_fast( &CBLACK );
291 ui_rect( x1+w1+2, y1, w-1, y1+h1-1 );
292 ui_rect( x1, y1, x1+1, y1+h1-1 );
298 if (stop < num_items_displayed-1 && !uses_bmaps) {
299 gr_set_color_fast(&CBLACK);
300 ui_rect( x1, y1, w-1, h-1 );
304 void UI_LISTBOX::process(int focus)
306 int OnMe, mitem, kf = 0;
315 if (my_wnd->selected_gadget == this)
319 scrollbar.process(0);
320 if (my_wnd->selected_gadget == &scrollbar) {
329 old_current_item = current_item;
330 old_first_item = first_item;
332 // if (my_wnd->selected_gadget == this) {
333 // my_wnd->selected_gadget == get_next();
339 old_current_item = current_item;
340 old_first_item = first_item;
342 OnMe = is_mouse_on();
345 if (scrollbar.moved) {
346 first_item = scrollbar.position;
347 SDL_assert(first_item >= 0);
349 if (current_item<first_item)
350 current_item = first_item;
352 if (current_item > first_item + num_items_displayed - 1)
353 current_item = first_item + num_items_displayed - 1;
360 if (B1_PRESSED && OnMe) {
365 if ( key_buffer_count && (timer_get_milliseconds() > last_typed + KEY_BUFFER_TIMEOUT) )
366 key_buffer_count = 0;
369 if (my_wnd->keypress) {
372 switch (my_wnd->keypress) {
374 selected_item = current_item;
378 toggled_item = current_item;
397 current_item=num_items - 1;
402 current_item -= num_items_displayed;
407 current_item += num_items_displayed;
411 default: // enter the key in the key buffer
412 if (my_wnd->keypress == SDLK_BACKSPACE) {
413 key_buffer_count = 0;
415 } else if (key_buffer_count < MAX_KEY_BUFFER) {
416 key_buffer[key_buffer_count++] = (char) my_wnd->keypress_text;
417 last_typed = timer_get_milliseconds();
420 if (!key_buffer_count)
423 for (i=0; i<num_items; i++) {
426 current_text = get_string(i);
427 for (j=0; j<key_buffer_count; j++)
428 if (current_text[j] != key_buffer[j]) {
432 if (j == key_buffer_count) {
433 set_first_item(i - num_items_displayed / 2);
442 if (current_item < 0)
445 if (current_item >= num_items)
446 current_item = num_items - 1;
448 if (current_item < first_item)
449 first_item = current_item;
451 if (current_item >= first_item + num_items_displayed)
452 first_item = current_item - num_items_displayed + 1;
454 if (num_items <= num_items_displayed ) {
459 scrollbar.position = first_item;
461 scrollbar.bar_position = scrollbar.position - scrollbar.start;
462 scrollbar.bar_position *= scrollbar.h - scrollbar.bar_size;
463 scrollbar.bar_position /= scrollbar.stop - scrollbar.start;
465 if (scrollbar.bar_position < 0) {
466 scrollbar.bar_position = 0;
469 if (scrollbar.bar_position > scrollbar.h - scrollbar.bar_size) {
470 scrollbar.bar_position = scrollbar.h - scrollbar.bar_size;
479 if (B1_PRESSED && dragging) {
483 mitem = (ui_mouse.y - y)/textheight;
485 if ( (mitem < 0) && (timer_get_milliseconds() > last_scrolled + 1000 / 18) ) {
487 last_scrolled = timer_get_milliseconds();
490 if ( (mitem >= num_items_displayed) && (timer_get_milliseconds() > last_scrolled + 1000 / 18) ) {
492 last_scrolled = timer_get_milliseconds();
495 if ((mitem >= 0) && (mitem<num_items_displayed)) {
496 current_item = mitem + first_item;
499 if (current_item < 0)
502 if (current_item >= num_items)
503 current_item = num_items - 1;
505 if (current_item < first_item)
506 first_item = current_item;
508 if (current_item >= first_item + num_items_displayed)
509 first_item = current_item - num_items_displayed + 1;
511 if (num_items <= num_items_displayed) {
514 } else if (has_scrollbar) {
515 scrollbar.position = first_item;
517 scrollbar.bar_position = scrollbar.position - scrollbar.start;
518 scrollbar.bar_position *= scrollbar.h - scrollbar.bar_size;
519 scrollbar.bar_position /= scrollbar.stop - scrollbar.start;
521 if (scrollbar.bar_position < 0) {
522 scrollbar.bar_position = 0;
525 if (scrollbar.bar_position > scrollbar.h - scrollbar.bar_size) {
526 scrollbar.bar_position = scrollbar.h - scrollbar.bar_size;
532 if (B1_JUST_RELEASED)
533 toggled_item = current_item;
536 if (B1_DOUBLE_CLICKED) {
537 selected_item = current_item;
542 int UI_LISTBOX::toggled()
551 int UI_LISTBOX::selected()
556 return selected_item;
560 int UI_LISTBOX::current()
565 void UI_LISTBOX::set_current(int _index)
567 current_item = _index;
570 void UI_LISTBOX::set_first_item(int _index)
574 else if (_index > num_items)
580 char *UI_LISTBOX::get_string(int _index)
585 void UI_LISTBOX::clear_all_items()
589 for ( idx=0; idx<num_items; idx++ )
596 void UI_LISTBOX::set_new_list(int _numitems, char **_list)
598 num_items = _numitems;
603 int UI_LISTBOX::add_string(char *str)
605 if (max_items < 0) // only if we created an "empty" listbox can we add items
609 if ( (num_items == max_items - 1) || (strlen(str) > DEFAULT_LISTBOX_ITEM_LENGTH) )
610 return 0; // we've reached our limit
613 list[num_items] = strdup(str);
620 int UI_LISTBOX::sel_changed()
622 return old_current_item == current_item ? 0 : 1;