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   GdkColor foreground;
  66   GdkColor background;
  67   GtkSheetCellBorder border;
  68   gboolean is_editable;
  69 };
  70
  71 struct _GtkSheetHoverTitle
  72 {
  73   GtkWidget *window;
  74   GtkWidget *label;
  75   gint row, column;
  76 };
  77
  78 enum
  79   {
  80     BG_COLOR,
  81     GRID_COLOR,
  82     n_COLORS
  83   };
  84
  85 struct _GtkSheet
  86 {
  87   GtkBin parent;
  88
  89   gboolean dispose_has_run;
  90   PsppireAxis *haxis;
  91   PsppireAxis *vaxis;
  92
  93   guint16 flags;
  94
  95   GSheetModel *model;
  96
  97   GtkSelectionMode selection_mode;
  98
  99   /* Component colors */
 100   GdkColor color[n_COLORS];
 101   gboolean show_grid;
 102
 103   gint16 column_requisition;
 104   gint16 row_requisition;
 105
 106   gboolean rows_resizable;
 107   gboolean columns_resizable;
 108
 109   /* active cell */
 110   GtkSheetCell active_cell;
 111
 112   /* The GtkEntry used for editing the cells */
 113   GtkWidget *entry_widget;
 114
 115   /* The type of entry_widget */
 116   GtkType entry_type;
 117
 118   /* Handler of the "changed" callback for the entry widget */
 119   glong entry_handler_id;
 120
 121   /* expanding selection */
 122   GtkSheetCell selection_cell;
 123
 124   /* global selection button */
 125   GtkWidget *button;
 126
 127   /* sheet state */
 128   gint state;
 129
 130   /* selected range */
 131   GtkSheetRange range;
 132
 133   /* the scrolling window and its height and width to
 134    * make things a little speedier */
 135   GdkWindow *sheet_window;
 136
 137   /* border shadow style */
 138   GtkShadowType shadow_type;
 139
 140   /* Column Titles */
 141   GdkRectangle column_title_area;
 142   GdkWindow *column_title_window;
 143   gboolean column_titles_visible;
 144   /* TRUE if the cursor is over the column title window */
 145   gboolean column_title_under;
 146
 147   /* Row Titles */
 148   GdkRectangle row_title_area;
 149   GdkWindow *row_title_window;
 150   gboolean row_titles_visible;
 151   /* TRUE if the cursor is over the row title window */
 152   gboolean row_title_under;
 153
 154   /*scrollbars*/
 155   GtkAdjustment *hadjustment;
 156   GtkAdjustment *vadjustment;
 157
 158   /* xor GC for the verticle drag line */
 159   GdkGC *xor_gc;
 160
 161   /* gc for drawing unselected cells */
 162   GdkGC *fg_gc;
 163   GdkGC *bg_gc;
 164
 165   /* cursor used to indicate dragging */
 166   GdkCursor *cursor_drag;
 167
 168   /* the current x-pixel location of the xor-drag vline */
 169   gint x_drag;
 170
 171   /* the current y-pixel location of the xor-drag hline */
 172   gint y_drag;
 173
 174   /* current cell being dragged */
 175   GtkSheetCell drag_cell;
 176   /* current range being dragged */
 177   GtkSheetRange drag_range;
 178
 179   /* Used for the subtitle (popups) */
 180   gint motion_timer;
 181   GtkSheetHoverTitle *hover_window;
 182 };
 183
 184 struct _GtkSheetClass
 185 {
 186   GtkBinClass parent_class;
 187
 188  void (*set_scroll_adjustments) (GtkSheet *sheet,
 189                                  GtkAdjustment *hadjustment,
 190                                  GtkAdjustment *vadjustment);
 191
 192  void (*select_row)             (GtkSheet *sheet, gint row);
 193
 194  void (*select_column)          (GtkSheet *sheet, gint column);
 195
 196  void (*select_range)           (GtkSheet *sheet, GtkSheetRange *range);
 197
 198  void (*resize_range)           (GtkSheet *sheet,
 199                                 GtkSheetRange *old_range,
 200                                 GtkSheetRange *new_range);
 201
 202  void (*move_range)             (GtkSheet *sheet,
 203                                 GtkSheetRange *old_range,
 204                                 GtkSheetRange *new_range);
 205
 206  gboolean (*traverse)           (GtkSheet *sheet,
 207                                 gint row, gint column,
 208                                 gint *new_row, gint *new_column);
 209
 210  gboolean (*activate)           (GtkSheet *sheet,
 211                                 gint row, gint column);
 212
 213  void (*changed)                (GtkSheet *sheet,
 214                                 gint row, gint column);
 215 };
 216
 217 GType gtk_sheet_get_type (void);
 218 GtkType gtk_sheet_range_get_type (void);
 219
 220
 221 /* create a new sheet */
 222 GtkWidget * gtk_sheet_new (GSheetModel *model);
 223
 224 /* create a new sheet with custom entry */
 225 GtkWidget *
 226 gtk_sheet_new_with_custom_entry (GtkType entry_type);
 227
 228 /* Change entry */
 229 void gtk_sheet_change_entry             (GtkSheet *sheet, GtkType entry_type);
 230
 231 GtkEntry *gtk_sheet_get_entry    (GtkSheet *sheet);
 232
 233
 234 void gtk_sheet_get_selected_range (GtkSheet *sheet,
 235                                          GtkSheetRange *range);
 236
 237 void gtk_sheet_show_grid          (GtkSheet *sheet,
 238                                          gboolean show);
 239
 240 gboolean gtk_sheet_grid_visible   (GtkSheet *sheet);
 241
 242
 243 /* scroll the viewing area of the sheet to the given column
 244  * and row; row_align and col_align are between 0-1 representing the
 245  * location the row should appear on the screen, 0.0 being top or left,
 246  * 1.0 being bottom or right; if row or column is negative then there
 247  * is no change */
 248 void gtk_sheet_moveto (GtkSheet *sheet,
 249                   gint row,
 250                   gint column,
 251                   gfloat row_align,
 252                   gfloat col_align);
 253
 254
 255 void gtk_sheet_show_row_titles          (GtkSheet *sheet);
 256 void gtk_sheet_hide_row_titles          (GtkSheet *sheet);
 257 void gtk_sheet_show_column_titles       (GtkSheet *sheet);
 258 void gtk_sheet_hide_column_titles       (GtkSheet *sheet);
 259
 260 /* select the row. The range is then highlighted, and the bounds are stored
 261  * in sheet->range  */
 262 void gtk_sheet_select_row    (GtkSheet * sheet,  gint row);
 263
 264 /* select the column. The range is then highlighted, and the bounds are stored
 265  * in sheet->range  */
 266 void gtk_sheet_select_column (GtkSheet * sheet,  gint column);
 267
 268 /* highlight the selected range and store bounds in sheet->range */
 269 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
 270
 271 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
 272
 273
 274 /* obvious */
 275 void gtk_sheet_unselect_range           (GtkSheet *sheet);
 276
 277 /* set active cell where the entry will be displayed */
 278 void gtk_sheet_set_active_cell (GtkSheet *sheet,
 279                                 gint row, gint column);
 280
 281 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
 282    ROW and/or COLUMN may be null if the caller is not interested in their
 283    values */
 284 void gtk_sheet_get_active_cell (GtkSheet *sheet,
 285                                         gint *row, gint *column);
 286
 287 /* get cell contents */
 288 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
 289
 290
 291 /* get cell attributes of the given cell */
 292 /* TRUE means that the cell is currently allocated */
 293 gboolean gtk_sheet_get_attributes       (const GtkSheet *sheet,
 294                                         gint row, gint col,
 295                                         GtkSheetCellAttr *attributes);
 296
 297 void gtk_sheet_set_model (GtkSheet *sheet,
 298                                    GSheetModel *model);
 299
 300 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
 301
 302
 303 G_END_DECLS
 304
 305
 306 #endif /* __GTK_SHEET_H__ */
 307
 308