cinelerra-5.1/guicast/bclistbox.h

   1 /*
   2  * CINELERRA
   3  * Copyright (C) 2010 Adam Williams <broadcast at earthling dot net>
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  *
  19  */
  20
  21 #ifndef BCLISTBOX_H
  22 #define BCLISTBOX_H
  23
  24 #include "bcdragwindow.inc"
  25 #include "bclistboxitem.inc"
  26 #include "bcpixmap.inc"
  27 #include "bcscrollbar.h"
  28 #include "bcsubwindow.h"
  29 #include "bctoggle.h"
  30 #include "bccolors.h"
  31
  32 #define BCPOPUPLISTBOX_W 25
  33 #define BCPOPUPLISTBOX_H 25
  34
  35 class BC_ListBoxYScroll;
  36 class BC_ListBoxXScroll;
  37 class BC_ListBoxToggle;
  38 class BC_ListBox;
  39
  40 #define MIN_COLUMN_WIDTH 10
  41
  42
  43 class BC_ListBoxYScroll : public BC_ScrollBar
  44 {
  45         BC_ListBox *listbox;
  46 public:
  47         BC_ListBoxYScroll(BC_ListBox *listbox);
  48         ~BC_ListBoxYScroll();
  49         int handle_event();
  50 };
  51
  52 class BC_ListBoxXScroll : public BC_ScrollBar
  53 {
  54         BC_ListBox *listbox;
  55 public:
  56         BC_ListBoxXScroll(BC_ListBox *listbox);
  57         ~BC_ListBoxXScroll();
  58         int handle_event();
  59 };
  60
  61 class BC_ListBoxToggle
  62 {
  63 public:
  64         BC_ListBoxToggle(BC_ListBox *listbox, BC_ListBoxItem *item, int x, int y);
  65
  66         int cursor_motion_event(int *redraw_toggles);
  67         int cursor_leave_event(int *redraw_toggles);
  68         int button_press_event();
  69         int button_release_event(int *redraw_toggles);
  70         void update(BC_ListBoxItem *item, int x, int y, int flash);
  71         void draw(int flash);
  72
  73         BC_ListBox *listbox;
  74         BC_ListBoxItem *item;
  75         int x, y;
  76         int value, state;
  77         enum
  78         {
  79                 TOGGLE_UP,
  80                 TOGGLE_UPHI,
  81                 TOGGLE_CHECKED,
  82                 TOGGLE_DOWN,
  83                 TOGGLE_CHECKEDHI,
  84 // Button pressed then moved out
  85                 TOGGLE_DOWN_EXIT
  86         };
  87 };
  88
  89
  90 class BC_ListBox : public BC_SubWindow
  91 {
  92         friend class BC_ListBoxYScroll;
  93         friend class BC_ListBoxXScroll;
  94         friend class BC_ListBoxToggle;
  95 public:
  96         BC_ListBox(int x, int y, int w, int h,
  97                 int display_format,                   // Display text list or icons
  98                 ArrayList<BC_ListBoxItem*> *data = 0, // Each column has an ArrayList of BC_ListBoxItems.
  99                 const char **column_titles = 0,             // Titles for columns.  Set to 0 for no titles
 100                 int *column_width = 0,                // width of each column
 101                 int columns = 1,                      // Total columns.  Only 1 in icon mode
 102                 int yposition = 0,                    // Pixel of top of window.
 103                 int is_popup = 0,                     // If this listbox is a popup window with a button
 104                 int selection_mode = LISTBOX_SINGLE,  // Select one item or multiple items
 105                 int icon_position = ICON_LEFT,        // Position of icon relative to text of each item
 106                 int allow_drag = 0);                  // Allow user to drag icons around
 107         virtual ~BC_ListBox();
 108
 109         int initialize();
 110
 111 // User event handler for new selections
 112         virtual int selection_changed() { return 0; };
 113 // User event handler for triggering a selection
 114         virtual int handle_event() { return 0; };
 115 // User event handler for a column resize
 116         virtual int column_resize_event() { return 0; };
 117 // Draw background on bg_surface
 118         virtual void draw_background();
 119 // Draw on bg_surface
 120         virtual int draw_images() { return 0; }
 121 // Column sort order.  This must return 1 or BC_ListBox will perform a default
 122 // action.
 123         virtual int sort_order_event() { return 0; };
 124 // Column moved
 125         virtual int move_column_event() { return 0; };
 126 // item highlight changed
 127         virtual int mouse_over_event(int no) { return 0; }
 128
 129         int enable();
 130         int disable();
 131
 132 // Get the column movement
 133         int get_from_column();
 134         int get_to_column();
 135
 136 // Get the item in the given column which is the selection_number of the total
 137 // selected rows.  Returns 0 on failure.
 138         BC_ListBoxItem* get_selection(int column, int selection_number);
 139         BC_ListBoxItem* get_selection_recursive(ArrayList<BC_ListBoxItem*> *data,
 140                 int column,
 141                 int selection_number);
 142
 143 // Get the flat index of the item in the given column which is the selection_number
 144 // of the total selected rows.  Returns -1 on failure.  The column
 145 // argument is really useless because it only checks column 1 and returns the row
 146 // number.
 147         int get_selection_number(int column, int selection_number);
 148         int get_selection_number_recursive(ArrayList<BC_ListBoxItem*> *data,
 149                 int column,
 150                 int selection_number,
 151                 int *counter = 0);
 152
 153         virtual int evaluate_query(char *string);
 154         void expand_item(BC_ListBoxItem *item, int expand);
 155 // Collapse all items
 156         static void collapse_recursive(ArrayList<BC_ListBoxItem*> *data,
 157                 int master_column);
 158 // Convert recursive pointer to flat index.
 159 // The pointer can be any item in the row corresponding to the index.
 160 // Returns -1 if no item was found.
 161         int item_to_index(ArrayList<BC_ListBoxItem*> *data,
 162                 BC_ListBoxItem *item,
 163                 int *counter = 0);
 164 // Convert flat index and column to desired item.
 165         BC_ListBoxItem* index_to_item(ArrayList<BC_ListBoxItem*> *data,
 166                 int number,
 167                 int column,
 168                 int *counter = 0);
 169 // Get all items with recursion for text mode
 170         static int get_total_items(ArrayList<BC_ListBoxItem*> *data,
 171                 int *result /* = 0 */,
 172                 int master_column);
 173
 174         virtual int focus_out_event();
 175         virtual int keypress_event();
 176         virtual int button_press_event();
 177         virtual int button_release_event();
 178         virtual int cursor_enter_event();
 179         virtual int cursor_leave_event();
 180         virtual int cursor_motion_event();
 181         virtual int drag_start_event();
 182         virtual int drag_motion_event();
 183         virtual int drag_stop_event();
 184
 185 // After popping up a menu call this to interrupt the selection process
 186         void deactivate_selection();
 187
 188 // take_focus - used by the suggestion box to keep it from taking focus from the
 189 // textbox
 190         int activate(int take_focus = 1);
 191         int activate(int x, int y, int w=-1, int h=-1);
 192         int deactivate();
 193         int is_active();
 194
 195         int translation_event();
 196         int repeat_event(int64_t duration);
 197         BC_DragWindow* get_drag_popup();
 198 // If the popup window should show a button.
 199 // Must be called in the constructor.
 200         void set_use_button(int value);
 201         void set_is_suggestions(int value);
 202         void set_scroll_repeat();
 203         void unset_scroll_repeat();
 204         int scroll_repeat;
 205
 206 // change the contents
 207         int update(ArrayList<BC_ListBoxItem*> *data,
 208                 const char **column_titles, int *column_widths, int columns,
 209                 int xposition = 0, int yposition = 0,
 210                 int highlighted_number = -1,  // Flat index of item cursor is over
 211                 int recalc_positions = 0,     // set all autoplace flags to 1
 212                 int draw = 1);
 213         void center_selection();
 214         void update_format(int display_format, int redraw);
 215         int get_format();
 216
 217 // Allow scrolling when dragging items
 218         void set_drag_scroll(int value);
 219 // Allow column repositioning
 220         void set_allow_drag_column(int value);
 221 // Allow automatic moving of objects after drag
 222         void set_process_drag(int value);
 223
 224 // Set the column to use for icons and sublists.
 225         void set_master_column(int value, int redraw);
 226 // Set column to search
 227         void set_search_column(int value);
 228         int set_selection_mode(int mode);
 229         int set_yposition(int position, int draw_items = 1);
 230         int get_yposition();
 231         int set_xposition(int position);
 232         int get_xposition();
 233 // Return the flat index of the highlighted item
 234         int get_highlighted_item();
 235         int get_yscroll_x();
 236         int get_yscroll_y();
 237         int get_yscroll_height();
 238         int get_xscroll_x();
 239         int get_xscroll_y();
 240         int get_xscroll_width();
 241         void set_scroll_stretch(int xv, int yv);
 242         int get_column_offset(int column);
 243         int get_column_width(int column, int clamp_right = 0);
 244         int get_title_h();
 245         int get_display_mode();
 246         void set_justify(int value);
 247         int get_w() { return is_popup ? BCPOPUPLISTBOX_W : popup_w; }
 248         int get_h() { return is_popup ? BCPOPUPLISTBOX_H : popup_h; }
 249         int gui_tooltip(const char *text) {
 250                 return is_popup && gui ? gui->show_tooltip(text, gui->get_w(),0, -1,-1) : -1;
 251         }
 252         int get_view_w() { return view_w; }
 253         int get_view_h() { return view_h; }
 254         int get_row_height() { return row_height; }
 255         int get_row_ascent() { return row_ascent; }
 256         int get_row_descent() { return row_descent; }
 257         int get_first_visible() { return first_in_view; }
 258         int get_last_visible() { return last_in_view; }
 259
 260         enum
 261         {
 262                 SORT_ASCENDING,
 263                 SORT_DESCENDING
 264         };
 265
 266         int get_sort_column();
 267         void set_sort_column(int value, int redraw = 0);
 268         int get_sort_order();
 269         void set_sort_order(int value, int redraw = 0);
 270
 271
 272         void reset_query();
 273         int get_show_query() { return show_query; }
 274         void set_show_query(int v) { show_query = v; }
 275
 276         int reposition_window(int x,
 277                 int y,
 278                 int w = -1,
 279                 int h = -1,
 280                 int flush = 1);
 281         BC_Pixmap* get_bg_surface();
 282 // Set all items for autoplacement with recursion into sublists
 283         void set_autoplacement(ArrayList<BC_ListBoxItem*> *data,
 284                 int do_icon,
 285                 int do_text);
 286 // Set selection status on all items with recursion
 287         void set_all_selected(ArrayList<BC_ListBoxItem*> *data, int value);
 288 // Set selection status of single row with recursion
 289 // item_number - the flat index of the row to select
 290         void set_selected(ArrayList<BC_ListBoxItem*> *data,
 291                 int item_number,
 292                 int value,
 293                 int *counter = 0);
 294
 295 // Called by keypress_event for cursor up.  Selects previous and next visible
 296 // row, skipping desired number of visible rows.
 297         int select_previous(int skip,
 298                 BC_ListBoxItem *selected_item = 0,
 299                 int *counter = 0,
 300                 ArrayList<BC_ListBoxItem*> *data = 0,
 301                 int *got_it = 0,
 302                 int *got_second = 0);
 303         int select_next(int skip,
 304                 BC_ListBoxItem *selected_item = 0,
 305                 int *counter = 0,
 306                 ArrayList<BC_ListBoxItem*> *data = 0,
 307                 int *got_it = 0,
 308                 int *got_second = 0);
 309
 310 // Called by cursor_motion_event to select different item if selection_number
 311 // changed.  Returns 1 if redraw is required.
 312         int update_selection(ArrayList<BC_ListBoxItem*> *data,
 313                 int selection_number,
 314                 int *counter = 0);
 315
 316         static void dump(ArrayList<BC_ListBoxItem*> *data,
 317                 int columns,
 318                 int indent /* = 0 */,
 319                 int master_column);
 320
 321         int get_icon_x(BC_ListBoxItem *item);
 322         int get_icon_y(BC_ListBoxItem *item);
 323         int get_icon_w(BC_ListBoxItem *item);
 324         int get_icon_h(BC_ListBoxItem *item);
 325         int get_text_w(BC_ListBoxItem *item);
 326         int get_text_h(BC_ListBoxItem *item);
 327         int get_item_x(BC_ListBoxItem *item);
 328         int get_item_y(BC_ListBoxItem *item);
 329         int get_item_w(BC_ListBoxItem *item);
 330         int get_item_h(BC_ListBoxItem *item);
 331
 332 // Draw the list items
 333         int draw_items(int flash, int bg_draw=0);
 334         int is_highlighted();
 335         int get_cursor_item();
 336
 337 private:
 338         void delete_columns();
 339         void set_columns(const char **column_titles,
 340                 int *column_widths,
 341                 int columns);
 342 // Draw the button for a popup listbox
 343         int draw_button(int flush);
 344 // Draw list border
 345         int draw_border(int flash);
 346 // Draw column titles
 347         void draw_title(int number);
 348         int draw_titles(int flash);
 349 // Draw expanders
 350         void draw_toggles(int flash);
 351 // Draw selection rectangle
 352         int draw_rectangle(int flash);
 353
 354
 355         void draw_text_recursive(ArrayList<BC_ListBoxItem*> *data,
 356                 int column,
 357                 int indent,
 358                 int *current_toggle);
 359 // Returns 1 if selection changed
 360         int query_list();
 361         void init_column_width();
 362         void reset_cursor(int new_cursor);
 363 // Fix boundary conditions after resize
 364         void column_width_boundaries();
 365 // Recursive function to get the first item selected in text mode.
 366 // Returns > -1 only if it got it.  Always increments *result
 367         int get_first_selection(ArrayList<BC_ListBoxItem*> *data, int *result = 0);
 368 // Recursive function to get the last item selected in text mode.
 369 // Returns > -1 only if it got it.  Always increments *result
 370         int get_last_selection(ArrayList<BC_ListBoxItem*> *data, int *result = 0);
 371 // Called by button_press_event and cursor_motion_event to expand the selection.
 372 // Returns 1 if redraw is required.
 373         int expand_selection(int button_press, int selection_number);
 374 // Called by button_press_event and cursor_motion_event
 375 // to select a range in text mode
 376         void select_range(ArrayList<BC_ListBoxItem*> *data,
 377                 int start,
 378                 int end,
 379                 int *current = 0);
 380 // Called by button_press_event to toggle the selection status of a single item.
 381 // Called for both text and icon mode.  In text mode it's recursive and fills
 382 // the entire row with the first item's value.  Returns 1 when the item was toggled.
 383         int toggle_item_selection(ArrayList<BC_ListBoxItem*> *data,
 384                 int selection_number,
 385                 int *counter = 0);
 386 // Set value of selected in all selected items to new value
 387         void promote_selections(ArrayList<BC_ListBoxItem*> *data,
 388                 int old_value,
 389                 int new_value);
 390
 391
 392         int test_column_divisions(int cursor_x, int cursor_y, int &new_cursor);
 393         int test_column_titles(int cursor_x, int cursor_y);
 394         int test_expanders();
 395
 396         int calculate_item_coords();
 397         void calculate_last_coords_recursive(
 398                 ArrayList<BC_ListBoxItem*> *data,
 399                 int *icon_x,
 400                 int *next_icon_x,
 401                 int *next_icon_y,
 402                 int *next_text_y,
 403                 int top_level);
 404         void calculate_item_coords_recursive(
 405                 ArrayList<BC_ListBoxItem*> *data,
 406                 int *icon_x,
 407                 int *next_icon_x,
 408                 int *next_icon_y,
 409                 int *next_text_y,
 410                 int top_level);
 411
 412         int get_items_width();
 413         int get_items_height(ArrayList<BC_ListBoxItem*> *data,
 414                 int columns,
 415                 int *result = 0);
 416         int get_baseline(BC_ListBoxItem *item);
 417         int get_item_highlight(ArrayList<BC_ListBoxItem*> *data, int column, int item);
 418         int get_item_color(ArrayList<BC_ListBoxItem*> *data, int column, int item);
 419         int get_icon_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
 420         int get_text_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
 421 // Copy sections of the bg_surface to the gui
 422         void clear_listbox(int x, int y, int w, int h);
 423
 424 // Tests for cursor outside boundaries
 425         int test_drag_scroll(int cursor_x, int cursor_y);
 426 // Called by select_scroll_event, rectangle_scroll_event to execute for movement
 427         int drag_scroll_event();
 428         int select_scroll_event();
 429         int rectangle_scroll_event();
 430
 431
 432         void move_vertical(int pixels);
 433         void move_horizontal(int pixels);
 434         void clamp_positions();
 435
 436         int get_scrollbars();
 437         void update_scrollbars(int flush);
 438
 439 // Flat index of the item the cursor is over.
 440 // Points *item_return to the first item in the row or 0 if no item was found.
 441 // if it's nonzero.  Returns -1 if no item was found.  Clamps the y coordinate
 442 // only if the current operation is not SELECT, so scrolling is possible.
 443 // expanded - 1 if items in this table should be tested for cursor coverage
 444         int get_cursor_item(ArrayList<BC_ListBoxItem*> *data,
 445                 int cursor_x,
 446                 int cursor_y,
 447                 BC_ListBoxItem **item_return = 0,
 448                 int *counter = 0,
 449                 int expanded = 1);
 450 // Select the items in the rectangle and deselect the items outside of it.
 451 // Returns 1 if redraw is required.
 452         int select_rectangle(ArrayList<BC_ListBoxItem*> *data,
 453                 int x1,
 454                 int y1,
 455                 int x2,
 456                 int y2);
 457 // Convert the row of the item to a pointer.
 458         BC_ListBoxItem* number_to_item(int row);
 459         int reposition_item(ArrayList<BC_ListBoxItem*> *data,
 460                 int selection_number,
 461                 int x,
 462                 int y,
 463                 int *counter = 0);
 464 // Move selected items to src_items
 465         void move_selection(ArrayList<BC_ListBoxItem*> *dst,
 466                 ArrayList<BC_ListBoxItem*> *src);
 467 // Put items from the src table into the data table starting at flat item number
 468 // destination.
 469         int put_selection(ArrayList<BC_ListBoxItem*> *data,
 470                 ArrayList<BC_ListBoxItem*> *src,
 471                 int destination,
 472                 int *counter = 0);
 473
 474         int center_selection(int selection,
 475                 ArrayList<BC_ListBoxItem*> *data = 0,
 476                 int *counter = 0);
 477
 478 // Array of one list of pointers for each column
 479         ArrayList<BC_ListBoxItem*> *data;
 480
 481
 482 // 1 if a button is used to make the listbox display
 483         int is_popup;      // popup
 484 // If the button for a popup should be shown
 485         int use_button;
 486 // background update needed
 487         int bg_draw;
 488
 489 // Dimensions for a popup if there is one
 490         int popup_w, popup_h;
 491 // pixel of top of display relative to top of list
 492         int yposition;
 493 // pixel of left display relative to first column
 494         int xposition;
 495 // dimensions of a row in the list
 496         int row_height, row_ascent, row_descent;
 497
 498
 499         int selection_mode;
 500         int display_format;
 501         int temp_display_format;
 502         int icon_position;
 503 // Scrollbars are created as needed
 504         BC_ListBoxXScroll *xscrollbar;
 505         BC_ListBoxYScroll *yscrollbar;
 506         ArrayList<BC_ListBoxToggle*> expanders;
 507         char query[BCTEXTLEN];
 508         int show_query;
 509
 510 // Window containing the listbox
 511         BC_WindowBase *gui;
 512         int disabled;
 513 // Size of the popup if there is one
 514         char **column_titles;
 515         int *column_width;
 516         int default_column_width[32];
 517         int columns;
 518         int master_column;
 519         int search_column;
 520
 521         int view_h, view_w;
 522         int first_in_view, last_in_view;
 523         int title_h;
 524 // Maximum width of items.  Calculated by get_items_width
 525         int items_w;
 526         int items_h;
 527 // In BCLISTBOX_SELECT mode determines the value to set items to
 528         int new_value;
 529         int need_xscroll, need_yscroll;
 530         int xscroll_orientation, yscroll_orientation;
 531 // Move items during drag operation of text items.
 532         int process_drag;
 533         int allow_drag;
 534         int allow_drag_scroll;
 535         int allow_drag_column;
 536 // Background color of listbox
 537         int list_background;
 538
 539
 540 // Popup button
 541         BC_Pixmap *button_images[4];
 542 // Expander
 543         BC_Pixmap *toggle_images[5];
 544 // Background for drawing on
 545         BC_Pixmap *bg_surface;
 546 // Background if 9 segment
 547         BC_Pixmap *bg_tile;
 548 // Drag icon for text mode
 549         VFrame *drag_icon_vframe;
 550 // Drag column icon
 551         VFrame *drag_column_icon_vframe;
 552 // Background picon to be drawn in the upper right
 553         BC_Pixmap *bg_pixmap;
 554
 555
 556 // Column title backgrounds
 557         BC_Pixmap *column_bg[3];
 558 // Column sort order
 559         BC_Pixmap *column_sort_up;
 560         BC_Pixmap *column_sort_dn;
 561
 562
 563
 564
 565 // Number of column to sort
 566         int sort_column;
 567 // Sort order.  -1 means no column is being sorted.
 568         int sort_order;
 569
 570
 571
 572
 573
 574 // State of the list box and button when the mouse button is pressed.
 575         int current_operation;
 576
 577         enum
 578         {
 579                 NO_OPERATION,
 580                 BUTTON_DOWN_SELECT, // Pressed button and slid off to select items.
 581                 BUTTON_DN,
 582                 DRAG_DIVISION,    // Dragging column division
 583                 DRAG_COLUMN,      // Dragging column
 584                 DRAG_ITEM,        // Dragging item
 585                 SELECT,                   // Select item
 586                 SELECT_RECT,      // Selection rectangle
 587                 WHEEL,                    // Wheel mouse
 588                 COLUMN_DN,                // column title down
 589                 COLUMN_DRAG,      // column title is being dragged
 590                 EXPAND_DN         // Expander is down
 591         };
 592
 593
 594 // More state variables
 595         int button_highlighted;
 596         int list_highlighted;
 597         int packed_icons;
 598 // item cursor is over.  May not exist in tables.
 599 // Must be an index since this is needed to change the database.
 600         int highlighted_item;
 601         BC_ListBoxItem* highlighted_ptr;
 602 // column title if the cursor is over a column title
 603         int highlighted_title;
 604 // Division the cursor is operating on when resizing
 605         int highlighted_division;
 606 // Column title being dragged
 607         int dragged_title;
 608 // start of column title drag
 609         int drag_cursor_x;
 610         int drag_column_w;
 611
 612 // Selection range being extended
 613         int selection_start, selection_end, selection_center;
 614 // Item being dragged or last item selected in a double click operation
 615         int selection_number;
 616 // Used in button_press_event and button_release_event to detect double clicks
 617         int selection_number1, selection_number2;
 618
 619
 620
 621
 622         int active;
 623 // Popup listboxes have different behavior for suggestion boxes where the
 624 // textbox needs to be active when the listbox is visible.
 625         int is_suggestions;
 626
 627 // Button release counter for double clicking
 628         int button_releases;
 629         int current_cursor;
 630 // Starting coordinates of rectangle
 631         int rect_x1, rect_y1;
 632         int rect_x2, rect_y2;
 633
 634
 635
 636 // Window for dragging
 637         BC_DragWindow *drag_popup;
 638         int justify;
 639 };
 640
 641
 642
 643
 644 #endif