CORRELATIONS: Fixed bug displaying non-sqaure correlation matrices
[pspp] / src / ui / gui / pspp-sheet-private.h
1  /* PSPPIRE - a graphical user interface for PSPP.
2     Copyright (C) 2011, 2012 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   GTK_TREE_SELECT_MODE_TOGGLE = 1 << 0,
59   GTK_TREE_SELECT_MODE_EXTEND = 1 << 1
60 }
61 GtkTreeSelectMode;
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
161   /* Selection information */
162   PsppSheetSelection *selection;
163
164   /* Header information */
165   gint n_columns;
166   GList *columns;
167   gint header_height;
168   gint n_selected_columns;
169
170   PsppSheetViewColumnDropFunc column_drop_func;
171   gpointer column_drop_func_data;
172   GDestroyNotify column_drop_func_data_destroy;
173   GList *column_drag_info;
174   PsppSheetViewColumnReorder *cur_reorder;
175
176   /* Interactive Header reordering */
177   GdkWindow *drag_window;
178   GdkWindow *drag_highlight_window;
179   PsppSheetViewColumn *drag_column;
180   gint drag_column_x;
181
182   /* Interactive Header Resizing */
183   gint drag_pos;
184   gint x_drag;
185
186   /* Non-interactive Header Resizing, expand flag support */
187   gint prev_width;
188
189   /* ATK Hack */
190   PsppSheetDestroyCountFunc destroy_count_func;
191   gpointer destroy_count_data;
192   GDestroyNotify destroy_count_destroy;
193
194   /* Scroll timeout (e.g. during dnd, rubber banding) */
195   guint scroll_timeout;
196
197   /* Row drag-and-drop */
198   GtkTreeRowReference *drag_dest_row;
199   PsppSheetViewDropPosition drag_dest_pos;
200   guint open_dest_timeout;
201
202   /* Rubber banding */
203   gint rubber_band_status;
204   gint rubber_band_x;
205   gint rubber_band_y;
206   gint rubber_band_shift;
207   gint rubber_band_ctrl;
208
209   int rubber_band_start_node;
210
211   int rubber_band_end_node;
212
213   /* Rectangular selection. */
214   PsppSheetViewColumn *anchor_column; /* XXX needs to be a weak pointer? */
215
216   /* fixed height */
217   gint fixed_height;
218   gboolean fixed_height_set;
219
220   /* Scroll-to functionality when unrealized */
221   GtkTreeRowReference *scroll_to_path;
222   PsppSheetViewColumn *scroll_to_column;
223   gfloat scroll_to_row_align;
224   gfloat scroll_to_col_align;
225
226   /* Interactive search */
227   gint selected_iter;
228   gint search_column;
229   PsppSheetViewSearchPositionFunc search_position_func;
230   PsppSheetViewSearchEqualFunc search_equal_func;
231   gpointer search_user_data;
232   GDestroyNotify search_destroy;
233   gpointer search_position_user_data;
234   GDestroyNotify search_position_destroy;
235   GtkWidget *search_window;
236   GtkWidget *search_entry;
237   guint search_entry_changed_id;
238   guint typeselect_flush_timeout;
239
240   /* Grid and tree lines */
241   PsppSheetViewGridLines grid_lines;
242   GdkGC *grid_line_gc;
243
244   /* Special cells. */
245   PsppSheetViewSpecialCells special_cells;
246
247   /* Tooltip support */
248   gint tooltip_column;
249
250   /* Cached style for button facades in columns. */
251   GtkStyle *button_style;
252
253   /* Here comes the bitfield */
254   guint scroll_to_use_align : 1;
255
256   guint reorderable : 1;
257   guint header_has_focus : 1;
258   guint drag_column_window_state : 3;
259   /* hint to display rows in alternating colors */
260   guint has_rules : 1;
261
262   /* for DnD */
263   guint empty_view_drop : 1;
264
265   guint ctrl_pressed : 1;
266   guint shift_pressed : 1;
267
268   guint init_hadjust_value : 1;
269
270   guint in_top_row_to_dy : 1;
271
272   /* interactive search */
273   guint enable_search : 1;
274   guint disable_popdown : 1;
275   guint search_custom_entry_set : 1;
276   
277   guint hover_selection : 1;
278   guint imcontext_changed : 1;
279
280   guint rubber_banding_enable : 1;
281
282   guint in_grab : 1;
283
284   guint post_validation_flag : 1;
285
286   /* Whether our key press handler is to avoid sending an unhandled binding to the search entry */
287   guint search_entry_avoid_unhandled_binding : 1;
288 };
289
290 #ifdef __GNUC__
291
292 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
293      if (!(expr))                                                       \
294        {                                                                \
295          g_log (G_LOG_DOMAIN,                                           \
296                 G_LOG_LEVEL_CRITICAL,                                   \
297                 "%s (%s): assertion `%s' failed.\n"                     \
298                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
299                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
300                 "without letting the view know.  Any display from now on is likely to\n"  \
301                 "be incorrect.\n",                                                        \
302                 G_STRLOC,                                               \
303                 G_STRFUNC,                                              \
304                 #expr);                                                 \
305          return ret;                                                    \
306        };                               }G_STMT_END
307
308 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
309      if (!(expr))                                                       \
310        {                                                                \
311          g_log (G_LOG_DOMAIN,                                           \
312                 G_LOG_LEVEL_CRITICAL,                                   \
313                 "%s (%s): assertion `%s' failed.\n"                     \
314                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
315                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
316                 "without letting the view know.  Any display from now on is likely to\n"  \
317                 "be incorrect.\n",                                                        \
318                 G_STRLOC,                                               \
319                 G_STRFUNC,                                              \
320                 #expr);                                                 \
321          return;                                                        \
322        };                               }G_STMT_END
323
324 #else
325
326 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
327      if (!(expr))                                                       \
328        {                                                                \
329          g_log (G_LOG_DOMAIN,                                           \
330                 G_LOG_LEVEL_CRITICAL,                                   \
331                 "file %s: line %d: assertion `%s' failed.\n"       \
332                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
333                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
334                 "without letting the view know.  Any display from now on is likely to\n"  \
335                 "be incorrect.\n",                                                        \
336                 __FILE__,                                               \
337                 __LINE__,                                               \
338                 #expr);                                                 \
339          return ret;                                                    \
340        };                               }G_STMT_END
341
342 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
343      if (!(expr))                                                       \
344        {                                                                \
345          g_log (G_LOG_DOMAIN,                                           \
346                 G_LOG_LEVEL_CRITICAL,                                   \
347                 "file %s: line %d: assertion '%s' failed.\n"            \
348                 "There is a disparity between the internal view of the PsppSheetView,\n"    \
349                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
350                 "without letting the view know.  Any display from now on is likely to\n"  \
351                 "be incorrect.\n",                                                        \
352                 __FILE__,                                               \
353                 __LINE__,                                               \
354                 #expr);                                                 \
355          return;                                                        \
356        };                               }G_STMT_END
357 #endif
358
359
360 /* functions that shouldn't be exported */
361 void         _pspp_sheet_selection_internal_select_node (PsppSheetSelection  *selection,
362                                                        int                node,
363                                                        GtkTreePath       *path,
364                                                        GtkTreeSelectMode  mode,
365                                                        gboolean           override_browse_mode);
366 void         _pspp_sheet_selection_emit_changed         (PsppSheetSelection  *selection);
367 void         _pspp_sheet_view_find_node                 (PsppSheetView       *tree_view,
368                                                        GtkTreePath       *path,
369                                                        int              *node);
370 GtkTreePath *_pspp_sheet_view_find_path                 (PsppSheetView       *tree_view,
371                                                        int                    node);
372 void         _pspp_sheet_view_child_move_resize         (PsppSheetView       *tree_view,
373                                                        GtkWidget         *widget,
374                                                        gint               x,
375                                                        gint               y,
376                                                        gint               width,
377                                                        gint               height);
378 void         _pspp_sheet_view_queue_draw_node           (PsppSheetView       *tree_view,
379                                                        int                    node,
380                                                        const GdkRectangle *clip_rect);
381
382 void _pspp_sheet_view_column_realize_button   (PsppSheetViewColumn *column);
383 void _pspp_sheet_view_column_unrealize_button (PsppSheetViewColumn *column);
384 void _pspp_sheet_view_column_set_tree_view    (PsppSheetViewColumn *column,
385                                              PsppSheetView       *tree_view);
386 void _pspp_sheet_view_column_unset_model      (PsppSheetViewColumn *column,
387                                              GtkTreeModel      *old_model);
388 void _pspp_sheet_view_column_unset_tree_view  (PsppSheetViewColumn *column);
389 void _pspp_sheet_view_column_set_width        (PsppSheetViewColumn *column,
390                                              gint               width);
391 void _pspp_sheet_view_column_start_drag       (PsppSheetView       *tree_view,
392                                              PsppSheetViewColumn *column);
393 gboolean _pspp_sheet_view_column_cell_event   (PsppSheetViewColumn  *tree_column,
394                                              GtkCellEditable   **editable_widget,
395                                              GdkEvent           *event,
396                                              gchar              *path_string,
397                                              const GdkRectangle *background_area,
398                                              const GdkRectangle *cell_area,
399                                              guint               flags);
400 void _pspp_sheet_view_column_start_editing (PsppSheetViewColumn *tree_column,
401                                           GtkCellEditable   *editable_widget);
402 void _pspp_sheet_view_column_stop_editing  (PsppSheetViewColumn *tree_column);
403 void _pspp_sheet_view_install_mark_rows_col_dirty (PsppSheetView *tree_view);
404 void             _pspp_sheet_view_column_autosize          (PsppSheetView       *tree_view,
405                                                           PsppSheetViewColumn *column);
406
407 gboolean         _pspp_sheet_view_column_has_editable_cell (PsppSheetViewColumn *column);
408 GtkCellRenderer *_pspp_sheet_view_column_get_edited_cell   (PsppSheetViewColumn *column);
409 gint             _pspp_sheet_view_column_count_special_cells (PsppSheetViewColumn *column);
410 GtkCellRenderer *_pspp_sheet_view_column_get_cell_at_pos   (PsppSheetViewColumn *column,
411                                                           gint               x);
412
413 PsppSheetSelection* _pspp_sheet_selection_new                (void);
414 PsppSheetSelection* _pspp_sheet_selection_new_with_tree_view (PsppSheetView      *tree_view);
415 void              _pspp_sheet_selection_set_tree_view      (PsppSheetSelection *selection,
416                                                           PsppSheetView      *tree_view);
417
418 void              _pspp_sheet_view_column_cell_render      (PsppSheetViewColumn  *tree_column,
419                                                           GdkWindow          *window,
420                                                           const GdkRectangle *background_area,
421                                                           const GdkRectangle *cell_area,
422                                                           const GdkRectangle *expose_area,
423                                                           guint               flags);
424 void              _pspp_sheet_view_column_get_focus_area   (PsppSheetViewColumn  *tree_column,
425                                                           const GdkRectangle *background_area,
426                                                           const GdkRectangle *cell_area,
427                                                           GdkRectangle       *focus_area);
428 gboolean          _pspp_sheet_view_column_cell_focus       (PsppSheetViewColumn  *tree_column,
429                                                           gint                direction,
430                                                           gboolean            left,
431                                                           gboolean            right);
432 void              _pspp_sheet_view_column_cell_draw_focus  (PsppSheetViewColumn  *tree_column,
433                                                           GdkWindow          *window,
434                                                           const GdkRectangle *background_area,
435                                                           const GdkRectangle *cell_area,
436                                                           const GdkRectangle *expose_area,
437                                                           guint               flags);
438 void              _pspp_sheet_view_column_cell_set_dirty         (PsppSheetViewColumn  *tree_column);
439 void              _pspp_sheet_view_column_get_neighbor_sizes (PsppSheetViewColumn *column,
440                                                             GtkCellRenderer   *cell,
441                                                             gint              *left,
442                                                             gint              *right);
443
444 gboolean pspp_sheet_view_node_is_selected (PsppSheetView *tree_view,
445                                            int node);
446 void pspp_sheet_view_node_select (PsppSheetView *tree_view,
447                                   int node);
448 void pspp_sheet_view_node_unselect (PsppSheetView *tree_view,
449                                     int node);
450
451 gint
452 pspp_sheet_view_node_next (PsppSheetView *tree_view,
453                            gint node);
454 gint
455 pspp_sheet_view_node_prev (PsppSheetView *tree_view,
456                            gint node);
457
458 #endif /* __GTK_TREE_PRIVATE_H__ */
459