pintos-os.org Git - pspp/blob - src/ui/gui/pspp-sheet-private.h

   1  /* PSPPIRE - a graphical user interface for PSPP.
   2     Copyright (C) 2011, 2012, 2013 Free Software Foundation, Inc.
   3
   4     This program is free software: you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation, either version 3 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 /* gtktreeprivate.h
  18  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
  19  *
  20  * This library is free software; you can redistribute it and/or
  21  * modify it under the terms of the GNU Library General Public
  22  * License as published by the Free Software Foundation; either
  23  * version 2 of the License, or (at your option) any later version.
  24  *
  25  * This library is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  28  * Library General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU Library General Public
  31  * License along with this library; if not, write to the
  32  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  33  * Boston, MA 02111-1307, USA.
  34  */
  35
  36 #ifndef __GTK_TREE_PRIVATE_H__
  37 #define __GTK_TREE_PRIVATE_H__
  38
  39
  40 #include <gtk/gtk.h>
  41 #include "libpspp/range-tower.h"
  42 #include "ui/gui/pspp-sheet-view.h"
  43 #include "ui/gui/pspp-sheet-view-column.h"
  44
  45 #define TREE_VIEW_DRAG_WIDTH 6
  46
  47 typedef enum
  48 {
  49   PSPP_SHEET_VIEW_IN_COLUMN_RESIZE = 1 << 2,
  50   PSPP_SHEET_VIEW_HEADERS_VISIBLE = 1 << 4,
  51   PSPP_SHEET_VIEW_DRAW_KEYFOCUS = 1 << 5,
  52   PSPP_SHEET_VIEW_MODEL_SETUP = 1 << 6,
  53   PSPP_SHEET_VIEW_IN_COLUMN_DRAG = 1 << 7
  54 } PsppSheetViewFlags;
  55
  56 enum
  57 {
  58   DRAG_COLUMN_WINDOW_STATE_UNSET = 0,
  59   DRAG_COLUMN_WINDOW_STATE_ORIGINAL = 1,
  60   DRAG_COLUMN_WINDOW_STATE_ARROW = 2,
  61   DRAG_COLUMN_WINDOW_STATE_ARROW_LEFT = 3,
  62   DRAG_COLUMN_WINDOW_STATE_ARROW_RIGHT = 4
  63 };
  64
  65 enum
  66 {
  67   RUBBER_BAND_OFF = 0,
  68   RUBBER_BAND_MAYBE_START = 1,
  69   RUBBER_BAND_ACTIVE = 2
  70 };
  71
  72 #define PSPP_SHEET_VIEW_SET_FLAG(tree_view, flag)   G_STMT_START{ (tree_view->priv->flags|=flag); }G_STMT_END
  73 #define PSPP_SHEET_VIEW_UNSET_FLAG(tree_view, flag) G_STMT_START{ (tree_view->priv->flags&=~(flag)); }G_STMT_END
  74 #define PSPP_SHEET_VIEW_FLAG_SET(tree_view, flag)   ((tree_view->priv->flags&flag)==flag)
  75 #define TREE_VIEW_HEADER_HEIGHT(tree_view)        (PSPP_SHEET_VIEW_FLAG_SET (tree_view, PSPP_SHEET_VIEW_HEADERS_VISIBLE)?tree_view->priv->header_height:0)
  76 #define TREE_VIEW_COLUMN_REQUESTED_WIDTH(column)  (CLAMP (column->requested_width, (column->min_width!=-1)?column->min_width:column->requested_width, (column->max_width!=-1)?column->max_width:column->requested_width))
  77
  78  /* This lovely little value is used to determine how far away from the title bar
  79   * you can move the mouse and still have a column drag work.
  80   */
  81 #define TREE_VIEW_COLUMN_DRAG_DEAD_MULTIPLIER(tree_view) (10*TREE_VIEW_HEADER_HEIGHT(tree_view))
  82
  83 typedef struct _PsppSheetViewColumnReorder PsppSheetViewColumnReorder;
  84 struct _PsppSheetViewColumnReorder
  85 {
  86   gint left_align;
  87   gint right_align;
  88   PsppSheetViewColumn *left_column;
  89   PsppSheetViewColumn *right_column;
  90 };
  91
  92 struct _PsppSheetViewPrivate
  93 {
  94   GtkTreeModel *model;
  95
  96   guint flags;
  97   /* tree information */
  98   gint row_count;
  99   struct range_tower *selected;
 100
 101   /* Container info */
 102   GList *children;
 103   gint width;
 104   gint height;
 105
 106   /* Adjustments */
 107   GtkAdjustment *hadjustment;
 108   GtkAdjustment *vadjustment;
 109
 110   /* Sub windows */
 111   GdkWindow *bin_window;
 112   GdkWindow *header_window;
 113
 114   /* Scroll position state keeping */
 115   GtkTreeRowReference *top_row;
 116   gint top_row_dy;
 117   /* dy == y pos of top_row + top_row_dy */
 118   /* we cache it for simplicity of the code */
 119   gint dy;
 120
 121   guint presize_handler_timer;
 122   guint validate_rows_timer;
 123   guint scroll_sync_timer;
 124
 125   /* Indentation and expander layout */
 126   gint expander_size;
 127
 128   /* Key navigation (focus), selection */
 129   gint cursor_offset;
 130
 131   GtkTreeRowReference *anchor;
 132   GtkTreeRowReference *cursor;
 133
 134   PsppSheetViewColumn *focus_column;
 135
 136   /* Current pressed node, previously pressed, prelight */
 137   gint pressed_button;
 138   gint press_start_x;
 139   gint press_start_y;
 140   gint press_start_node;
 141
 142   gint event_last_x;
 143   gint event_last_y;
 144
 145   guint last_button_time;
 146   gint last_button_x;
 147   gint last_button_y;
 148
 149   int prelight_node;
 150
 151   /* Cell Editing */
 152   PsppSheetViewColumn *edited_column;
 153   gint edited_row;
 154
 155   /* Selection information */
 156   PsppSheetSelection *selection;
 157
 158   /* Header information */
 159   gint n_columns;
 160   GList *columns;
 161   gint header_height;
 162   gint n_selected_columns;
 163
 164   PsppSheetViewColumnDropFunc column_drop_func;
 165   gpointer column_drop_func_data;
 166   GDestroyNotify column_drop_func_data_destroy;
 167   GList *column_drag_info;
 168   PsppSheetViewColumnReorder *cur_reorder;
 169
 170   /* Interactive Header reordering */
 171   GdkWindow *drag_window;
 172   GdkWindow *drag_highlight_window;
 173   PsppSheetViewColumn *drag_column;
 174   gint drag_column_x;
 175
 176   /* Interactive Header Resizing */
 177   gint drag_pos;
 178   gint x_drag;
 179
 180   /* Non-interactive Header Resizing, expand flag support */
 181   gint prev_width;
 182
 183   /* ATK Hack */
 184   PsppSheetDestroyCountFunc destroy_count_func;
 185   gpointer destroy_count_data;
 186   GDestroyNotify destroy_count_destroy;
 187
 188   /* Scroll timeout (e.g. during dnd, rubber banding) */
 189   guint scroll_timeout;
 190
 191   /* Row drag-and-drop */
 192   GtkTreeRowReference *drag_dest_row;
 193   PsppSheetViewDropPosition drag_dest_pos;
 194   guint open_dest_timeout;
 195
 196   /* Rubber banding */
 197   gint rubber_band_status;
 198   gint rubber_band_x;
 199   gint rubber_band_y;
 200   gint rubber_band_shift;
 201   gint rubber_band_ctrl;
 202
 203   int rubber_band_start_node;
 204
 205   int rubber_band_end_node;
 206
 207   /* Rectangular selection. */
 208   PsppSheetViewColumn *anchor_column; /* XXX needs to be a weak pointer? */
 209
 210   /* fixed height */
 211   gint fixed_height;
 212   gboolean fixed_height_set;
 213
 214   /* Scroll-to functionality when unrealized */
 215   GtkTreeRowReference *scroll_to_path;
 216   PsppSheetViewColumn *scroll_to_column;
 217   gfloat scroll_to_row_align;
 218   gfloat scroll_to_col_align;
 219
 220   /* Interactive search */
 221   gint selected_iter;
 222   gint search_column;
 223   PsppSheetViewSearchPositionFunc search_position_func;
 224   PsppSheetViewSearchEqualFunc search_equal_func;
 225   gpointer search_user_data;
 226   GDestroyNotify search_destroy;
 227   gpointer search_position_user_data;
 228   GDestroyNotify search_position_destroy;
 229   GtkWidget *search_window;
 230   GtkWidget *search_entry;
 231   guint search_entry_changed_id;
 232   guint typeselect_flush_timeout;
 233
 234   /* Grid and tree lines */
 235   PsppSheetViewGridLines grid_lines;
 236
 237   /* Special cells. */
 238   PsppSheetViewSpecialCells special_cells;
 239
 240   /* Tooltip support */
 241   gint tooltip_column;
 242
 243   /* Cached style for button facades in columns. */
 244   GtkStyle *button_style;
 245
 246   /* Here comes the bitfield */
 247   guint scroll_to_use_align : 1;
 248
 249   guint reorderable : 1;
 250   guint header_has_focus : 1;
 251   guint drag_column_window_state : 3;
 252   /* hint to display rows in alternating colors */
 253   guint has_rules : 1;
 254
 255   /* for DnD */
 256   guint empty_view_drop : 1;
 257
 258   guint init_hadjust_value : 1;
 259
 260   guint in_top_row_to_dy : 1;
 261
 262   /* interactive search */
 263   guint enable_search : 1;
 264   guint disable_popdown : 1;
 265   guint search_custom_entry_set : 1;
 266
 267   guint hover_selection : 1;
 268   guint imcontext_changed : 1;
 269
 270   guint rubber_banding_enable : 1;
 271
 272   guint in_grab : 1;
 273
 274   guint post_validation_flag : 1;
 275
 276   /* Whether our key press handler is to avoid sending an unhandled binding to the search entry */
 277
 278   guint search_entry_avoid_unhandled_binding : 1;
 279   /* GtkScrollablePolicy needs to be checked when
 280    * driving the scrollable adjustment values */
 281   guint hscroll_policy : 1;
 282   guint vscroll_policy : 1;
 283  };
 284
 285 #ifdef __GNUC__
 286
 287 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 288      if (!(expr))                                                       \
 289        {                                                                \
 290          g_log (G_LOG_DOMAIN,                                           \
 291                 G_LOG_LEVEL_CRITICAL,                                   \
 292                 "%s (%s): assertion `%s' failed.\n"                     \
 293                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
 294                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 295                 "without letting the view know.  Any display from now on is likely to\n"  \
 296                 "be incorrect.\n",                                                        \
 297                 G_STRLOC,                                               \
 298                 G_STRFUNC,                                              \
 299                 #expr);                                                 \
 300          return ret;                                                    \
 301        };                               }G_STMT_END
 302
 303 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 304      if (!(expr))                                                       \
 305        {                                                                \
 306          g_log (G_LOG_DOMAIN,                                           \
 307                 G_LOG_LEVEL_CRITICAL,                                   \
 308                 "%s (%s): assertion `%s' failed.\n"                     \
 309                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
 310                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 311                 "without letting the view know.  Any display from now on is likely to\n"  \
 312                 "be incorrect.\n",                                                        \
 313                 G_STRLOC,                                               \
 314                 G_STRFUNC,                                              \
 315                 #expr);                                                 \
 316          return;                                                        \
 317        };                               }G_STMT_END
 318
 319 #else
 320
 321 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 322      if (!(expr))                                                       \
 323        {                                                                \
 324          g_log (G_LOG_DOMAIN,                                           \
 325                 G_LOG_LEVEL_CRITICAL,                                   \
 326                 "file %s: line %d: assertion `%s' failed.\n"       \
 327                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
 328                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 329                 "without letting the view know.  Any display from now on is likely to\n"  \
 330                 "be incorrect.\n",                                                        \
 331                 __FILE__,                                               \
 332                 __LINE__,                                               \
 333                 #expr);                                                 \
 334          return ret;                                                    \
 335        };                               }G_STMT_END
 336
 337 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 338      if (!(expr))                                                       \
 339        {                                                                \
 340          g_log (G_LOG_DOMAIN,                                           \
 341                 G_LOG_LEVEL_CRITICAL,                                   \
 342                 "file %s: line %d: assertion '%s' failed.\n"            \
 343                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
 344                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 345                 "without letting the view know.  Any display from now on is likely to\n"  \
 346                 "be incorrect.\n",                                                        \
 347                 __FILE__,                                               \
 348                 __LINE__,                                               \
 349                 #expr);                                                 \
 350          return;                                                        \
 351        };                               }G_STMT_END
 352 #endif
 353
 354
 355 /* functions that shouldn't be exported */
 356 void         _pspp_sheet_selection_internal_select_node (PsppSheetSelection  *selection,
 357                                                        int                node,
 358                                                        GtkTreePath       *path,
 359                                                        PsppSheetSelectMode  mode,
 360                                                        gboolean           override_browse_mode);
 361 void         _pspp_sheet_selection_emit_changed         (PsppSheetSelection  *selection);
 362 void         _pspp_sheet_view_find_node                 (PsppSheetView       *tree_view,
 363                                                        GtkTreePath       *path,
 364                                                        int              *node);
 365 GtkTreePath *_pspp_sheet_view_find_path                 (PsppSheetView       *tree_view,
 366                                                        int                    node);
 367 void         _pspp_sheet_view_child_move_resize         (PsppSheetView       *tree_view,
 368                                                        GtkWidget         *widget,
 369                                                        gint               x,
 370                                                        gint               y,
 371                                                        gint               width,
 372                                                        gint               height);
 373 void         _pspp_sheet_view_queue_draw_node           (PsppSheetView       *tree_view,
 374                                                        int                    node,
 375                                                        const GdkRectangle *clip_rect);
 376
 377 void _pspp_sheet_view_column_realize_button   (PsppSheetViewColumn *column);
 378 void _pspp_sheet_view_column_unrealize_button (PsppSheetViewColumn *column);
 379 void _pspp_sheet_view_column_set_tree_view    (PsppSheetViewColumn *column,
 380                                              PsppSheetView       *tree_view);
 381 void _pspp_sheet_view_column_unset_model      (PsppSheetViewColumn *column,
 382                                              GtkTreeModel      *old_model);
 383 void _pspp_sheet_view_column_unset_tree_view  (PsppSheetViewColumn *column);
 384 void _pspp_sheet_view_column_set_width        (PsppSheetViewColumn *column,
 385                                              gint               width);
 386 void _pspp_sheet_view_column_start_drag       (PsppSheetView       *tree_view,
 387                                              PsppSheetViewColumn *column);
 388 gboolean _pspp_sheet_view_column_cell_event   (PsppSheetViewColumn  *tree_column,
 389                                              GtkCellEditable   **editable_widget,
 390                                              GdkEvent           *event,
 391                                              gchar              *path_string,
 392                                              const GdkRectangle *background_area,
 393                                              const GdkRectangle *cell_area,
 394                                              guint               flags);
 395 void _pspp_sheet_view_column_start_editing (PsppSheetViewColumn *tree_column,
 396                                           GtkCellEditable   *editable_widget);
 397 void _pspp_sheet_view_column_stop_editing  (PsppSheetViewColumn *tree_column);
 398 void _pspp_sheet_view_install_mark_rows_col_dirty (PsppSheetView *tree_view);
 399 void             _pspp_sheet_view_column_autosize          (PsppSheetView       *tree_view,
 400                                                           PsppSheetViewColumn *column);
 401
 402 gboolean         _pspp_sheet_view_column_has_editable_cell (PsppSheetViewColumn *column);
 403 GtkCellRenderer *_pspp_sheet_view_column_get_edited_cell   (PsppSheetViewColumn *column);
 404 gint             _pspp_sheet_view_column_count_special_cells (PsppSheetViewColumn *column);
 405 GtkCellRenderer *_pspp_sheet_view_column_get_cell_at_pos   (PsppSheetViewColumn *column,
 406                                                           gint               x);
 407
 408 PsppSheetSelection* _pspp_sheet_selection_new                (void);
 409 PsppSheetSelection* _pspp_sheet_selection_new_with_tree_view (PsppSheetView      *tree_view);
 410 void              _pspp_sheet_selection_set_tree_view      (PsppSheetSelection *selection,
 411                                                           PsppSheetView      *tree_view);
 412
 413 void              _pspp_sheet_view_column_cell_render      (PsppSheetViewColumn  *tree_column,
 414                                                             cairo_t *cr,
 415                                                           const GdkRectangle *background_area,
 416                                                           const GdkRectangle *cell_area,
 417                                                           guint               flags);
 418 void              _pspp_sheet_view_column_get_focus_area   (PsppSheetViewColumn  *tree_column,
 419                                                           const GdkRectangle *background_area,
 420                                                           const GdkRectangle *cell_area,
 421                                                           GdkRectangle       *focus_area);
 422 gboolean          _pspp_sheet_view_column_cell_focus       (PsppSheetViewColumn  *tree_column,
 423                                                           gint                direction,
 424                                                           gboolean            left,
 425                                                           gboolean            right);
 426 void              _pspp_sheet_view_column_cell_draw_focus  (PsppSheetViewColumn  *tree_column,
 427                                                             cairo_t *cr,
 428                                                           const GdkRectangle *background_area,
 429                                                           const GdkRectangle *cell_area,
 430                                                           guint               flags);
 431 void              _pspp_sheet_view_column_cell_set_dirty         (PsppSheetViewColumn  *tree_column);
 432 void              _pspp_sheet_view_column_get_neighbor_sizes (PsppSheetViewColumn *column,
 433                                                             GtkCellRenderer   *cell,
 434                                                             gint              *left,
 435                                                             gint              *right);
 436
 437 gboolean pspp_sheet_view_node_is_selected (PsppSheetView *tree_view,
 438                                            int node);
 439 void pspp_sheet_view_node_select (PsppSheetView *tree_view,
 440                                   int node);
 441 void pspp_sheet_view_node_unselect (PsppSheetView *tree_view,
 442                                     int node);
 443
 444 gint
 445 pspp_sheet_view_node_next (PsppSheetView *tree_view,
 446                            gint node);
 447 gint
 448 pspp_sheet_view_node_prev (PsppSheetView *tree_view,
 449                            gint node);
 450
 451 #endif /* __GTK_TREE_PRIVATE_H__ */
 452