3 * Copyright (C) 2010 Adam Williams <broadcast at earthling dot net>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "bcdragwindow.inc"
25 #include "bclistboxitem.inc"
26 #include "bcpixmap.inc"
27 #include "bcscrollbar.h"
28 #include "bcsubwindow.h"
32 #define BCPOPUPLISTBOX_W 25
33 #define BCPOPUPLISTBOX_H 25
36 #define MIN_COLUMN_WIDTH 10
39 class BC_ListBoxYScroll : public BC_ScrollBar
42 BC_ListBoxYScroll(BC_ListBox *listbox,
48 int update_length(int64_t length, int64_t position, int64_t handlelength, int flush);
53 class BC_ListBoxXScroll : public BC_ScrollBar
56 BC_ListBoxXScroll(BC_ListBox *listbox,
62 int update_length(int64_t length, int64_t position, int64_t handlelength, int flush);
67 class BC_ListBoxToggle
70 BC_ListBoxToggle(BC_ListBox *listbox,
75 int cursor_motion_event(int *redraw_toggles);
76 int cursor_leave_event(int *redraw_toggles);
77 int button_press_event();
78 int button_release_event(int *redraw_toggles);
79 void update(BC_ListBoxItem *item, int x, int y, int flash);
93 // Button pressed then moved out
99 class BC_ListBox : public BC_SubWindow
106 int display_format, // Display text list or icons
107 ArrayList<BC_ListBoxItem*> *data = 0, // Each column has an ArrayList of BC_ListBoxItems.
108 const char **column_titles = 0, // Titles for columns. Set to 0 for no titles
109 int *column_width = 0, // width of each column
110 int columns = 1, // Total columns. Only 1 in icon mode
111 int yposition = 0, // Pixel of top of window.
112 int is_popup = 0, // If this listbox is a popup window with a button
113 int selection_mode = LISTBOX_SINGLE, // Select one item or multiple items
114 int icon_position = ICON_LEFT, // Position of icon relative to text of each item
115 int allow_drag = 0); // Allow user to drag icons around
116 virtual ~BC_ListBox();
118 friend class BC_ListBoxToggle;
122 // User event handler for new selections
123 virtual int selection_changed() { return 0; };
124 // User event handler for triggering a selection
125 virtual int handle_event() { return 0; };
126 // User event handler for a column resize
127 virtual int column_resize_event() { return 0; };
128 // Draw background on bg_surface
129 virtual void draw_background();
130 // Draw on bg_surface
131 virtual int draw_images() { return 0; }
132 // Column sort order. This must return 1 or BC_ListBox will perform a default
134 virtual int sort_order_event() { return 0; };
136 virtual int move_column_event() { return 0; };
141 // Get the column movement
142 int get_from_column();
145 // Get the item in the given column which is the selection_number of the total
146 // selected rows. Returns 0 on failure.
147 BC_ListBoxItem* get_selection(int column, int selection_number);
148 BC_ListBoxItem* get_selection_recursive(ArrayList<BC_ListBoxItem*> *data,
150 int selection_number);
152 // Get the flat index of the item in the given column which is the selection_number
153 // of the total selected rows. Returns -1 on failure. The column
154 // argument is really useless because it only checks column 1 and returns the row
156 int get_selection_number(int column, int selection_number);
157 int get_selection_number_recursive(ArrayList<BC_ListBoxItem*> *data,
159 int selection_number,
162 virtual int evaluate_query(char *string);
163 void expand_item(BC_ListBoxItem *item, int expand);
164 // Collapse all items
165 static void collapse_recursive(ArrayList<BC_ListBoxItem*> *data,
167 // Convert recursive pointer to flat index.
168 // The pointer can be any item in the row corresponding to the index.
169 // Returns -1 if no item was found.
170 int item_to_index(ArrayList<BC_ListBoxItem*> *data,
171 BC_ListBoxItem *item,
173 // Convert flat index and column to desired item.
174 BC_ListBoxItem* index_to_item(ArrayList<BC_ListBoxItem*> *data,
178 // Get all items with recursion for text mode
179 static int get_total_items(ArrayList<BC_ListBoxItem*> *data,
180 int *result /* = 0 */,
183 virtual int focus_out_event();
184 virtual int keypress_event();
185 virtual int button_press_event();
186 virtual int button_release_event();
187 virtual int cursor_enter_event();
188 virtual int cursor_leave_event();
189 virtual int cursor_motion_event();
190 virtual int drag_start_event();
191 virtual int drag_motion_event();
192 virtual int drag_stop_event();
194 // After popping up a menu call this to interrupt the selection process
195 void deactivate_selection();
197 // take_focus - used by the suggestion box to keep it from taking focus from the
199 int activate(int take_focus = 1);
200 int activate(int x, int y, int w=-1, int h=-1);
204 int translation_event();
205 int repeat_event(int64_t duration);
206 BC_DragWindow* get_drag_popup();
207 // If the popup window should show a button.
208 // Must be called in the constructor.
209 void set_use_button(int value);
210 void set_is_suggestions(int value);
213 // change the contents
214 int update(ArrayList<BC_ListBoxItem*> *data,
215 const char **column_titles,
220 int highlighted_number = -1, // Flat index of item cursor is over
221 int recalc_positions = 0, // set all autoplace flags to 1
223 void center_selection();
224 void update_format(int display_format, int redraw);
227 // Allow scrolling when dragging items
228 void set_drag_scroll(int value);
229 // Allow column repositioning
230 void set_allow_drag_column(int value);
231 // Allow automatic moving of objects after drag
232 void set_process_drag(int value);
234 // Set the column to use for icons and sublists.
235 void set_master_column(int value, int redraw);
236 // Set column to search
237 void set_search_column(int value);
238 int set_selection_mode(int mode);
239 int set_yposition(int position, int draw_items = 1);
241 int set_xposition(int position);
243 // Return the flat index of the highlighted item
244 int get_highlighted_item();
247 int get_yscroll_height();
250 int get_xscroll_width();
251 int get_column_offset(int column);
252 int get_column_width(int column, int clamp_right = 0);
254 int get_display_mode();
255 void set_justify(int value);
256 int get_w() { return is_popup ? BCPOPUPLISTBOX_W : popup_w; }
257 int get_h() { return is_popup ? BCPOPUPLISTBOX_H : popup_h; }
258 int gui_tooltip(const char *text) {
259 return is_popup && gui ? gui->show_tooltip(text, gui->get_w(),0, -1,-1) : -1;
261 int get_view_w() { return view_w; }
262 int get_view_h() { return view_h; }
263 int get_row_height() { return row_height; }
264 int get_row_ascent() { return row_ascent; }
265 int get_row_descent() { return row_descent; }
266 int get_first_visible() { return first_in_view; }
267 int get_last_visible() { return last_in_view; }
276 int get_sort_column();
277 void set_sort_column(int value, int redraw = 0);
278 int get_sort_order();
279 void set_sort_order(int value, int redraw = 0);
283 int get_show_query() { return show_query; }
284 void set_show_query(int v) { show_query = v; }
286 int reposition_window(int x,
291 BC_Pixmap* get_bg_surface();
292 // Set all items for autoplacement with recursion into sublists
293 void set_autoplacement(ArrayList<BC_ListBoxItem*> *data,
296 // Set selection status on all items with recursion
297 void set_all_selected(ArrayList<BC_ListBoxItem*> *data, int value);
298 // Set selection status of single row with recursion
299 // item_number - the flat index of the row to select
300 void set_selected(ArrayList<BC_ListBoxItem*> *data,
305 // Called by keypress_event for cursor up. Selects previous and next visible
306 // row, skipping desired number of visible rows.
307 int select_previous(int skip,
308 BC_ListBoxItem *selected_item = 0,
310 ArrayList<BC_ListBoxItem*> *data = 0,
312 int *got_second = 0);
313 int select_next(int skip,
314 BC_ListBoxItem *selected_item = 0,
316 ArrayList<BC_ListBoxItem*> *data = 0,
318 int *got_second = 0);
320 // Called by cursor_motion_event to select different item if selection_number
321 // changed. Returns 1 if redraw is required.
322 int update_selection(ArrayList<BC_ListBoxItem*> *data,
323 int selection_number,
326 static void dump(ArrayList<BC_ListBoxItem*> *data,
328 int indent /* = 0 */,
331 int get_item_x(BC_ListBoxItem *item);
332 int get_item_y(BC_ListBoxItem *item);
333 int get_item_w(BC_ListBoxItem *item);
334 int get_item_h(BC_ListBoxItem *item);
336 // Draw the list items
337 int draw_items(int flash, int bg_draw=0);
340 void delete_columns();
341 void set_columns(const char **column_titles,
344 // Draw the button for a popup listbox
345 int draw_button(int flush);
347 int draw_border(int flash);
348 // Draw column titles
349 void draw_title(int number);
350 int draw_titles(int flash);
352 void draw_toggles(int flash);
353 // Draw selection rectangle
354 int draw_rectangle(int flash);
357 void draw_text_recursive(ArrayList<BC_ListBoxItem*> *data,
360 int *current_toggle);
361 // Returns 1 if selection changed
363 void init_column_width();
364 void reset_cursor(int new_cursor);
365 // Fix boundary conditions after resize
366 void column_width_boundaries();
367 // Recursive function to get the first item selected in text mode.
368 // Returns > -1 only if it got it. Always increments *result
369 int get_first_selection(ArrayList<BC_ListBoxItem*> *data, int *result = 0);
370 // Recursive function to get the last item selected in text mode.
371 // Returns > -1 only if it got it. Always increments *result
372 int get_last_selection(ArrayList<BC_ListBoxItem*> *data, int *result = 0);
373 // Called by button_press_event and cursor_motion_event to expand the selection.
374 // Returns 1 if redraw is required.
375 int expand_selection(int button_press, int selection_number);
376 // Called by button_press_event and cursor_motion_event
377 // to select a range in text mode
378 void select_range(ArrayList<BC_ListBoxItem*> *data,
382 // Called by button_press_event to toggle the selection status of a single item.
383 // Called for both text and icon mode. In text mode it's recursive and fills
384 // the entire row with the first item's value. Returns 1 when the item was toggled.
385 int toggle_item_selection(ArrayList<BC_ListBoxItem*> *data,
386 int selection_number,
388 // Set value of selected in all selected items to new value
389 void promote_selections(ArrayList<BC_ListBoxItem*> *data,
394 int test_column_divisions(int cursor_x, int cursor_y, int &new_cursor);
395 int test_column_titles(int cursor_x, int cursor_y);
396 int test_expanders();
398 int calculate_item_coords();
399 void calculate_last_coords_recursive(
400 ArrayList<BC_ListBoxItem*> *data,
406 void calculate_item_coords_recursive(
407 ArrayList<BC_ListBoxItem*> *data,
414 int get_items_width();
415 int get_items_height(ArrayList<BC_ListBoxItem*> *data,
418 int get_icon_w(BC_ListBoxItem *item);
419 int get_icon_h(BC_ListBoxItem *item);
420 int get_text_w(BC_ListBoxItem *item);
421 int get_text_h(BC_ListBoxItem *item);
422 int get_baseline(BC_ListBoxItem *item);
423 int get_item_highlight(ArrayList<BC_ListBoxItem*> *data, int column, int item);
424 int get_item_color(ArrayList<BC_ListBoxItem*> *data, int column, int item);
425 int get_icon_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
426 int get_text_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
427 // Copy sections of the bg_surface to the gui
428 void clear_listbox(int x, int y, int w, int h);
430 // Tests for cursor outside boundaries
431 int test_drag_scroll(int cursor_x, int cursor_y);
432 // Called by select_scroll_event, rectangle_scroll_event to execute for movement
433 int drag_scroll_event();
434 int select_scroll_event();
435 int rectangle_scroll_event();
438 void move_vertical(int pixels);
439 void move_horizontal(int pixels);
440 void clamp_positions();
442 int get_scrollbars();
443 void update_scrollbars(int flush);
445 // Flat index of the item the cursor is over.
446 // Points *item_return to the first item in the row or 0 if no item was found.
447 // if it's nonzero. Returns -1 if no item was found. Clamps the y coordinate
448 // only if the current operation is not SELECT, so scrolling is possible.
449 // expanded - 1 if items in this table should be tested for cursor coverage
450 int get_cursor_item(ArrayList<BC_ListBoxItem*> *data,
453 BC_ListBoxItem **item_return = 0,
456 // Select the items in the rectangle and deselect the items outside of it.
457 // Returns 1 if redraw is required.
458 int select_rectangle(ArrayList<BC_ListBoxItem*> *data,
463 // Convert the row of the item to a pointer.
464 BC_ListBoxItem* number_to_item(int row);
465 int reposition_item(ArrayList<BC_ListBoxItem*> *data,
466 int selection_number,
470 // Move selected items to src_items
471 void move_selection(ArrayList<BC_ListBoxItem*> *dst,
472 ArrayList<BC_ListBoxItem*> *src);
473 // Put items from the src table into the data table starting at flat item number
475 int put_selection(ArrayList<BC_ListBoxItem*> *data,
476 ArrayList<BC_ListBoxItem*> *src,
480 int center_selection(int selection,
481 ArrayList<BC_ListBoxItem*> *data = 0,
484 // Array of one list of pointers for each column
485 ArrayList<BC_ListBoxItem*> *data;
488 // 1 if a button is used to make the listbox display
489 int is_popup; // popup
490 // If the button for a popup should be shown
492 // background update needed
495 // Dimensions for a popup if there is one
496 int popup_w, popup_h;
497 // pixel of top of display relative to top of list
499 // pixel of left display relative to first column
501 // dimensions of a row in the list
502 int row_height, row_ascent, row_descent;
507 int temp_display_format;
509 // Scrollbars are created as needed
510 BC_ListBoxXScroll *xscrollbar;
511 BC_ListBoxYScroll *yscrollbar;
512 ArrayList<BC_ListBoxToggle*> expanders;
513 char query[BCTEXTLEN];
516 // Window containing the listbox
519 // Size of the popup if there is one
520 char **column_titles;
522 int default_column_width[1];
528 int first_in_view, last_in_view;
530 // Maximum width of items. Calculated by get_items_width
533 // In BCLISTBOX_SELECT mode determines the value to set items to
535 int need_xscroll, need_yscroll;
536 // Move items during drag operation of text items.
539 int allow_drag_scroll;
540 int allow_drag_column;
541 // Background color of listbox
546 BC_Pixmap *button_images[4];
548 BC_Pixmap *toggle_images[5];
549 // Background for drawing on
550 BC_Pixmap *bg_surface;
551 // Background if 9 segment
553 // Drag icon for text mode
554 VFrame *drag_icon_vframe;
556 VFrame *drag_column_icon_vframe;
557 // Background picon to be drawn in the upper right
558 BC_Pixmap *bg_pixmap;
561 // Column title backgrounds
562 BC_Pixmap *column_bg[3];
564 BC_Pixmap *column_sort_up;
565 BC_Pixmap *column_sort_dn;
570 // Number of column to sort
572 // Sort order. -1 means no column is being sorted.
579 // State of the list box and button when the mouse button is pressed.
580 int current_operation;
585 BUTTON_DOWN_SELECT, // Pressed button and slid off to select items.
587 DRAG_DIVISION, // Dragging column division
588 DRAG_COLUMN, // Dragging column
589 DRAG_ITEM, // Dragging item
590 SELECT, // Select item
591 SELECT_RECT, // Selection rectangle
592 WHEEL, // Wheel mouse
593 COLUMN_DN, // column title down
594 COLUMN_DRAG, // column title is being dragged
595 EXPAND_DN // Expander is down
599 // More state variables
600 int button_highlighted;
601 int list_highlighted;
602 // item cursor is over. May not exist in tables.
603 // Must be an index since this is needed to change the database.
604 int highlighted_item;
605 BC_ListBoxItem* highlighted_ptr;
606 // column title if the cursor is over a column title
607 int highlighted_title;
608 // Division the cursor is operating on when resizing
609 int highlighted_division;
610 // Column title being dragged
612 // start of column title drag
616 // Selection range being extended
617 int selection_start, selection_end, selection_center;
618 // Item being dragged or last item selected in a double click operation
619 int selection_number;
620 // Used in button_press_event and button_release_event to detect double clicks
621 int selection_number1, selection_number2;
627 // Popup listboxes have different behavior for suggestion boxes where the
628 // textbox needs to be active when the listbox is visible.
631 // Button release counter for double clicking
634 // Starting coordinates of rectangle
635 int rect_x1, rect_y1;
636 int rect_x2, rect_y2;
640 // Window for dragging
641 BC_DragWindow *drag_popup;