pintos-os.org Git - pspp/blob - src/ui/gui/pspp-sheet-view.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 /* gtktreeview.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 __PSPP_SHEET_VIEW_H__
  37 #define __PSPP_SHEET_VIEW_H__
  38
  39 #include <gtk/gtk.h>
  40 #include "ui/gui/pspp-sheet-view-column.h"
  41
  42 G_BEGIN_DECLS
  43
  44
  45 typedef enum
  46 {
  47   PSPP_SHEET_VIEW_GRID_LINES_NONE,
  48   PSPP_SHEET_VIEW_GRID_LINES_HORIZONTAL,
  49   PSPP_SHEET_VIEW_GRID_LINES_VERTICAL,
  50   PSPP_SHEET_VIEW_GRID_LINES_BOTH
  51 } PsppSheetViewGridLines;
  52
  53 GType pspp_sheet_view_grid_lines_get_type (void) G_GNUC_CONST;
  54 #define PSPP_TYPE_SHEET_VIEW_GRID_LINES (pspp_sheet_view_grid_lines_get_type ())
  55
  56 /* A "special cell" is a cell that is editable or activatable.  When a row that
  57  * contains a special cell is selected, the cursor is drawn around a single
  58  * cell; when other rows are selected, the cursor is drawn around the entire
  59  * row.
  60  *
  61  * With the default of "detect", whether a given row contains a special cell is
  62  * detected automatically.  This is the best choice most of the time.  For
  63  * sheet views that contain more than 100 columns, an explicit "yes" or "no"
  64  * improves performance. */
  65 typedef enum
  66 {
  67   PSPP_SHEET_VIEW_SPECIAL_CELLS_DETECT,
  68   PSPP_SHEET_VIEW_SPECIAL_CELLS_YES,
  69   PSPP_SHEET_VIEW_SPECIAL_CELLS_NO,
  70 } PsppSheetViewSpecialCells;
  71
  72 GType pspp_sheet_view_special_cells_get_type (void) G_GNUC_CONST;
  73 #define PSPP_TYPE_SHEET_VIEW_SPECIAL_CELLS (pspp_sheet_view_special_cells_get_type ())
  74
  75 typedef enum
  76 {
  77   /* drop before/after this row */
  78   PSPP_SHEET_VIEW_DROP_BEFORE,
  79   PSPP_SHEET_VIEW_DROP_AFTER,
  80   /* drop as a child of this row (with fallback to before or after
  81    * if into is not possible)
  82    */
  83   PSPP_SHEET_VIEW_DROP_INTO_OR_BEFORE,
  84   PSPP_SHEET_VIEW_DROP_INTO_OR_AFTER
  85 } PsppSheetViewDropPosition;
  86
  87 #define PSPP_TYPE_SHEET_VIEW            (pspp_sheet_view_get_type ())
  88 #define PSPP_SHEET_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), PSPP_TYPE_SHEET_VIEW, PsppSheetView))
  89 #define PSPP_SHEET_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PSPP_TYPE_SHEET_VIEW, PsppSheetViewClass))
  90 #define PSPP_IS_SHEET_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PSPP_TYPE_SHEET_VIEW))
  91 #define PSPP_IS_SHEET_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPP_TYPE_SHEET_VIEW))
  92 #define PSPP_SHEET_VIEW_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PSPP_TYPE_SHEET_VIEW, PsppSheetViewClass))
  93
  94 typedef struct _PsppSheetView           PsppSheetView;
  95 typedef struct _PsppSheetViewClass      PsppSheetViewClass;
  96 typedef struct _PsppSheetViewPrivate    PsppSheetViewPrivate;
  97 typedef struct _PsppSheetSelection      PsppSheetSelection;
  98 typedef struct _PsppSheetSelectionClass PsppSheetSelectionClass;
  99
 100 struct _PsppSheetView
 101 {
 102   GtkContainer parent;
 103
 104   PsppSheetViewPrivate *GSEAL (priv);
 105 };
 106
 107 struct _PsppSheetViewClass
 108 {
 109   GtkContainerClass parent_class;
 110
 111   void     (* set_scroll_adjustments)     (PsppSheetView       *tree_view,
 112                                            GtkAdjustment     *hadjustment,
 113                                            GtkAdjustment     *vadjustment);
 114   void     (* row_activated)              (PsppSheetView       *tree_view,
 115                                            GtkTreePath       *path,
 116                                            PsppSheetViewColumn *column);
 117   void     (* columns_changed)            (PsppSheetView       *tree_view);
 118   void     (* cursor_changed)             (PsppSheetView       *tree_view);
 119
 120   /* Key Binding signals */
 121   gboolean (* move_cursor)                (PsppSheetView       *tree_view,
 122                                            GtkMovementStep    step,
 123                                            gint               count);
 124   gboolean (* select_all)                 (PsppSheetView       *tree_view);
 125   gboolean (* unselect_all)               (PsppSheetView       *tree_view);
 126   gboolean (* select_cursor_row)          (PsppSheetView       *tree_view,
 127                                            gboolean           start_editing);
 128   gboolean (* toggle_cursor_row)          (PsppSheetView       *tree_view);
 129   gboolean (* select_cursor_parent)       (PsppSheetView       *tree_view);
 130   gboolean (* start_interactive_search)   (PsppSheetView       *tree_view);
 131
 132   /* Padding for future expansion */
 133   void (*_gtk_reserved0) (void);
 134   void (*_gtk_reserved1) (void);
 135   void (*_gtk_reserved2) (void);
 136   void (*_gtk_reserved3) (void);
 137   void (*_gtk_reserved4) (void);
 138 };
 139
 140
 141 typedef gboolean (* PsppSheetViewColumnDropFunc) (PsppSheetView             *tree_view,
 142                                                 PsppSheetViewColumn       *column,
 143                                                 PsppSheetViewColumn       *prev_column,
 144                                                 PsppSheetViewColumn       *next_column,
 145                                                 gpointer                 data);
 146 typedef void     (* PsppSheetViewMappingFunc)    (PsppSheetView             *tree_view,
 147                                                 GtkTreePath             *path,
 148                                                 gpointer                 user_data);
 149 typedef gboolean (*PsppSheetViewSearchEqualFunc) (GtkTreeModel            *model,
 150                                                 gint                     column,
 151                                                 const gchar             *key,
 152                                                 GtkTreeIter             *iter,
 153                                                 gpointer                 search_data);
 154 typedef void     (*PsppSheetViewSearchPositionFunc) (PsppSheetView  *tree_view,
 155                                                    GtkWidget    *search_dialog,
 156                                                    gpointer      user_data);
 157
 158
 159 /* Creators */
 160 GType                  pspp_sheet_view_get_type                      (void) G_GNUC_CONST;
 161 GtkWidget             *pspp_sheet_view_new                           (void);
 162 GtkWidget             *pspp_sheet_view_new_with_model                (GtkTreeModel              *model);
 163
 164 /* Accessors */
 165 GtkTreeModel          *pspp_sheet_view_get_model                     (PsppSheetView               *tree_view);
 166 void                   pspp_sheet_view_set_model                     (PsppSheetView               *tree_view,
 167                                                                     GtkTreeModel              *model);
 168 PsppSheetSelection      *pspp_sheet_view_get_selection                 (PsppSheetView               *tree_view);
 169 GtkAdjustment         *pspp_sheet_view_get_hadjustment               (PsppSheetView               *tree_view);
 170 void                   pspp_sheet_view_set_hadjustment               (PsppSheetView               *tree_view,
 171                                                                     GtkAdjustment             *adjustment);
 172 GtkAdjustment         *pspp_sheet_view_get_vadjustment               (PsppSheetView               *tree_view);
 173 void                   pspp_sheet_view_set_vadjustment               (PsppSheetView               *tree_view,
 174                                                                     GtkAdjustment             *adjustment);
 175 gboolean               pspp_sheet_view_get_headers_visible           (PsppSheetView               *tree_view);
 176 void                   pspp_sheet_view_set_headers_visible           (PsppSheetView               *tree_view,
 177                                                                     gboolean                   headers_visible);
 178 void                   pspp_sheet_view_columns_autosize              (PsppSheetView               *tree_view);
 179 gboolean               pspp_sheet_view_get_headers_clickable         (PsppSheetView *tree_view);
 180 void                   pspp_sheet_view_set_headers_clickable         (PsppSheetView               *tree_view,
 181                                                                     gboolean                   setting);
 182 void                   pspp_sheet_view_set_rules_hint                (PsppSheetView               *tree_view,
 183                                                                     gboolean                   setting);
 184 gboolean               pspp_sheet_view_get_rules_hint                (PsppSheetView               *tree_view);
 185
 186 /* Column funtions */
 187 gint                   pspp_sheet_view_append_column                 (PsppSheetView               *tree_view,
 188                                                                     PsppSheetViewColumn         *column);
 189 gint                   pspp_sheet_view_remove_column                 (PsppSheetView               *tree_view,
 190                                                                     PsppSheetViewColumn         *column);
 191 gint                   pspp_sheet_view_insert_column                 (PsppSheetView               *tree_view,
 192                                                                     PsppSheetViewColumn         *column,
 193                                                                     gint                       position);
 194 gint                   pspp_sheet_view_insert_column_with_attributes (PsppSheetView               *tree_view,
 195                                                                     gint                       position,
 196                                                                     const gchar               *title,
 197                                                                     GtkCellRenderer           *cell,
 198                                                                     ...) G_GNUC_NULL_TERMINATED;
 199 gint                   pspp_sheet_view_insert_column_with_data_func  (PsppSheetView               *tree_view,
 200                                                                     gint                       position,
 201                                                                     const gchar               *title,
 202                                                                     GtkCellRenderer           *cell,
 203                                                                     PsppSheetCellDataFunc        func,
 204                                                                     gpointer                   data,
 205                                                                     GDestroyNotify             dnotify);
 206 PsppSheetViewColumn     *pspp_sheet_view_get_column                    (PsppSheetView               *tree_view,
 207                                                                     gint                       n);
 208 GList                 *pspp_sheet_view_get_columns                   (PsppSheetView               *tree_view);
 209 void                   pspp_sheet_view_move_column_after             (PsppSheetView               *tree_view,
 210                                                                     PsppSheetViewColumn         *column,
 211                                                                     PsppSheetViewColumn         *base_column);
 212 void                   pspp_sheet_view_set_column_drag_function      (PsppSheetView               *tree_view,
 213                                                                     PsppSheetViewColumnDropFunc  func,
 214                                                                     gpointer                   user_data,
 215                                                                     GDestroyNotify             destroy);
 216
 217 /* Actions */
 218 void                   pspp_sheet_view_scroll_to_point               (PsppSheetView               *tree_view,
 219                                                                     gint                       tree_x,
 220                                                                     gint                       tree_y);
 221 void                   pspp_sheet_view_scroll_to_cell                (PsppSheetView               *tree_view,
 222                                                                     GtkTreePath               *path,
 223                                                                     PsppSheetViewColumn         *column,
 224                                                                     gboolean                   use_align,
 225                                                                     gfloat                     row_align,
 226                                                                     gfloat                     col_align);
 227 void                   pspp_sheet_view_row_activated                 (PsppSheetView               *tree_view,
 228                                                                     GtkTreePath               *path,
 229                                                                     PsppSheetViewColumn         *column);
 230 void                   pspp_sheet_view_set_reorderable               (PsppSheetView               *tree_view,
 231                                                                     gboolean                   reorderable);
 232 gboolean               pspp_sheet_view_get_reorderable               (PsppSheetView               *tree_view);
 233 void                   pspp_sheet_view_set_cursor                    (PsppSheetView               *tree_view,
 234                                                                     GtkTreePath               *path,
 235                                                                     PsppSheetViewColumn         *focus_column,
 236                                                                     gboolean                   start_editing);
 237 void                   pspp_sheet_view_set_cursor_on_cell            (PsppSheetView               *tree_view,
 238                                                                     GtkTreePath               *path,
 239                                                                     PsppSheetViewColumn         *focus_column,
 240                                                                     GtkCellRenderer           *focus_cell,
 241                                                                     gboolean                   start_editing);
 242 void                   pspp_sheet_view_get_cursor                    (PsppSheetView               *tree_view,
 243                                                                     GtkTreePath              **path,
 244                                                                     PsppSheetViewColumn        **focus_column);
 245
 246
 247 /* Layout information */
 248 GdkWindow             *pspp_sheet_view_get_bin_window                (PsppSheetView               *tree_view);
 249 gboolean               pspp_sheet_view_get_path_at_pos               (PsppSheetView               *tree_view,
 250                                                                     gint                       x,
 251                                                                     gint                       y,
 252                                                                     GtkTreePath              **path,
 253                                                                     PsppSheetViewColumn        **column,
 254                                                                     gint                      *cell_x,
 255                                                                     gint                      *cell_y);
 256 void                   pspp_sheet_view_get_cell_area                 (PsppSheetView               *tree_view,
 257                                                                     GtkTreePath               *path,
 258                                                                     PsppSheetViewColumn         *column,
 259                                                                     GdkRectangle              *rect);
 260 void                   pspp_sheet_view_get_background_area           (PsppSheetView               *tree_view,
 261                                                                     GtkTreePath               *path,
 262                                                                     PsppSheetViewColumn         *column,
 263                                                                     GdkRectangle              *rect);
 264 void                   pspp_sheet_view_get_visible_rect              (PsppSheetView               *tree_view,
 265                                                                     GdkRectangle              *visible_rect);
 266
 267 #ifndef GTK_DISABLE_DEPRECATED
 268 void                   pspp_sheet_view_widget_to_tree_coords         (PsppSheetView               *tree_view,
 269                                                                     gint                       wx,
 270                                                                     gint                       wy,
 271                                                                     gint                      *tx,
 272                                                                     gint                      *ty);
 273 void                   pspp_sheet_view_tree_to_widget_coords         (PsppSheetView               *tree_view,
 274                                                                     gint                       tx,
 275                                                                     gint                       ty,
 276                                                                     gint                      *wx,
 277                                                                     gint                      *wy);
 278 #endif /* !GTK_DISABLE_DEPRECATED */
 279 gboolean               pspp_sheet_view_get_visible_range             (PsppSheetView               *tree_view,
 280                                                                     GtkTreePath              **start_path,
 281                                                                     GtkTreePath              **end_path);
 282
 283 /* Drag-and-Drop support */
 284 void                   pspp_sheet_view_enable_model_drag_source      (PsppSheetView               *tree_view,
 285                                                                     GdkModifierType            start_button_mask,
 286                                                                     const GtkTargetEntry      *targets,
 287                                                                     gint                       n_targets,
 288                                                                     GdkDragAction              actions);
 289 void                   pspp_sheet_view_enable_model_drag_dest        (PsppSheetView               *tree_view,
 290                                                                     const GtkTargetEntry      *targets,
 291                                                                     gint                       n_targets,
 292                                                                     GdkDragAction              actions);
 293 void                   pspp_sheet_view_unset_rows_drag_source        (PsppSheetView               *tree_view);
 294 void                   pspp_sheet_view_unset_rows_drag_dest          (PsppSheetView               *tree_view);
 295
 296
 297 /* These are useful to implement your own custom stuff. */
 298 void                   pspp_sheet_view_set_drag_dest_row             (PsppSheetView               *tree_view,
 299                                                                     GtkTreePath               *path,
 300                                                                     PsppSheetViewDropPosition    pos);
 301 void                   pspp_sheet_view_get_drag_dest_row             (PsppSheetView               *tree_view,
 302                                                                     GtkTreePath              **path,
 303                                                                     PsppSheetViewDropPosition   *pos);
 304 gboolean               pspp_sheet_view_get_dest_row_at_pos           (PsppSheetView               *tree_view,
 305                                                                     gint                       drag_x,
 306                                                                     gint                       drag_y,
 307                                                                     GtkTreePath              **path,
 308                                                                     PsppSheetViewDropPosition   *pos);
 309 GdkPixmap             *pspp_sheet_view_create_row_drag_icon          (PsppSheetView               *tree_view,
 310                                                                     GtkTreePath               *path);
 311
 312 /* Interactive search */
 313 void                       pspp_sheet_view_set_enable_search     (PsppSheetView                *tree_view,
 314                                                                 gboolean                    enable_search);
 315 gboolean                   pspp_sheet_view_get_enable_search     (PsppSheetView                *tree_view);
 316 gint                       pspp_sheet_view_get_search_column     (PsppSheetView                *tree_view);
 317 void                       pspp_sheet_view_set_search_column     (PsppSheetView                *tree_view,
 318                                                                 gint                        column);
 319 PsppSheetViewSearchEqualFunc pspp_sheet_view_get_search_equal_func (PsppSheetView                *tree_view);
 320 void                       pspp_sheet_view_set_search_equal_func (PsppSheetView                *tree_view,
 321                                                                 PsppSheetViewSearchEqualFunc  search_equal_func,
 322                                                                 gpointer                    search_user_data,
 323                                                                 GDestroyNotify              search_destroy);
 324
 325 GtkEntry                     *pspp_sheet_view_get_search_entry         (PsppSheetView                   *tree_view);
 326 void                          pspp_sheet_view_set_search_entry         (PsppSheetView                   *tree_view,
 327                                                                       GtkEntry                      *entry);
 328 PsppSheetViewSearchPositionFunc pspp_sheet_view_get_search_position_func (PsppSheetView                   *tree_view);
 329 void                          pspp_sheet_view_set_search_position_func (PsppSheetView                   *tree_view,
 330                                                                       PsppSheetViewSearchPositionFunc  func,
 331                                                                       gpointer                       data,
 332                                                                       GDestroyNotify                 destroy);
 333
 334 /* Convert between the different coordinate systems */
 335 void pspp_sheet_view_convert_widget_to_tree_coords       (PsppSheetView *tree_view,
 336                                                         gint         wx,
 337                                                         gint         wy,
 338                                                         gint        *tx,
 339                                                         gint        *ty);
 340 void pspp_sheet_view_convert_tree_to_widget_coords       (PsppSheetView *tree_view,
 341                                                         gint         tx,
 342                                                         gint         ty,
 343                                                         gint        *wx,
 344                                                         gint        *wy);
 345 void pspp_sheet_view_convert_widget_to_bin_window_coords (PsppSheetView *tree_view,
 346                                                         gint         wx,
 347                                                         gint         wy,
 348                                                         gint        *bx,
 349                                                         gint        *by);
 350 void pspp_sheet_view_convert_bin_window_to_widget_coords (PsppSheetView *tree_view,
 351                                                         gint         bx,
 352                                                         gint         by,
 353                                                         gint        *wx,
 354                                                         gint        *wy);
 355 void pspp_sheet_view_convert_tree_to_bin_window_coords   (PsppSheetView *tree_view,
 356                                                         gint         tx,
 357                                                         gint         ty,
 358                                                         gint        *bx,
 359                                                         gint        *by);
 360 void pspp_sheet_view_convert_bin_window_to_tree_coords   (PsppSheetView *tree_view,
 361                                                         gint         bx,
 362                                                         gint         by,
 363                                                         gint        *tx,
 364                                                         gint        *ty);
 365
 366 /* This function should really never be used.  It is just for use by ATK.
 367  */
 368 typedef void (* PsppSheetDestroyCountFunc)  (PsppSheetView             *tree_view,
 369                                            GtkTreePath             *path,
 370                                            gint                     children,
 371                                            gpointer                 user_data);
 372 void pspp_sheet_view_set_destroy_count_func (PsppSheetView             *tree_view,
 373                                            PsppSheetDestroyCountFunc  func,
 374                                            gpointer                 data,
 375                                            GDestroyNotify           destroy);
 376
 377 void     pspp_sheet_view_set_hover_selection   (PsppSheetView          *tree_view,
 378                                               gboolean              hover);
 379 gboolean pspp_sheet_view_get_hover_selection   (PsppSheetView          *tree_view);
 380 void     pspp_sheet_view_set_rubber_banding    (PsppSheetView          *tree_view,
 381                                               gboolean              enable);
 382 gboolean pspp_sheet_view_get_rubber_banding    (PsppSheetView          *tree_view);
 383
 384 gboolean pspp_sheet_view_is_rubber_banding_active (PsppSheetView       *tree_view);
 385
 386 PsppSheetViewGridLines        pspp_sheet_view_get_grid_lines         (PsppSheetView                *tree_view);
 387 void                        pspp_sheet_view_set_grid_lines         (PsppSheetView                *tree_view,
 388                                                                   PsppSheetViewGridLines        grid_lines);
 389
 390 PsppSheetViewSpecialCells pspp_sheet_view_get_special_cells (PsppSheetView                *tree_view);
 391 void                        pspp_sheet_view_set_special_cells (PsppSheetView                *tree_view,
 392                                                                PsppSheetViewSpecialCells);
 393
 394
 395 /* Convenience functions for setting tooltips */
 396 void          pspp_sheet_view_set_tooltip_row    (PsppSheetView       *tree_view,
 397                                                 GtkTooltip        *tooltip,
 398                                                 GtkTreePath       *path);
 399 void          pspp_sheet_view_set_tooltip_cell   (PsppSheetView       *tree_view,
 400                                                 GtkTooltip        *tooltip,
 401                                                 GtkTreePath       *path,
 402                                                 PsppSheetViewColumn *column,
 403                                                 GtkCellRenderer   *cell);
 404 gboolean      pspp_sheet_view_get_tooltip_context(PsppSheetView       *tree_view,
 405                                                 gint              *x,
 406                                                 gint              *y,
 407                                                 gboolean           keyboard_tip,
 408                                                 GtkTreeModel     **model,
 409                                                 GtkTreePath      **path,
 410                                                 GtkTreeIter       *iter);
 411 void          pspp_sheet_view_set_tooltip_column (PsppSheetView       *tree_view,
 412                                                 gint               column);
 413 gint          pspp_sheet_view_get_tooltip_column (PsppSheetView       *tree_view);
 414
 415 void pspp_sheet_view_stop_editing (PsppSheetView *tree_view,
 416                                    gboolean     cancel_editing);
 417
 418 G_END_DECLS
 419
 420
 421 #endif /* __PSPP_SHEET_VIEW_H__ */