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