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 "colors.h"
  31
  32 #define BCPOPUPLISTBOX_W 25
  33 #define BCPOPUPLISTBOX_H 25
  34
  35
  36 #define MIN_COLUMN_WIDTH 10
  37
  38
  39 class BC_ListBoxYScroll : public BC_ScrollBar
  40 {
  41 public:
  42         BC_ListBoxYScroll(BC_ListBox *listbox,
  43                           int total_height,
  44                                           int view_height,
  45                           int position);
  46         ~BC_ListBoxYScroll();
  47         int handle_event();
  48 private:
  49         BC_ListBox *listbox;
  50 };
  51
  52 class BC_ListBoxXScroll : public BC_ScrollBar
  53 {
  54 public:
  55         BC_ListBoxXScroll(BC_ListBox *listbox,
  56                           int total_width,
  57                                           int view_width,
  58                           int position);
  59         ~BC_ListBoxXScroll();
  60         int handle_event();
  61 private:
  62         BC_ListBox *listbox;
  63 };
  64
  65 class BC_ListBoxToggle
  66 {
  67 public:
  68         BC_ListBoxToggle(BC_ListBox *listbox,
  69                 BC_ListBoxItem *item,
  70                 int x,
  71                 int y);
  72
  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);
  78         void draw(int flash);
  79
  80         BC_ListBox *listbox;
  81         BC_ListBoxItem *item;
  82         int x, y;
  83         int value, state;
  84         enum
  85         {
  86                 TOGGLE_UP,
  87                 TOGGLE_UPHI,
  88                 TOGGLE_CHECKED,
  89                 TOGGLE_DOWN,
  90                 TOGGLE_CHECKEDHI,
  91 // Button pressed then moved out
  92                 TOGGLE_DOWN_EXIT
  93         };
  94 };
  95
  96
  97 class BC_ListBox : public BC_SubWindow
  98 {
  99 public:
 100         BC_ListBox(int x,
 101                 int y,
 102                 int w,
 103                 int h,
 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();
 115
 116         friend class BC_ListBoxToggle;
 117
 118         int initialize();
 119
 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
 131 // action.
 132         virtual int sort_order_event() { return 0; };
 133 // Column moved
 134         virtual int move_column_event() { return 0; };
 135
 136         int enable();
 137         int disable();
 138
 139 // Get the column movement
 140         int get_from_column();
 141         int get_to_column();
 142
 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,
 147                 int column,
 148                 int selection_number);
 149
 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
 153 // number.
 154         int get_selection_number(int column, int selection_number);
 155         int get_selection_number_recursive(ArrayList<BC_ListBoxItem*> *data,
 156                 int column,
 157                 int selection_number,
 158                 int *counter = 0);
 159
 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,
 164                 int master_column);
 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,
 170                 int *counter = 0);
 171 // Convert flat index and column to desired item.
 172         BC_ListBoxItem* index_to_item(ArrayList<BC_ListBoxItem*> *data,
 173                 int number,
 174                 int column,
 175                 int *counter = 0);
 176 // Get all items with recursion for text mode
 177         static int get_total_items(ArrayList<BC_ListBoxItem*> *data,
 178                 int *result /* = 0 */,
 179                 int master_column);
 180
 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();
 191
 192 // After popping up a menu call this to interrupt the selection process
 193         void deactivate_selection();
 194
 195 // take_focus - used by the suggestion box to keep it from taking focus from the
 196 // textbox
 197         int activate(int take_focus = 1);
 198         int activate(int x, int y, int w=-1, int h=-1);
 199         int deactivate();
 200         int is_active();
 201
 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);
 209
 210
 211 // change the contents
 212         int update(ArrayList<BC_ListBoxItem*> *data,
 213                                                 const char **column_titles,
 214                                                 int *column_widths,
 215                                                 int columns,
 216                                                 int xposition = 0,
 217                                                 int yposition = 0,
 218                                                 int highlighted_number = -1,  // Flat index of item cursor is over
 219                                                 int recalc_positions = 0,     // set all autoplace flags to 1
 220                                                 int draw = 1);
 221         void center_selection();
 222         void update_format(int display_format, int redraw);
 223         int get_format();
 224
 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);
 231
 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);
 238         int get_yposition();
 239         int set_xposition(int position);
 240         int get_xposition();
 241 // Return the flat index of the highlighted item
 242         int get_highlighted_item();
 243         int get_yscroll_x();
 244         int get_yscroll_y();
 245         int get_yscroll_height();
 246         int get_xscroll_x();
 247         int get_xscroll_y();
 248         int get_xscroll_width();
 249         int get_column_offset(int column);
 250         int get_column_width(int column, int clamp_right = 0);
 251         int get_title_h();
 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 gui_tooltip(const char *text) {
 257                 return is_popup && gui ? gui->show_tooltip(text, gui->get_w(),0, -1,-1) : -1;
 258         }
 259         int get_view_w() { return view_w; }
 260         int get_view_h() { return view_h; }
 261         int get_row_height() { return row_height; }
 262         int get_row_ascent() { return row_ascent; }
 263         int get_row_descent() { return row_descent; }
 264         int get_first_visible() { return first_in_view; }
 265         int get_last_visible() { return last_in_view; }
 266
 267
 268         enum
 269         {
 270                 SORT_ASCENDING,
 271                 SORT_DESCENDING
 272         };
 273
 274         int get_sort_column();
 275         void set_sort_column(int value, int redraw = 0);
 276         int get_sort_order();
 277         void set_sort_order(int value, int redraw = 0);
 278
 279
 280         void reset_query();
 281         int get_show_query() { return show_query; }
 282         void set_show_query(int v) { show_query = v; }
 283
 284         int reposition_window(int x,
 285                 int y,
 286                 int w = -1,
 287                 int h = -1,
 288                 int flush = 1);
 289         BC_Pixmap* get_bg_surface();
 290 // Set all items for autoplacement with recursion into sublists
 291         void set_autoplacement(ArrayList<BC_ListBoxItem*> *data,
 292                 int do_icon,
 293                 int do_text);
 294 // Set selection status on all items with recursion
 295         void set_all_selected(ArrayList<BC_ListBoxItem*> *data, int value);
 296 // Set selection status of single row with recursion
 297 // item_number - the flat index of the row to select
 298         void set_selected(ArrayList<BC_ListBoxItem*> *data,
 299                 int item_number,
 300                 int value,
 301                 int *counter = 0);
 302
 303 // Called by keypress_event for cursor up.  Selects previous and next visible
 304 // row, skipping desired number of visible rows.
 305         int select_previous(int skip,
 306                 BC_ListBoxItem *selected_item = 0,
 307                 int *counter = 0,
 308                 ArrayList<BC_ListBoxItem*> *data = 0,
 309                 int *got_it = 0,
 310                 int *got_second = 0);
 311         int select_next(int skip,
 312                 BC_ListBoxItem *selected_item = 0,
 313                 int *counter = 0,
 314                 ArrayList<BC_ListBoxItem*> *data = 0,
 315                 int *got_it = 0,
 316                 int *got_second = 0);
 317
 318 // Called by cursor_motion_event to select different item if selection_number
 319 // changed.  Returns 1 if redraw is required.
 320         int update_selection(ArrayList<BC_ListBoxItem*> *data,
 321                 int selection_number,
 322                 int *counter = 0);
 323
 324         static void dump(ArrayList<BC_ListBoxItem*> *data,
 325                 int columns,
 326                 int indent /* = 0 */,
 327                 int master_column);
 328
 329         int get_item_x(BC_ListBoxItem *item);
 330         int get_item_y(BC_ListBoxItem *item);
 331         int get_item_w(BC_ListBoxItem *item);
 332         int get_item_h(BC_ListBoxItem *item);
 333
 334 // Draw the list items
 335         int draw_items(int flash, int bg_draw=0);
 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_icon_w(BC_ListBoxItem *item);
 417         int get_icon_h(BC_ListBoxItem *item);
 418         int get_text_w(BC_ListBoxItem *item);
 419         int get_text_h(BC_ListBoxItem *item);
 420         int get_baseline(BC_ListBoxItem *item);
 421         int get_item_highlight(ArrayList<BC_ListBoxItem*> *data, int column, int item);
 422         int get_item_color(ArrayList<BC_ListBoxItem*> *data, int column, int item);
 423         int get_icon_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
 424         int get_text_mask(BC_ListBoxItem *item, int &x, int &y, int &w, int &h);
 425 // Copy sections of the bg_surface to the gui
 426         void clear_listbox(int x, int y, int w, int h);
 427
 428 // Tests for cursor outside boundaries
 429         int test_drag_scroll(int cursor_x, int cursor_y);
 430 // Called by select_scroll_event, rectangle_scroll_event to execute for movement
 431         int drag_scroll_event();
 432         int select_scroll_event();
 433         int rectangle_scroll_event();
 434
 435
 436         void move_vertical(int pixels);
 437         void move_horizontal(int pixels);
 438         void clamp_positions();
 439
 440         int get_scrollbars();
 441         void update_scrollbars(int flush);
 442
 443 // Flat index of the item the cursor is over.
 444 // Points *item_return to the first item in the row or 0 if no item was found.
 445 // if it's nonzero.  Returns -1 if no item was found.  Clamps the y coordinate
 446 // only if the current operation is not SELECT, so scrolling is possible.
 447 // expanded - 1 if items in this table should be tested for cursor coverage
 448         int get_cursor_item(ArrayList<BC_ListBoxItem*> *data,
 449                 int cursor_x,
 450                 int cursor_y,
 451                 BC_ListBoxItem **item_return = 0,
 452                 int *counter = 0,
 453                 int expanded = 1);
 454 // Select the items in the rectangle and deselect the items outside of it.
 455 // Returns 1 if redraw is required.
 456         int select_rectangle(ArrayList<BC_ListBoxItem*> *data,
 457                 int x1,
 458                 int y1,
 459                 int x2,
 460                 int y2);
 461 // Convert the row of the item to a pointer.
 462         BC_ListBoxItem* number_to_item(int row);
 463         int reposition_item(ArrayList<BC_ListBoxItem*> *data,
 464                 int selection_number,
 465                 int x,
 466                 int y,
 467                 int *counter = 0);
 468 // Move selected items to src_items
 469         void move_selection(ArrayList<BC_ListBoxItem*> *dst,
 470                 ArrayList<BC_ListBoxItem*> *src);
 471 // Put items from the src table into the data table starting at flat item number
 472 // destination.
 473         int put_selection(ArrayList<BC_ListBoxItem*> *data,
 474                 ArrayList<BC_ListBoxItem*> *src,
 475                 int destination,
 476                 int *counter = 0);
 477
 478         int center_selection(int selection,
 479                 ArrayList<BC_ListBoxItem*> *data = 0,
 480                 int *counter = 0);
 481
 482 // Array of one list of pointers for each column
 483         ArrayList<BC_ListBoxItem*> *data;
 484
 485
 486 // 1 if a button is used to make the listbox display
 487         int is_popup;      // popup
 488 // If the button for a popup should be shown
 489         int use_button;
 490 // background update needed
 491         int bg_draw;
 492
 493 // Dimensions for a popup if there is one
 494         int popup_w, popup_h;
 495 // pixel of top of display relative to top of list
 496         int yposition;
 497 // pixel of left display relative to first column
 498         int xposition;
 499 // dimensions of a row in the list
 500         int row_height, row_ascent, row_descent;
 501
 502
 503         int selection_mode;
 504         int display_format;
 505         int temp_display_format;
 506         int icon_position;
 507 // Scrollbars are created as needed
 508         BC_ListBoxXScroll *xscrollbar;
 509         BC_ListBoxYScroll *yscrollbar;
 510         ArrayList<BC_ListBoxToggle*> expanders;
 511         char query[BCTEXTLEN];
 512         int show_query;
 513
 514 // Window containing the listbox
 515         BC_WindowBase *gui;
 516         int disabled;
 517 // Size of the popup if there is one
 518         char **column_titles;
 519         int *column_width;
 520         int default_column_width[1];
 521         int columns;
 522         int master_column;
 523         int search_column;
 524
 525         int view_h, view_w;
 526         int first_in_view, last_in_view;
 527         int title_h;
 528 // Maximum width of items.  Calculated by get_items_width
 529         int items_w;
 530         int items_h;
 531 // In BCLISTBOX_SELECT mode determines the value to set items to
 532         int new_value;
 533         int need_xscroll, need_yscroll;
 534 // Move items during drag operation of text items.
 535         int process_drag;
 536         int allow_drag;
 537         int allow_drag_scroll;
 538         int allow_drag_column;
 539 // Background color of listbox
 540         int list_background;
 541
 542
 543 // Popup button
 544         BC_Pixmap *button_images[4];
 545 // Expander
 546         BC_Pixmap *toggle_images[5];
 547 // Background for drawing on
 548         BC_Pixmap *bg_surface;
 549 // Background if 9 segment
 550         BC_Pixmap *bg_tile;
 551 // Drag icon for text mode
 552         VFrame *drag_icon_vframe;
 553 // Drag column icon
 554         VFrame *drag_column_icon_vframe;
 555 // Background picon to be drawn in the upper right
 556         BC_Pixmap *bg_pixmap;
 557
 558
 559 // Column title backgrounds
 560         BC_Pixmap *column_bg[3];
 561 // Column sort order
 562         BC_Pixmap *column_sort_up;
 563         BC_Pixmap *column_sort_dn;
 564
 565
 566
 567
 568 // Number of column to sort
 569         int sort_column;
 570 // Sort order.  -1 means no column is being sorted.
 571         int sort_order;
 572
 573
 574
 575
 576
 577 // State of the list box and button when the mouse button is pressed.
 578         int current_operation;
 579
 580         enum
 581         {
 582                 NO_OPERATION,
 583                 BUTTON_DOWN_SELECT, // Pressed button and slid off to select items.
 584                 BUTTON_DN,
 585                 DRAG_DIVISION,    // Dragging column division
 586                 DRAG_COLUMN,      // Dragging column
 587                 DRAG_ITEM,        // Dragging item
 588                 SELECT,                   // Select item
 589                 SELECT_RECT,      // Selection rectangle
 590                 WHEEL,                    // Wheel mouse
 591                 COLUMN_DN,                // column title down
 592                 COLUMN_DRAG,      // column title is being dragged
 593                 EXPAND_DN         // Expander is down
 594         };
 595
 596
 597 // More state variables
 598         int button_highlighted;
 599         int list_highlighted;
 600 // item cursor is over.  May not exist in tables.
 601 // Must be an index since this is needed to change the database.
 602         int highlighted_item;
 603         BC_ListBoxItem* highlighted_ptr;
 604 // column title if the cursor is over a column title
 605         int highlighted_title;
 606 // Division the cursor is operating on when resizing
 607         int highlighted_division;
 608 // Column title being dragged
 609         int dragged_title;
 610 // start of column title drag
 611         int drag_cursor_x;
 612         int drag_column_w;
 613
 614 // Selection range being extended
 615         int selection_start, selection_end, selection_center;
 616 // Item being dragged or last item selected in a double click operation
 617         int selection_number;
 618 // Used in button_press_event and button_release_event to detect double clicks
 619         int selection_number1, selection_number2;
 620
 621
 622
 623
 624         int active;
 625 // Popup listboxes have different behavior for suggestion boxes where the
 626 // textbox needs to be active when the listbox is visible.
 627         int is_suggestions;
 628
 629 // Button release counter for double clicking
 630         int button_releases;
 631         int current_cursor;
 632 // Starting coordinates of rectangle
 633         int rect_x1, rect_y1;
 634         int rect_x2, rect_y2;
 635
 636
 637
 638 // Window for dragging
 639         BC_DragWindow *drag_popup;
 640         int justify;
 641 };
 642
 643
 644
 645
 646 #endif