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