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