lib/gtksheet/gtksheet.h

   1 /* This version of GtkSheet has been heavily modified, for the specific
   2    requirements of PSPPIRE. */
   3
   4
   5 /* GtkSheet widget for Gtk+.
   6  * Copyright (C) 1999-2001 Adrian E. Feiguin <adrian@ifir.ifir.edu.ar>
   7  *
   8  * Based on GtkClist widget by Jay Painter, but major changes.
   9  * Memory allocation routines inspired on SC (Spreadsheet Calculator)
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; either
  14  * version 2.1 of the License, or (at your option) any later version.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  24  */
  25
  26 #ifndef __GTK_SHEET_H__
  27 #define __GTK_SHEET_H__
  28
  29 #include <gtk/gtk.h>
  30
  31 #include "gtkextra-sheet.h"
  32 #include "gsheetmodel.h"
  33 #include "psppire-axis.h"
  34
  35 G_BEGIN_DECLS
  36
  37 /* sheet->state */
  38 enum
  39 {
  40   GTK_SHEET_NORMAL,
  41   GTK_SHEET_ROW_SELECTED,
  42   GTK_SHEET_COLUMN_SELECTED,
  43   GTK_SHEET_RANGE_SELECTED
  44 };
  45
  46
  47 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
  48 #define GTK_TYPE_SHEET_CELL (gtk_sheet_cell_get_type ())
  49 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
  50
  51 #define GTK_SHEET(obj)          GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
  52 #define GTK_SHEET_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
  53 #define GTK_IS_SHEET(obj)       GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
  54
  55
  56 typedef struct _GtkSheetClass GtkSheetClass;
  57 typedef struct _GtkSheetCellAttr     GtkSheetCellAttr;
  58
  59 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
  60
  61
  62 struct _GtkSheetCellAttr
  63 {
  64   GtkJustification justification;
  65   const PangoFontDescription *font_desc;
  66   GdkColor foreground;
  67   GdkColor background;
  68   GtkSheetCellBorder border;
  69   gboolean is_editable;
  70 };
  71
  72 struct _GtkSheetHoverTitle
  73 {
  74   GtkWidget *window;
  75   GtkWidget *label;
  76   gint row, column;
  77 };
  78
  79 enum
  80   {
  81     BG_COLOR,
  82     GRID_COLOR,
  83     n_COLORS
  84   };
  85
  86 struct _GtkSheet
  87 {
  88   GtkBin parent;
  89
  90   gboolean dispose_has_run;
  91   PsppireAxis *haxis;
  92   PsppireAxis *vaxis;
  93
  94   guint16 flags;
  95
  96   GSheetModel *model;
  97
  98   GtkSelectionMode selection_mode;
  99
 100   /* Component colors */
 101   GdkColor color[n_COLORS];
 102   gboolean show_grid;
 103
 104   gint16 column_requisition;
 105   gint16 row_requisition;
 106
 107   gboolean rows_resizable;
 108   gboolean columns_resizable;
 109
 110   /* active cell */
 111   GtkSheetCell active_cell;
 112
 113   /* The GtkEntry used for editing the cells */
 114   GtkWidget *entry_widget;
 115
 116   /* The type of entry_widget */
 117   GtkType entry_type;
 118
 119   /* Handler of the "changed" callback for the entry widget */
 120   glong entry_handler_id;
 121
 122   /* expanding selection */
 123   GtkSheetCell selection_cell;
 124
 125   /* global selection button */
 126   GtkWidget *button;
 127
 128   /* sheet state */
 129   gint state;
 130
 131   /* selected range */
 132   GtkSheetRange range;
 133
 134   /* the scrolling window and its height and width to
 135    * make things a little speedier */
 136   GdkWindow *sheet_window;
 137
 138   /* border shadow style */
 139   GtkShadowType shadow_type;
 140
 141   /* Column Titles */
 142   GdkRectangle column_title_area;
 143   GdkWindow *column_title_window;
 144   gboolean column_titles_visible;
 145   /* TRUE if the cursor is over the column title window */
 146   gboolean column_title_under;
 147
 148   /* Row Titles */
 149   GdkRectangle row_title_area;
 150   GdkWindow *row_title_window;
 151   gboolean row_titles_visible;
 152   /* TRUE if the cursor is over the row title window */
 153   gboolean row_title_under;
 154
 155   /*scrollbars*/
 156   GtkAdjustment *hadjustment;
 157   GtkAdjustment *vadjustment;
 158
 159   /* xor GC for the verticle drag line */
 160   GdkGC *xor_gc;
 161
 162   /* gc for drawing unselected cells */
 163   GdkGC *fg_gc;
 164   GdkGC *bg_gc;
 165
 166   /* cursor used to indicate dragging */
 167   GdkCursor *cursor_drag;
 168
 169   /* the current x-pixel location of the xor-drag vline */
 170   gint x_drag;
 171
 172   /* the current y-pixel location of the xor-drag hline */
 173   gint y_drag;
 174
 175   /* current cell being dragged */
 176   GtkSheetCell drag_cell;
 177   /* current range being dragged */
 178   GtkSheetRange drag_range;
 179
 180   /* Used for the subtitle (popups) */
 181   gint motion_timer;
 182   GtkSheetHoverTitle *hover_window;
 183 };
 184
 185 struct _GtkSheetClass
 186 {
 187   GtkBinClass parent_class;
 188
 189  void (*set_scroll_adjustments) (GtkSheet *sheet,
 190                                  GtkAdjustment *hadjustment,
 191                                  GtkAdjustment *vadjustment);
 192
 193  void (*select_row)             (GtkSheet *sheet, gint row);
 194
 195  void (*select_column)          (GtkSheet *sheet, gint column);
 196
 197  void (*select_range)           (GtkSheet *sheet, GtkSheetRange *range);
 198
 199  void (*resize_range)           (GtkSheet *sheet,
 200                                 GtkSheetRange *old_range,
 201                                 GtkSheetRange *new_range);
 202
 203  void (*move_range)             (GtkSheet *sheet,
 204                                 GtkSheetRange *old_range,
 205                                 GtkSheetRange *new_range);
 206
 207  gboolean (*traverse)           (GtkSheet *sheet,
 208                                 gint row, gint column,
 209                                 gint *new_row, gint *new_column);
 210
 211  gboolean (*activate)           (GtkSheet *sheet,
 212                                 gint row, gint column);
 213
 214  void (*changed)                (GtkSheet *sheet,
 215                                 gint row, gint column);
 216 };
 217
 218 GType gtk_sheet_get_type (void);
 219 GtkType gtk_sheet_range_get_type (void);
 220
 221
 222 /* create a new sheet */
 223 GtkWidget * gtk_sheet_new (GSheetModel *model);
 224
 225 /* create a new sheet with custom entry */
 226 GtkWidget *
 227 gtk_sheet_new_with_custom_entry (GtkType entry_type);
 228
 229 /* Change entry */
 230 void gtk_sheet_change_entry             (GtkSheet *sheet, GtkType entry_type);
 231
 232 GtkEntry *gtk_sheet_get_entry    (GtkSheet *sheet);
 233
 234
 235 void gtk_sheet_get_selected_range (GtkSheet *sheet,
 236                                          GtkSheetRange *range);
 237
 238 void gtk_sheet_show_grid          (GtkSheet *sheet,
 239                                          gboolean show);
 240
 241 gboolean gtk_sheet_grid_visible   (GtkSheet *sheet);
 242
 243
 244 /* scroll the viewing area of the sheet to the given column
 245  * and row; row_align and col_align are between 0-1 representing the
 246  * location the row should appear on the screen, 0.0 being top or left,
 247  * 1.0 being bottom or right; if row or column is negative then there
 248  * is no change */
 249 void gtk_sheet_moveto (GtkSheet *sheet,
 250                   gint row,
 251                   gint column,
 252                   gfloat row_align,
 253                   gfloat col_align);
 254
 255
 256 void gtk_sheet_show_row_titles          (GtkSheet *sheet);
 257 void gtk_sheet_hide_row_titles          (GtkSheet *sheet);
 258 void gtk_sheet_show_column_titles       (GtkSheet *sheet);
 259 void gtk_sheet_hide_column_titles       (GtkSheet *sheet);
 260
 261 /* select the row. The range is then highlighted, and the bounds are stored
 262  * in sheet->range  */
 263 void gtk_sheet_select_row    (GtkSheet * sheet,  gint row);
 264
 265 /* select the column. The range is then highlighted, and the bounds are stored
 266  * in sheet->range  */
 267 void gtk_sheet_select_column (GtkSheet * sheet,  gint column);
 268
 269 /* highlight the selected range and store bounds in sheet->range */
 270 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
 271
 272 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
 273
 274
 275 /* obvious */
 276 void gtk_sheet_unselect_range           (GtkSheet *sheet);
 277
 278 /* set active cell where the entry will be displayed */
 279 void gtk_sheet_set_active_cell (GtkSheet *sheet,
 280                                 gint row, gint column);
 281
 282 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
 283    ROW and/or COLUMN may be null if the caller is not interested in their
 284    values */
 285 void gtk_sheet_get_active_cell (GtkSheet *sheet,
 286                                         gint *row, gint *column);
 287
 288 /* get cell contents */
 289 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
 290
 291
 292 /* get cell attributes of the given cell */
 293 /* TRUE means that the cell is currently allocated */
 294 gboolean gtk_sheet_get_attributes       (const GtkSheet *sheet,
 295                                         gint row, gint col,
 296                                         GtkSheetCellAttr *attributes);
 297
 298 void gtk_sheet_set_model (GtkSheet *sheet,
 299                                    GSheetModel *model);
 300
 301 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
 302
 303
 304 G_END_DECLS
 305
 306
 307 #endif /* __GTK_SHEET_H__ */
 308
 309