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,
52 class BC_ListBoxXScroll : public BC_ScrollBar
55 BC_ListBoxXScroll(BC_ListBox *listbox,
65 class BC_ListBoxToggle
68 BC_ListBoxToggle(BC_ListBox *listbox,
73 int cursor_motion_event(int *redraw_toggles);
74 int cursor_leave_event(int *redraw_toggles);
75 int button_press_event();
76 int button_release_event(int *redraw_toggles);
77 void update(BC_ListBoxItem *item, int x, int y, int flash);
91 // Button pressed then moved out
97 class BC_ListBox : public BC_SubWindow
104 int display_format, // Display text list or icons
105 ArrayList<BC_ListBoxItem*> *data = 0, // Each column has an ArrayList of BC_ListBoxItems.
106 const char **column_titles = 0, // Titles for columns. Set to 0 for no titles
107 int *column_width = 0, // width of each column
108 int columns = 1, // Total columns. Only 1 in icon mode
109 int yposition = 0, // Pixel of top of window.
110 int is_popup = 0, // If this listbox is a popup window with a button
111 int selection_mode = LISTBOX_SINGLE, // Select one item or multiple items
112 int icon_position = ICON_LEFT, // Position of icon relative to text of each item
113 int allow_drag = 0); // Allow user to drag icons around
114 virtual ~BC_ListBox();
116 friend class BC_ListBoxToggle;
120 // User event handler for new selections
121 virtual int selection_changed() { return 0; };
122 // User event handler for triggering a selection
123 virtual int handle_event() { return 0; };
124 // User event handler for a column resize
125 virtual int column_resize_event() { return 0; };
126 // Draw background on bg_surface
127 virtual void draw_background();
128 // Draw on bg_surface
129 virtual int draw_images() { return 0; }
130 // Column sort order. This must return 1 or BC_ListBox will perform a default
132 virtual int sort_order_event() { return 0; };
134 virtual int move_column_event() { return 0; };
139 // Get the column movement
140 int get_from_column();
143 // Get the item in the given column which is the selection_number of the total
144 // selected rows. Returns 0 on failure.
145 BC_ListBoxItem* get_selection(int column, int selection_number);
146 BC_ListBoxItem* get_selection_recursive(ArrayList<BC_ListBoxItem*> *data,
148 int selection_number);
150 // Get the flat index of the item in the given column which is the selection_number
151 // of the total selected rows. Returns -1 on failure. The column
152 // argument is really useless because it only checks column 1 and returns the row
154 int get_selection_number(int column, int selection_number);
155 int get_selection_number_recursive(ArrayList<BC_ListBoxItem*> *data,
157 int selection_number,
160 virtual int evaluate_query(char *string);
161 void expand_item(BC_ListBoxItem *item, int expand);
162 // Collapse all items
163 static void collapse_recursive(ArrayList<BC_ListBoxItem*> *data,
165 // Convert recursive pointer to flat index.
166 // The pointer can be any item in the row corresponding to the index.
167 // Returns -1 if no item was found.
168 int item_to_index(ArrayList<BC_ListBoxItem*> *data,
169 BC_ListBoxItem *item,
171 // Convert flat index and column to desired item.
172 BC_ListBoxItem* index_to_item(ArrayList<BC_ListBoxItem*> *data,
176 // Get all items with recursion for text mode
177 static int get_total_items(ArrayList<BC_ListBoxItem*> *data,
178 int *result /* = 0 */,
181 virtual int focus_out_event();
182 virtual int keypress_event();
183 virtual int button_press_event();
184 virtual int button_release_event();
185 virtual int cursor_enter_event();
186 virtual int cursor_leave_event();
187 virtual int cursor_motion_event();
188 virtual int drag_start_event();
189 virtual int drag_motion_event();
190 virtual int drag_stop_event();
192 // After popping up a menu call this to interrupt the selection process
193 void deactivate_selection();
195 // take_focus - used by the suggestion box to keep it from taking focus from the
197 int activate(int take_focus = 1);
198 int activate(int x, int y, int w=-1, int h=-1);
202 int translation_event();
203 int repeat_event(int64_t duration);
204 BC_DragWindow* get_drag_popup();
205 // If the popup window should show a button.
206 // Must be called in the constructor.
207 void set_use_button(int value);
208 void set_is_suggestions(int value);
211 // change the contents
212 int update(ArrayList<BC_ListBoxItem*> *data,
213 const char **column_titles,
218 int highlighted_number = -1, // Flat index of item cursor is over
219 int recalc_positions = 0, // set all autoplace flags to 1
221 void center_selection();
222 void update_format(int display_format, int redraw);
225 // Allow scrolling when dragging items
226 void set_drag_scroll(int value);
227 // Allow column repositioning
228 void set_allow_drag_column(int value);
229 // Allow automatic moving of objects after drag
230 void set_process_drag(int value);
232 // Set the column to use for icons and sublists.
233 void set_master_column(int value, int redraw);
234 // Set column to search
235 void set_search_column(int value);
236 int set_selection_mode(int mode);
237 int set_yposition(int position, int draw_items = 1);
239 int set_xposition(int position);
241 // Return the flat index of the highlighted item
242 int get_highlighted_item();
245 int get_yscroll_height();
248 int get_xscroll_width();
249 int get_column_offset(int column);
250 int get_column_width(int column, int clamp_right = 0);
252 int get_display_mode();
253 void set_justify(int value);
254 int get_w() { return is_popup ? BCPOPUPLISTBOX_W : popup_w; }
255 int get_h() { return is_popup ? BCPOPUPLISTBOX_H : popup_h; }
256 int get_view_w() { return view_w; }
257 int get_view_h() { return view_h; }
258 int get_row_height() { return row_height; }
259 int get_row_ascent() { return row_ascent; }
260 int get_row_descent() { return row_descent; }
261 int get_first_visible() { return first_in_view; }
262 int get_last_visible() { return last_in_view; }
271 int get_sort_column();
272 void set_sort_column(int value, int redraw = 0);
273 int get_sort_order();
274 void set_sort_order(int value, int redraw = 0);
278 int reposition_window(int x,
283 BC_Pixmap* get_bg_surface();
284 // Set all items for autoplacement with recursion into sublists
285 void set_autoplacement(ArrayList<BC_ListBoxItem*> *data,
288 // Set selection status on all items with recursion
289 void set_all_selected(ArrayList<BC_ListBoxItem*> *data, int value);
290 // Set selection status of single row with recursion
291 // item_number - the flat index of the row to select
292 void set_selected(ArrayList<BC_ListBoxItem*> *data,
297 // Called by keypress_event for cursor up. Selects previous and next visible
298 // row, skipping desired number of visible rows.
299 int select_previous(int skip,
300 BC_ListBoxItem *selected_item = 0,
302 ArrayList<BC_ListBoxItem*> *data = 0,
304 int *got_second = 0);
305 int select_next(int skip,
306 BC_ListBoxItem *selected_item = 0,
308 ArrayList<BC_ListBoxItem*> *data = 0,
310 int *got_second = 0);
312 // Called by cursor_motion_event to select different item if selection_number
313 // changed. Returns 1 if redraw is required.
314 int update_selection(ArrayList<BC_ListBoxItem*> *data,
315 int selection_number,
318 static void dump(ArrayList<BC_ListBoxItem*> *data,
320 int indent /* = 0 */,
323 int get_item_x(BC_ListBoxItem *item);
324 int get_item_y(BC_ListBoxItem *item);
325 int get_item_w(BC_ListBoxItem *item);
326 int get_item_h(BC_ListBoxItem *item);
328 // Draw the list items
329 int draw_items(int flash, int bg_draw=0);
332 void delete_columns();
333 void set_columns(const char **column_titles,
336 // Draw the button for a popup listbox
337 int draw_button(int flush);
339 int draw_border(int flash);
340 // Draw column titles
341 void draw_title(int number);
342 int draw_titles(int flash);
344 void draw_toggles(int flash);
345 // Draw selection rectangle
346 int draw_rectangle(int flash);
349 void draw_text_recursive(ArrayList<BC_ListBoxItem*> *data,
352 int *current_toggle);
353 // Returns 1 if selection changed
355 void init_column_width();
356 void reset_cursor(int new_cursor);
357 // Fix boundary conditions after resize
358 void column_width_boundaries();
359 // Recursive function to get the first item selected in text mode.
360 // Returns > -1 only if it got it. Always increments *result
361 int get_first_selection(ArrayList<BC_ListBoxItem*> *data, int *result = 0);
362 // Recursive function to get the last item selected in text mode.
363 // Returns > -1 only if it got it. Always increments *result
364 int get_last_selection(ArrayList<BC_ListBoxItem*> *data, int *result = 0);
365 // Called by button_press_event and cursor_motion_event to expand the selection.
366 // Returns 1 if redraw is required.
367 int expand_selection(int button_press, int selection_number);
368 // Called by button_press_event and cursor_motion_event
369 // to select a range in text mode
370 void select_range(ArrayList<BC_ListBoxItem*> *data,
374 // Called by button_press_event to toggle the selection status of a single item.
375 // Called for both text and icon mode. In text mode it's recursive and fills
376 // the entire row with the first item's value. Returns 1 when the item was toggled.
377 int toggle_item_selection(ArrayList<BC_ListBoxItem*> *data,
378 int selection_number,
380 // Set value of selected in all selected items to new value
381 void promote_selections(ArrayList<BC_ListBoxItem*> *data,
386 int test_column_divisions(int cursor_x, int cursor_y, int &new_cursor);
387 int test_column_titles(int cursor_x, int cursor_y);
388 int test_expanders();
390 int calculate_item_coords();
391 void calculate_last_coords_recursive(
392 ArrayList<BC_ListBoxItem*> *data,
398 void calculate_item_coords_recursive(
399 ArrayList<BC_ListBoxItem*> *data,
406 int get_items_width();
407 int get_items_height(ArrayList<BC_ListBoxItem*> *data,
410 int get_icon_w(BC_ListBoxItem *item);
411 int get_icon_h(BC_ListBoxItem *item);
412 int get_text_w(BC_ListBoxItem *item);
413 int get_text_h(BC_ListBoxItem *item);
414 int get_baseline(BC_ListBoxItem *item);
415 int get_item_highlight(ArrayList<BC_ListBoxItem*> *data, int column, int item);
416 int get_item_color(ArrayList<BC_ListBoxItem*> *data, int column, int item);
417 int get_icon_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
418 int get_text_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
419 // Copy sections of the bg_surface to the gui
420 void clear_listbox(int x, int y, int w, int h);
422 // Tests for cursor outside boundaries
423 int test_drag_scroll(int cursor_x, int cursor_y);
424 // Called by select_scroll_event, rectangle_scroll_event to execute for movement
425 int drag_scroll_event();
426 int select_scroll_event();
427 int rectangle_scroll_event();
430 void move_vertical(int pixels);
431 void move_horizontal(int pixels);
432 void clamp_positions();
434 int get_scrollbars();
435 void update_scrollbars(int flush);
437 // Flat index of the item the cursor is over.
438 // Points *item_return to the first item in the row or 0 if no item was found.
439 // if it's nonzero. Returns -1 if no item was found. Clamps the y coordinate
440 // only if the current operation is not SELECT, so scrolling is possible.
441 // expanded - 1 if items in this table should be tested for cursor coverage
442 int get_cursor_item(ArrayList<BC_ListBoxItem*> *data,
445 BC_ListBoxItem **item_return = 0,
448 // Select the items in the rectangle and deselect the items outside of it.
449 // Returns 1 if redraw is required.
450 int select_rectangle(ArrayList<BC_ListBoxItem*> *data,
455 // Convert the row of the item to a pointer.
456 BC_ListBoxItem* number_to_item(int row);
457 int reposition_item(ArrayList<BC_ListBoxItem*> *data,
458 int selection_number,
462 // Move selected items to src_items
463 void move_selection(ArrayList<BC_ListBoxItem*> *dst,
464 ArrayList<BC_ListBoxItem*> *src);
465 // Put items from the src table into the data table starting at flat item number
467 int put_selection(ArrayList<BC_ListBoxItem*> *data,
468 ArrayList<BC_ListBoxItem*> *src,
472 int center_selection(int selection,
473 ArrayList<BC_ListBoxItem*> *data = 0,
476 // Array of one list of pointers for each column
477 ArrayList<BC_ListBoxItem*> *data;
480 // 1 if a button is used to make the listbox display
481 int is_popup; // popup
482 // If the button for a popup should be shown
484 // background update needed
487 // Dimensions for a popup if there is one
488 int popup_w, popup_h;
489 // pixel of top of display relative to top of list
491 // pixel of left display relative to first column
493 // dimensions of a row in the list
494 int row_height, row_ascent, row_descent;
499 int temp_display_format;
501 // Scrollbars are created as needed
502 BC_ListBoxXScroll *xscrollbar;
503 BC_ListBoxYScroll *yscrollbar;
504 ArrayList<BC_ListBoxToggle*> expanders;
505 char query[BCTEXTLEN];
508 // Window containing the listbox
511 // Size of the popup if there is one
512 char **column_titles;
514 int default_column_width[1];
520 int first_in_view, last_in_view;
522 // Maximum width of items. Calculated by get_items_width
525 // In BCLISTBOX_SELECT mode determines the value to set items to
527 int need_xscroll, need_yscroll;
528 // Move items during drag operation of text items.
531 int allow_drag_scroll;
532 int allow_drag_column;
533 // Background color of listbox
539 BC_Pixmap *button_images[4];
541 BC_Pixmap *toggle_images[5];
542 // Background for drawing on
543 BC_Pixmap *bg_surface;
544 // Background if 9 segment
546 // Drag icon for text mode
547 VFrame *drag_icon_vframe;
549 VFrame *drag_column_icon_vframe;
550 // Background picon to be drawn in the upper right
551 BC_Pixmap *bg_pixmap;
554 // Column title backgrounds
555 BC_Pixmap *column_bg[3];
557 BC_Pixmap *column_sort_up;
558 BC_Pixmap *column_sort_dn;
563 // Number of column to sort
565 // Sort order. -1 means no column is being sorted.
572 // State of the list box and button when the mouse button is pressed.
573 int current_operation;
578 BUTTON_DOWN_SELECT, // Pressed button and slid off to select items.
580 DRAG_DIVISION, // Dragging column division
581 DRAG_COLUMN, // Dragging column
582 DRAG_ITEM, // Dragging item
583 SELECT, // Select item
584 SELECT_RECT, // Selection rectangle
585 WHEEL, // Wheel mouse
586 COLUMN_DN, // column title down
587 COLUMN_DRAG, // column title is being dragged
588 EXPAND_DN // Expander is down
592 // More state variables
593 int button_highlighted;
594 int list_highlighted;
595 // item cursor is over. May not exist in tables.
596 // Must be an index since this is needed to change the database.
597 int highlighted_item;
598 BC_ListBoxItem* highlighted_ptr;
599 // column title if the cursor is over a column title
600 int highlighted_title;
601 // Division the cursor is operating on when resizing
602 int highlighted_division;
603 // Column title being dragged
605 // start of column title drag
609 // Selection range being extended
610 int selection_start, selection_end, selection_center;
611 // Item being dragged or last item selected in a double click operation
612 int selection_number;
613 // Used in button_press_event and button_release_event to detect double clicks
614 int selection_number1, selection_number2;
620 // Popup listboxes have different behavior for suggestion boxes where the
621 // textbox needs to be active when the listbox is visible.
624 // Button release counter for double clicking
627 // Starting coordinates of rectangle
628 int rect_x1, rect_y1;
629 int rect_x2, rect_y2;
633 // Window for dragging
634 BC_DragWindow *drag_popup;