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
  40 typedef enum
  41 {
  42   GTK_SHEET_FOREGROUND,
  43   GTK_SHEET_BACKGROUND,
  44   GTK_SHEET_FONT,
  45   GTK_SHEET_JUSTIFICATION,
  46   GTK_SHEET_BORDER,
  47   GTK_SHEET_BORDER_COLOR,
  48   GTK_SHEET_IS_EDITABLE,
  49   GTK_SHEET_IS_VISIBLE
  50 } GtkSheetAttrType;
  51
  52 /* sheet->state */
  53
  54 enum
  55 {
  56   GTK_SHEET_NORMAL,
  57   GTK_SHEET_ROW_SELECTED,
  58   GTK_SHEET_COLUMN_SELECTED,
  59   GTK_SHEET_RANGE_SELECTED
  60 };
  61
  62
  63 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
  64 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
  65
  66 #define GTK_SHEET(obj)          GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
  67 #define GTK_SHEET_CLASS(klass)  GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
  68 #define GTK_IS_SHEET(obj)       GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
  69
  70
  71
  72
  73 typedef struct _GtkSheetClass GtkSheetClass;
  74 typedef struct _GtkSheetCellAttr     GtkSheetCellAttr;
  75 typedef struct _GtkSheetCell GtkSheetCell;
  76 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
  77
  78
  79 struct _GtkSheetCellAttr
  80 {
  81   GtkJustification justification;
  82   const PangoFontDescription *font_desc;
  83   GdkColor foreground;
  84   GdkColor background;
  85   GtkSheetCellBorder border;
  86   gboolean is_editable;
  87   gboolean is_visible;
  88 };
  89
  90 struct _GtkSheetCell
  91 {
  92   gint row;
  93   gint col;
  94 };
  95
  96
  97 struct _GtkSheetHoverTitle
  98 {
  99   GtkWidget *window;
 100   GtkWidget *label;
 101   gint row, column;
 102 };
 103
 104 enum
 105   {
 106     BG_COLOR,
 107     GRID_COLOR,
 108     n_COLORS
 109   };
 110
 111 struct _GtkSheet
 112 {
 113   GtkBin parent;
 114
 115   gboolean dispose_has_run;
 116   GSheetColumn *column_geometry;
 117   GSheetRow *row_geometry;
 118
 119   guint16 flags;
 120
 121   GSheetModel *model;
 122
 123   GtkSelectionMode selection_mode;
 124
 125   /* Component colors */
 126   GdkColor color[n_COLORS];
 127   gboolean show_grid;
 128
 129   /* allocation rectangle after the container_border_width
 130      and the width of the shadow border */
 131   GdkRectangle internal_allocation;
 132
 133   gint16 column_requisition;
 134   gint16 row_requisition;
 135
 136   gboolean rows_resizable;
 137   gboolean columns_resizable;
 138
 139   /* active cell */
 140   GtkSheetCell active_cell;
 141
 142   /* The GtkEntry used for editing the cells */
 143   GtkWidget *entry_widget;
 144
 145   /* The widget containing entry_widget, or
 146      entry_widget itself if no container */
 147   GtkWidget *entry_container;
 148
 149   /* The type of entry_widget */
 150   GtkType entry_type;
 151
 152   /* expanding selection */
 153   GtkSheetCell selection_cell;
 154
 155   /* global selection button */
 156   GtkWidget *button;
 157
 158   /* sheet state */
 159   gint state;
 160
 161   /* selected range */
 162   GtkSheetRange range;
 163
 164   /*the scrolling window and it's height and width to
 165    * make things a little speedier */
 166   GdkWindow *sheet_window;
 167   guint sheet_window_width;
 168   guint sheet_window_height;
 169
 170   /* sheet backing pixmap */
 171   GdkPixmap *pixmap;
 172
 173   /* border shadow style */
 174   GtkShadowType shadow_type;
 175
 176   /* Column Titles */
 177   GdkRectangle column_title_area;
 178   GdkWindow *column_title_window;
 179   gboolean column_titles_visible;
 180   /* TRUE if the cursor is over the column title window */
 181   gboolean column_title_under;
 182
 183   /* Row Titles */
 184   GdkRectangle row_title_area;
 185   GdkWindow *row_title_window;
 186   gboolean row_titles_visible;
 187   /* TRUE if the cursor is over the row title window */
 188   gboolean row_title_under;
 189
 190   /*scrollbars*/
 191   GtkAdjustment *hadjustment;
 192   GtkAdjustment *vadjustment;
 193
 194   /* xor GC for the verticle drag line */
 195   GdkGC *xor_gc;
 196
 197   /* gc for drawing unselected cells */
 198   GdkGC *fg_gc;
 199   GdkGC *bg_gc;
 200
 201   /* cursor used to indicate dragging */
 202   GdkCursor *cursor_drag;
 203
 204   /* the current x-pixel location of the xor-drag vline */
 205   gint x_drag;
 206
 207   /* the current y-pixel location of the xor-drag hline */
 208   gint y_drag;
 209
 210   /* current cell being dragged */
 211   GtkSheetCell drag_cell;
 212   /* current range being dragged */
 213   GtkSheetRange drag_range;
 214
 215   /* Used for the subtitle (popups) */
 216   gint motion_timer;
 217   GtkSheetHoverTitle *hover_window;
 218 };
 219
 220 struct _GtkSheetClass
 221 {
 222   GtkBinClass parent_class;
 223
 224  void (*set_scroll_adjustments) (GtkSheet *sheet,
 225                                  GtkAdjustment *hadjustment,
 226                                  GtkAdjustment *vadjustment);
 227
 228  void (*select_row)             (GtkSheet *sheet, gint row);
 229
 230  void (*select_column)          (GtkSheet *sheet, gint column);
 231
 232  void (*select_range)           (GtkSheet *sheet, GtkSheetRange *range);
 233
 234  void (*resize_range)           (GtkSheet *sheet,
 235                                 GtkSheetRange *old_range,
 236                                 GtkSheetRange *new_range);
 237
 238  void (*move_range)             (GtkSheet *sheet,
 239                                 GtkSheetRange *old_range,
 240                                 GtkSheetRange *new_range);
 241
 242  gboolean (*traverse)           (GtkSheet *sheet,
 243                                 gint row, gint column,
 244                                 gint *new_row, gint *new_column);
 245
 246  gboolean (*deactivate)         (GtkSheet *sheet,
 247                                 gint row, gint column);
 248
 249  gboolean (*activate)           (GtkSheet *sheet,
 250                                 gint row, gint column);
 251
 252  void (*changed)                (GtkSheet *sheet,
 253                                 gint row, gint column);
 254 };
 255
 256 GType gtk_sheet_get_type (void);
 257 GtkType gtk_sheet_range_get_type (void);
 258
 259
 260 /* create a new sheet */
 261 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
 262                            GSheetModel *model);
 263
 264 /* create a new sheet with custom entry */
 265 GtkWidget *
 266 gtk_sheet_new_with_custom_entry         (GSheetRow *vgeo,
 267                                          GSheetColumn *hgeo,
 268                                          GtkType entry_type);
 269 void
 270 gtk_sheet_construct_with_custom_entry   (GtkSheet *sheet,
 271                                          GSheetRow *vgeo,
 272                                          GSheetColumn *hgeo,
 273                                          GtkType entry_type);
 274 /* Change entry */
 275 void gtk_sheet_change_entry             (GtkSheet *sheet, GtkType entry_type);
 276
 277 GtkWidget *gtk_sheet_get_entry    (GtkSheet *sheet);
 278
 279
 280 guint gtk_sheet_get_columns_count (GtkSheet *sheet);
 281
 282 guint gtk_sheet_get_rows_count    (GtkSheet *sheet);
 283
 284 void gtk_sheet_get_selected_range (GtkSheet *sheet,
 285                                          GtkSheetRange *range);
 286
 287 void gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
 288
 289
 290 void gtk_sheet_show_grid          (GtkSheet *sheet,
 291                                          gboolean show);
 292
 293 gboolean gtk_sheet_grid_visible   (GtkSheet *sheet);
 294
 295 /* set/get column title */
 296 void gtk_sheet_set_column_title   (GtkSheet * sheet,
 297                                         gint column,
 298                                         const gchar * title);
 299
 300 const gchar *gtk_sheet_get_column_title  (GtkSheet * sheet,
 301                                         gint column);
 302
 303 /* set/get row title */
 304 void gtk_sheet_set_row_title      (GtkSheet * sheet,
 305                                         gint row,
 306                                         const gchar * title);
 307
 308 const gchar *gtk_sheet_get_row_title (GtkSheet * sheet,
 309                                       gint row);
 310
 311 /* set/get button label */
 312 void gtk_sheet_row_button_add_label (GtkSheet *sheet,
 313                                         gint row, const gchar *label);
 314
 315 const gchar *gtk_sheet_row_button_get_label  (GtkSheet *sheet,
 316                                               gint row);
 317
 318 void gtk_sheet_row_button_justify   (GtkSheet *sheet,
 319                                      gint row, GtkJustification justification);
 320
 321 /* scroll the viewing area of the sheet to the given column
 322  * and row; row_align and col_align are between 0-1 representing the
 323  * location the row should appear on the screen, 0.0 being top or left,
 324  * 1.0 being bottom or right; if row or column is negative then there
 325  * is no change */
 326 void gtk_sheet_moveto (GtkSheet *sheet,
 327                   gint row,
 328                   gint column,
 329                   gfloat row_align,
 330                   gfloat col_align);
 331
 332
 333 void gtk_sheet_show_row_titles          (GtkSheet *sheet);
 334 void gtk_sheet_hide_row_titles          (GtkSheet *sheet);
 335 void gtk_sheet_show_column_titles       (GtkSheet *sheet);
 336 void gtk_sheet_hide_column_titles       (GtkSheet *sheet);
 337
 338 gboolean gtk_sheet_row_titles_visible   (GtkSheet *sheet);
 339
 340
 341 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
 342  * otherwise it acts as a title */
 343 void gtk_sheet_row_set_sensitivity      (GtkSheet *sheet,
 344                                         gint row,  gboolean sensitive);
 345
 346 /* set sensitivity for all row buttons */
 347 void gtk_sheet_rows_set_sensitivity     (GtkSheet *sheet, gboolean sensitive);
 348
 349 /* set row visibility. The default value is TRUE. If FALSE, the
 350  * row is hidden */
 351 void gtk_sheet_row_set_visibility       (GtkSheet *sheet,
 352                                          gint row, gboolean visible);
 353
 354 void gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
 355                                          gint row, gboolean visible);
 356
 357 void gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
 358
 359
 360 /* select the row. The range is then highlighted, and the bounds are stored
 361  * in sheet->range  */
 362 void gtk_sheet_select_row    (GtkSheet * sheet,  gint row);
 363
 364 /* select the column. The range is then highlighted, and the bounds are stored
 365  * in sheet->range  */
 366 void gtk_sheet_select_column (GtkSheet * sheet,  gint column);
 367
 368 /* highlight the selected range and store bounds in sheet->range */
 369 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
 370
 371 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
 372
 373
 374 /* obvious */
 375 void gtk_sheet_unselect_range           (GtkSheet *sheet);
 376
 377 /* set active cell where the entry will be displayed
 378  * returns FALSE if current cell can't be deactivated or
 379  * requested cell can't be activated */
 380 gboolean gtk_sheet_set_active_cell (GtkSheet *sheet,
 381                                         gint row, gint column);
 382
 383 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
 384    ROW and/or COLUMN may be null if the caller is not interested in their
 385    values */
 386 void gtk_sheet_get_active_cell (GtkSheet *sheet,
 387                                         gint *row, gint *column);
 388
 389 /* get cell contents */
 390 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
 391
 392 /* clear cell contents */
 393 void gtk_sheet_cell_clear      (GtkSheet *sheet, gint row, gint col);
 394
 395 /* clear range contents. If range==NULL the whole sheet will be cleared */
 396 void gtk_sheet_range_clear      (GtkSheet *sheet,
 397                                          const GtkSheetRange *range);
 398
 399 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
 400 GtkStateType gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
 401
 402 /* get area of a given cell */
 403 gboolean gtk_sheet_get_cell_area (GtkSheet *sheet,
 404                          gint row,
 405                          gint column,
 406                          GdkRectangle *area);
 407
 408 /* set row height */
 409 void gtk_sheet_set_row_height (GtkSheet * sheet,
 410                           gint row,
 411                           guint height);
 412
 413
 414 /* delete nrows rows starting in row */
 415 void gtk_sheet_delete_rows    (GtkSheet *sheet, guint row, guint nrows);
 416
 417 /* append nrows row to the end of the sheet */
 418 void gtk_sheet_add_row        (GtkSheet *sheet, guint nrows);
 419
 420 /* insert nrows rows before the given row and pull right */
 421 void gtk_sheet_insert_rows    (GtkSheet *sheet, guint row, guint nrows);
 422
 423 /* set abckground color of the given range */
 424 void gtk_sheet_range_set_background  (GtkSheet *sheet,
 425                                         const GtkSheetRange *range,
 426                                         const GdkColor *color);
 427
 428 /* set foreground color (text color) of the given range */
 429 void gtk_sheet_range_set_foreground  (GtkSheet *sheet,
 430                                         const GtkSheetRange *range,
 431                                         const GdkColor *color);
 432
 433 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
 434  * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
 435  * default justification for numbers is GTK_JUSTIFY_RIGHT */
 436 void gtk_sheet_range_set_justification  (GtkSheet *sheet,
 437                                         const GtkSheetRange *range,
 438                                         GtkJustification justification);
 439
 440 void gtk_sheet_column_set_justification (GtkSheet *sheet,
 441                                         gint column,
 442                                         GtkJustification justification);
 443
 444 /* set if cell contents can be edited or not in the given range:
 445  * accepted values are TRUE or FALSE. */
 446 void gtk_sheet_range_set_editable (GtkSheet *sheet,
 447                                         const GtkSheetRange *range,
 448                                         gint editable);
 449
 450 /* set if cell contents are visible or not in the given range:
 451  * accepted values are TRUE or FALSE.*/
 452 void gtk_sheet_range_set_visible  (GtkSheet *sheet,
 453                                         const GtkSheetRange *range,
 454                                         gboolean visible);
 455
 456 /* set cell border style in the given range.
 457  * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
 458  * CELL_BOTTOM_BORDER
 459  * width is the width of the border line in pixels
 460  * line_style is the line_style for the border line */
 461 void gtk_sheet_range_set_border         (GtkSheet *sheet,
 462                                         const GtkSheetRange *range,
 463                                         gint mask,
 464                                         guint width,
 465                                         gint line_style);
 466
 467 /* set border color for the given range */
 468 void gtk_sheet_range_set_border_color   (GtkSheet *sheet,
 469                                         const GtkSheetRange *range,
 470                                         const GdkColor *color);
 471
 472 /* set font for the given range */
 473 void gtk_sheet_range_set_font           (GtkSheet *sheet,
 474                                         const GtkSheetRange *range,
 475                                         PangoFontDescription *font);
 476
 477 /* get cell attributes of the given cell */
 478 /* TRUE means that the cell is currently allocated */
 479 gboolean gtk_sheet_get_attributes       (const GtkSheet *sheet,
 480                                         gint row, gint col,
 481                                         GtkSheetCellAttr *attributes);
 482
 483
 484 void           gtk_sheet_set_model (GtkSheet *sheet,
 485                                    GSheetModel *model);
 486
 487 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
 488
 489
 490 G_END_DECLS
 491
 492
 493 #endif /* __GTK_SHEET_H__ */
 494
 495