1 /* This version of GtkSheet has been heavily modified, for the specific
2 requirements of PSPPIRE. */
5 /* GtkSheet widget for Gtk+.
6 * Copyright (C) 1999-2001 Adrian E. Feiguin <adrian@ifir.ifir.edu.ar>
8 * Based on GtkClist widget by Jay Painter, but major changes.
9 * Memory allocation routines inspired on SC (Spreadsheet Calculator)
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.
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.
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
26 #ifndef __GTK_SHEET_H__
27 #define __GTK_SHEET_H__
31 #include "gtkextra-sheet.h"
32 #include "gsheetmodel.h"
33 #include "gsheet-column-iface.h"
34 #include "gsheet-row-iface.h"
39 #endif /* __cplusplus */
47 GTK_SHEET_JUSTIFICATION,
49 GTK_SHEET_BORDER_COLOR,
50 GTK_SHEET_IS_EDITABLE,
59 GTK_SHEET_ROW_SELECTED,
60 GTK_SHEET_COLUMN_SELECTED,
61 GTK_SHEET_RANGE_SELECTED
65 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
66 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
68 #define GTK_SHEET(obj) GTK_CHECK_CAST (obj, gtk_sheet_get_type (), GtkSheet)
69 #define GTK_SHEET_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, gtk_sheet_get_type (), GtkSheetClass)
70 #define GTK_IS_SHEET(obj) GTK_CHECK_TYPE (obj, gtk_sheet_get_type ())
72 /* Public flags, for compatibility */
74 #define GTK_SHEET_IS_LOCKED(sheet) gtk_sheet_locked(sheet)
75 #define GTK_SHEET_ROW_FROZEN(sheet) !gtk_sheet_rows_resizable(sheet)
76 #define GTK_SHEET_COLUMN_FROZEN(sheet) !gtk_sheet_columns_resizable(sheet)
77 #define GTK_SHEET_AUTORESIZE(sheet) gtk_sheet_autoresize(sheet)
78 #define GTK_SHEET_CLIP_TEXT(sheet) gtk_sheet_clip_text(sheet)
79 #define GTK_SHEET_ROW_TITLES_VISIBLE(sheet) gtk_sheet_row_titles_visible(sheet)
80 #define GTK_SHEET_COL_TITLES_VISIBLE(sheet) gtk_sheet_column_titles_visible(sheet)
81 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll(sheet)
82 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry(sheet)
85 typedef struct _GtkSheetClass GtkSheetClass;
86 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
87 typedef struct _GtkSheetCell GtkSheetCell;
90 struct _GtkSheetCellAttr
92 GtkJustification justification;
93 const PangoFontDescription *font_desc;
96 GtkSheetCellBorder border;
109 GtkContainer container;
111 GSheetColumn *column_geometry;
112 GSheetRow *row_geometry;
118 GtkSelectionMode selection_mode;
122 gboolean justify_entry;
127 /* Background colors */
135 /* allocation rectangle after the container_border_width
136 and the width of the shadow border */
137 GdkRectangle internal_allocation;
141 gint16 column_requisition;
142 gint16 row_requisition;
144 gboolean rows_resizable;
145 gboolean columns_resizable;
147 /* Displayed range */
151 GtkSheetCell active_cell;
152 GtkWidget *sheet_entry;
156 /* expanding selection */
157 GtkSheetCell selection_cell;
159 /* timer for automatic scroll during selection */
161 /* timer for flashing clipped range */
165 /* global selection button */
174 /*the scrolling window and it's height and width to
175 * make things a little speedier */
176 GdkWindow *sheet_window;
177 guint sheet_window_width;
178 guint sheet_window_height;
180 /* sheet backing pixmap */
183 /* offsets for scrolling */
186 gfloat old_hadjustment;
187 gfloat old_vadjustment;
189 /* border shadow style */
190 GtkShadowType shadow_type;
193 GdkRectangle column_title_area;
194 GdkWindow *column_title_window;
195 gboolean column_titles_visible;
198 GdkRectangle row_title_area;
199 GdkWindow *row_title_window;
200 gboolean row_titles_visible;
203 GtkAdjustment *hadjustment;
204 GtkAdjustment *vadjustment;
206 /* xor GC for the verticle drag line */
209 /* gc for drawing unselected cells */
213 /* cursor used to indicate dragging */
214 GdkCursor *cursor_drag;
216 /* the current x-pixel location of the xor-drag vline */
219 /* the current y-pixel location of the xor-drag hline */
222 /* current cell being dragged */
223 GtkSheetCell drag_cell;
224 /* current range being dragged */
225 GtkSheetRange drag_range;
228 GtkSheetRange clip_range;
231 struct _GtkSheetClass
233 GtkContainerClass parent_class;
235 void (*set_scroll_adjustments) (GtkSheet *sheet,
236 GtkAdjustment *hadjustment,
237 GtkAdjustment *vadjustment);
239 void (*select_row) (GtkSheet *sheet, gint row);
241 void (*select_column) (GtkSheet *sheet, gint column);
243 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
245 void (*clip_range) (GtkSheet *sheet, GtkSheetRange *clip_range);
247 void (*resize_range) (GtkSheet *sheet,
248 GtkSheetRange *old_range,
249 GtkSheetRange *new_range);
251 void (*move_range) (GtkSheet *sheet,
252 GtkSheetRange *old_range,
253 GtkSheetRange *new_range);
255 gboolean (*traverse) (GtkSheet *sheet,
256 gint row, gint column,
257 gint *new_row, gint *new_column);
259 gboolean (*deactivate) (GtkSheet *sheet,
260 gint row, gint column);
262 gboolean (*activate) (GtkSheet *sheet,
263 gint row, gint column);
265 void (*set_cell) (GtkSheet *sheet,
266 gint row, gint column);
268 void (*clear_cell) (GtkSheet *sheet,
269 gint row, gint column);
271 void (*changed) (GtkSheet *sheet,
272 gint row, gint column);
274 void (*new_column_width) (GtkSheet *sheet,
278 void (*new_row_height) (GtkSheet *sheet,
284 GType gtk_sheet_get_type (void);
285 GtkType gtk_sheet_range_get_type (void);
288 /* create a new sheet */
289 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
296 /* create a new browser sheet. It cells can not be edited */
298 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
301 gtk_sheet_construct_browser (GtkSheet *sheet,
302 guint rows, guint columns, const gchar *title);
304 /* create a new sheet with custom entry */
306 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
311 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
316 /* change scroll adjustments */
318 gtk_sheet_set_hadjustment (GtkSheet *sheet,
319 GtkAdjustment *adjustment);
321 gtk_sheet_set_vadjustment (GtkSheet *sheet,
322 GtkAdjustment *adjustment);
325 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
327 /* Returns sheet's entry widget */
329 gtk_sheet_get_entry (GtkSheet *sheet);
331 gtk_sheet_get_entry_widget (GtkSheet *sheet);
333 /* Returns sheet->state
334 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
336 gtk_sheet_get_state (GtkSheet *sheet);
338 /* Returns sheet's ranges
339 * Added by Murray Cumming */
341 gtk_sheet_get_columns_count (GtkSheet *sheet);
344 gtk_sheet_get_rows_count (GtkSheet *sheet);
347 gtk_sheet_get_visible_range (GtkSheet *sheet,
348 GtkSheetRange *range);
350 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
353 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
356 gtk_sheet_autoresize (GtkSheet *sheet);
359 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
362 gtk_sheet_autoscroll (GtkSheet *sheet);
365 gtk_sheet_set_clip_text (GtkSheet *sheet, gboolean clip_text);
368 gtk_sheet_clip_text (GtkSheet *sheet);
371 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
374 gtk_sheet_justify_entry (GtkSheet *sheet);
377 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
380 gtk_sheet_locked (GtkSheet *sheet);
382 /* set sheet title */
384 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
386 /* freeze all visual updates of the sheet.
387 * Then thaw the sheet after you have made a number of changes.
388 * The updates will occure in a more efficent way than if
389 * you made them on a unfrozen sheet */
391 gtk_sheet_freeze (GtkSheet *sheet);
393 gtk_sheet_thaw (GtkSheet *sheet);
394 /* Background colors */
396 gtk_sheet_set_background (GtkSheet *sheet,
399 gtk_sheet_set_grid (GtkSheet *sheet,
400 GdkColor *grid_color);
402 gtk_sheet_show_grid (GtkSheet *sheet,
405 gtk_sheet_grid_visible (GtkSheet *sheet);
407 /* set/get column title */
409 gtk_sheet_set_column_title (GtkSheet * sheet,
411 const gchar * title);
414 gtk_sheet_get_column_title (GtkSheet * sheet,
417 /* set/get row title */
419 gtk_sheet_set_row_title (GtkSheet * sheet,
421 const gchar * title);
423 gtk_sheet_get_row_title (GtkSheet * sheet,
427 /* set/get button label */
429 gtk_sheet_row_button_add_label (GtkSheet *sheet,
430 gint row, const gchar *label);
432 gtk_sheet_row_button_get_label (GtkSheet *sheet,
435 gtk_sheet_row_button_justify (GtkSheet *sheet,
436 gint row, GtkJustification justification);
440 /* scroll the viewing area of the sheet to the given column
441 * and row; row_align and col_align are between 0-1 representing the
442 * location the row should appear on the screnn, 0.0 being top or left,
443 * 1.0 being bottom or right; if row or column is negative then there
446 gtk_sheet_moveto (GtkSheet * sheet,
454 gtk_sheet_show_row_titles (GtkSheet *sheet);
456 gtk_sheet_hide_row_titles (GtkSheet *sheet);
458 gtk_sheet_row_titles_visible (GtkSheet *sheet);
461 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
462 * otherwise it acts as a title */
464 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
465 gint row, gboolean sensitive);
467 /* set sensitivity for all row buttons */
469 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
471 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
473 gtk_sheet_rows_resizable (GtkSheet *sheet);
475 /* set row visibility. The default value is TRUE. If FALSE, the
478 gtk_sheet_row_set_visibility (GtkSheet *sheet,
479 gint row, gboolean visible);
481 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
482 gint row, gboolean visible);
484 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
487 /* select the row. The range is then highlighted, and the bounds are stored
490 gtk_sheet_select_row (GtkSheet * sheet,
493 /* select the column. The range is then highlighted, and the bounds are stored
496 gtk_sheet_select_column (GtkSheet * sheet,
499 /* save selected range to "clipboard" */
501 gtk_sheet_clip_range (GtkSheet *sheet, const GtkSheetRange *range);
504 gtk_sheet_unclip_range (GtkSheet *sheet);
507 gtk_sheet_in_clip (GtkSheet *sheet);
509 /* get scrollbars adjustment */
511 gtk_sheet_get_vadjustment (GtkSheet * sheet);
513 gtk_sheet_get_hadjustment (GtkSheet * sheet);
515 /* highlight the selected range and store bounds in sheet->range */
516 void gtk_sheet_select_range (GtkSheet *sheet,
517 const GtkSheetRange *range);
520 void gtk_sheet_unselect_range (GtkSheet *sheet);
522 /* set active cell where the entry will be displayed
523 * returns FALSE if current cell can't be deactivated or
524 * requested cell can't be activated */
526 gtk_sheet_set_active_cell (GtkSheet *sheet,
527 gint row, gint column);
529 gtk_sheet_get_active_cell (GtkSheet *sheet,
530 gint *row, gint *column);
532 /* set cell contents and allocate memory if needed */
534 gtk_sheet_set_cell (GtkSheet *sheet,
536 GtkJustification justification,
539 gtk_sheet_set_cell_text (GtkSheet *sheet,
542 /* get cell contents */
544 gtk_sheet_cell_get_text (GtkSheet *sheet, gint row, gint col);
546 /* clear cell contents */
548 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
549 /* clear cell contents and remove links */
551 gtk_sheet_cell_delete (GtkSheet *sheet, gint row, gint col);
553 /* clear range contents. If range==NULL the whole sheet will be cleared */
555 gtk_sheet_range_clear (GtkSheet *sheet,
556 const GtkSheetRange *range);
557 /* clear range contents and remove links */
559 gtk_sheet_range_delete (GtkSheet *sheet,
560 const GtkSheetRange *range);
562 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
564 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
566 /* get row and column correspondig to the given position in the screen */
568 gtk_sheet_get_pixel_info (GtkSheet * sheet,
574 /* get area of a given cell */
576 gtk_sheet_get_cell_area (GtkSheet *sheet,
583 gtk_sheet_set_row_height (GtkSheet * sheet,
588 /* delete nrows rows starting in row */
590 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
592 /* append nrows row to the end of the sheet */
594 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
596 /* insert nrows rows before the given row and pull right */
598 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
600 /* set abckground color of the given range */
602 gtk_sheet_range_set_background (GtkSheet *sheet,
603 const GtkSheetRange *range,
604 const GdkColor *color);
606 /* set foreground color (text color) of the given range */
608 gtk_sheet_range_set_foreground (GtkSheet *sheet,
609 const GtkSheetRange *range,
610 const GdkColor *color);
612 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
613 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
614 * default justification for numbers is GTK_JUSTIFY_RIGHT */
616 gtk_sheet_range_set_justification (GtkSheet *sheet,
617 const GtkSheetRange *range,
618 GtkJustification justification);
620 gtk_sheet_column_set_justification (GtkSheet *sheet,
622 GtkJustification justification);
623 /* set if cell contents can be edited or not in the given range:
624 * accepted values are TRUE or FALSE. */
626 gtk_sheet_range_set_editable (GtkSheet *sheet,
627 const GtkSheetRange *range,
630 /* set if cell contents are visible or not in the given range:
631 * accepted values are TRUE or FALSE.*/
633 gtk_sheet_range_set_visible (GtkSheet *sheet,
634 const GtkSheetRange *range,
637 /* set cell border style in the given range.
638 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
640 * width is the width of the border line in pixels
641 * line_style is the line_style for the border line */
643 gtk_sheet_range_set_border (GtkSheet *sheet,
644 const GtkSheetRange *range,
649 /* set border color for the given range */
651 gtk_sheet_range_set_border_color (GtkSheet *sheet,
652 const GtkSheetRange *range,
653 const GdkColor *color);
655 /* set font for the given range */
657 gtk_sheet_range_set_font (GtkSheet *sheet,
658 const GtkSheetRange *range,
659 PangoFontDescription *font);
661 /* get cell attributes of the given cell */
662 /* TRUE means that the cell is currently allocated */
664 gtk_sheet_get_attributes (GtkSheet *sheet,
666 GtkSheetCellAttr *attributes);
670 gtk_sheet_put (GtkSheet *sheet,
674 gtk_sheet_attach_floating (GtkSheet *sheet,
678 gtk_sheet_attach_default (GtkSheet *sheet,
682 gtk_sheet_attach (GtkSheet *sheet,
692 gtk_sheet_move_child (GtkSheet *sheet,
697 gtk_sheet_get_child_at (GtkSheet *sheet,
701 gtk_sheet_button_attach (GtkSheet *sheet,
707 void gtk_sheet_set_model(GtkSheet *sheet,
710 GSheetModel * gtk_sheet_get_model(const GtkSheet *sheet);
715 #endif /* __cplusplus */
718 #endif /* __GTK_SHEET_H__ */