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_ROW_FROZEN(sheet) !gtk_sheet_rows_resizable (sheet)
75 #define GTK_SHEET_COLUMN_FROZEN(sheet) !gtk_sheet_columns_resizable (sheet)
76 #define GTK_SHEET_AUTORESIZE(sheet) gtk_sheet_autoresize (sheet)
77 #define GTK_SHEET_CLIP_TEXT(sheet) gtk_sheet_clip_text (sheet)
78 #define GTK_SHEET_ROW_TITLES_VISIBLE(sheet) gtk_sheet_row_titles_visible (sheet)
79 #define GTK_SHEET_COL_TITLES_VISIBLE(sheet) gtk_sheet_column_titles_visible (sheet)
80 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll (sheet)
81 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry (sheet)
84 typedef struct _GtkSheetClass GtkSheetClass;
85 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
86 typedef struct _GtkSheetCell GtkSheetCell;
89 struct _GtkSheetCellAttr
91 GtkJustification justification;
92 const PangoFontDescription *font_desc;
95 GtkSheetCellBorder border;
108 GtkContainer container;
110 GSheetColumn *column_geometry;
111 GSheetRow *row_geometry;
117 GtkSelectionMode selection_mode;
121 gboolean justify_entry;
125 /* Background colors */
133 /* allocation rectangle after the container_border_width
134 and the width of the shadow border */
135 GdkRectangle internal_allocation;
139 gint16 column_requisition;
140 gint16 row_requisition;
142 gboolean rows_resizable;
143 gboolean columns_resizable;
145 /* Displayed range */
149 GtkSheetCell active_cell;
150 GtkWidget *sheet_entry;
154 /* expanding selection */
155 GtkSheetCell selection_cell;
157 /* timer for flashing clipped range */
161 /* global selection button */
170 /*the scrolling window and it's height and width to
171 * make things a little speedier */
172 GdkWindow *sheet_window;
173 guint sheet_window_width;
174 guint sheet_window_height;
176 /* sheet backing pixmap */
179 /* offsets for scrolling */
182 gfloat old_hadjustment;
183 gfloat old_vadjustment;
185 /* border shadow style */
186 GtkShadowType shadow_type;
189 GdkRectangle column_title_area;
190 GdkWindow *column_title_window;
191 gboolean column_titles_visible;
194 GdkRectangle row_title_area;
195 GdkWindow *row_title_window;
196 gboolean row_titles_visible;
199 GtkAdjustment *hadjustment;
200 GtkAdjustment *vadjustment;
202 /* xor GC for the verticle drag line */
205 /* gc for drawing unselected cells */
209 /* cursor used to indicate dragging */
210 GdkCursor *cursor_drag;
212 /* the current x-pixel location of the xor-drag vline */
215 /* the current y-pixel location of the xor-drag hline */
218 /* current cell being dragged */
219 GtkSheetCell drag_cell;
220 /* current range being dragged */
221 GtkSheetRange drag_range;
224 GtkSheetRange clip_range;
227 struct _GtkSheetClass
229 GtkContainerClass parent_class;
231 void (*set_scroll_adjustments) (GtkSheet *sheet,
232 GtkAdjustment *hadjustment,
233 GtkAdjustment *vadjustment);
235 void (*select_row) (GtkSheet *sheet, gint row);
237 void (*select_column) (GtkSheet *sheet, gint column);
239 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
241 void (*clip_range) (GtkSheet *sheet, GtkSheetRange *clip_range);
243 void (*resize_range) (GtkSheet *sheet,
244 GtkSheetRange *old_range,
245 GtkSheetRange *new_range);
247 void (*move_range) (GtkSheet *sheet,
248 GtkSheetRange *old_range,
249 GtkSheetRange *new_range);
251 gboolean (*traverse) (GtkSheet *sheet,
252 gint row, gint column,
253 gint *new_row, gint *new_column);
255 gboolean (*deactivate) (GtkSheet *sheet,
256 gint row, gint column);
258 gboolean (*activate) (GtkSheet *sheet,
259 gint row, gint column);
261 void (*set_cell) (GtkSheet *sheet,
262 gint row, gint column);
264 void (*clear_cell) (GtkSheet *sheet,
265 gint row, gint column);
267 void (*changed) (GtkSheet *sheet,
268 gint row, gint column);
270 void (*new_column_width) (GtkSheet *sheet,
274 void (*new_row_height) (GtkSheet *sheet,
280 GType gtk_sheet_get_type (void);
281 GtkType gtk_sheet_range_get_type (void);
284 /* create a new sheet */
285 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
292 /* create a new browser sheet. It cells can not be edited */
294 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
297 gtk_sheet_construct_browser (GtkSheet *sheet,
298 guint rows, guint columns, const gchar *title);
300 /* create a new sheet with custom entry */
302 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
307 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
312 /* change scroll adjustments */
314 gtk_sheet_set_hadjustment (GtkSheet *sheet,
315 GtkAdjustment *adjustment);
317 gtk_sheet_set_vadjustment (GtkSheet *sheet,
318 GtkAdjustment *adjustment);
321 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
323 /* Returns sheet's entry widget */
325 gtk_sheet_get_entry (GtkSheet *sheet);
327 gtk_sheet_get_entry_widget (GtkSheet *sheet);
329 /* Returns sheet->state
330 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
332 gtk_sheet_get_state (GtkSheet *sheet);
334 /* Returns sheet's ranges
335 * Added by Murray Cumming */
337 gtk_sheet_get_columns_count (GtkSheet *sheet);
340 gtk_sheet_get_rows_count (GtkSheet *sheet);
343 gtk_sheet_get_visible_range (GtkSheet *sheet,
344 GtkSheetRange *range);
346 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
349 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
352 gtk_sheet_autoresize (GtkSheet *sheet);
355 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
358 gtk_sheet_autoscroll (GtkSheet *sheet);
361 gtk_sheet_set_clip_text (GtkSheet *sheet, gboolean clip_text);
364 gtk_sheet_clip_text (GtkSheet *sheet);
367 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
370 gtk_sheet_justify_entry (GtkSheet *sheet);
373 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
376 gtk_sheet_locked (const GtkSheet *sheet);
378 /* set sheet title */
380 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
382 /* freeze all visual updates of the sheet.
383 * Then thaw the sheet after you have made a number of changes.
384 * The updates will occure in a more efficent way than if
385 * you made them on a unfrozen sheet */
387 gtk_sheet_freeze (GtkSheet *sheet);
389 gtk_sheet_thaw (GtkSheet *sheet);
390 /* Background colors */
392 gtk_sheet_set_background (GtkSheet *sheet,
395 gtk_sheet_set_grid (GtkSheet *sheet,
396 GdkColor *grid_color);
398 gtk_sheet_show_grid (GtkSheet *sheet,
401 gtk_sheet_grid_visible (GtkSheet *sheet);
403 /* set/get column title */
405 gtk_sheet_set_column_title (GtkSheet * sheet,
407 const gchar * title);
410 gtk_sheet_get_column_title (GtkSheet * sheet,
413 /* set/get row title */
415 gtk_sheet_set_row_title (GtkSheet * sheet,
417 const gchar * title);
419 gtk_sheet_get_row_title (GtkSheet * sheet,
423 /* set/get button label */
425 gtk_sheet_row_button_add_label (GtkSheet *sheet,
426 gint row, const gchar *label);
428 gtk_sheet_row_button_get_label (GtkSheet *sheet,
431 gtk_sheet_row_button_justify (GtkSheet *sheet,
432 gint row, GtkJustification justification);
436 /* scroll the viewing area of the sheet to the given column
437 * and row; row_align and col_align are between 0-1 representing the
438 * location the row should appear on the screen, 0.0 being top or left,
439 * 1.0 being bottom or right; if row or column is negative then there
442 gtk_sheet_moveto (GtkSheet *sheet,
450 gtk_sheet_show_row_titles (GtkSheet *sheet);
452 gtk_sheet_hide_row_titles (GtkSheet *sheet);
454 gtk_sheet_row_titles_visible (GtkSheet *sheet);
457 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
458 * otherwise it acts as a title */
460 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
461 gint row, gboolean sensitive);
463 /* set sensitivity for all row buttons */
465 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
467 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
469 gtk_sheet_rows_resizable (GtkSheet *sheet);
471 /* set row visibility. The default value is TRUE. If FALSE, the
474 gtk_sheet_row_set_visibility (GtkSheet *sheet,
475 gint row, gboolean visible);
477 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
478 gint row, gboolean visible);
480 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
483 /* select the row. The range is then highlighted, and the bounds are stored
486 gtk_sheet_select_row (GtkSheet * sheet,
489 /* select the column. The range is then highlighted, and the bounds are stored
492 gtk_sheet_select_column (GtkSheet * sheet,
495 /* save selected range to "clipboard" */
497 gtk_sheet_clip_range (GtkSheet *sheet, const GtkSheetRange *range);
500 gtk_sheet_unclip_range (GtkSheet *sheet);
503 gtk_sheet_in_clip (GtkSheet *sheet);
505 /* get scrollbars adjustment */
507 gtk_sheet_get_vadjustment (GtkSheet * sheet);
509 gtk_sheet_get_hadjustment (GtkSheet * sheet);
511 /* highlight the selected range and store bounds in sheet->range */
512 void gtk_sheet_select_range (GtkSheet *sheet,
513 const GtkSheetRange *range);
516 void gtk_sheet_unselect_range (GtkSheet *sheet);
518 /* set active cell where the entry will be displayed
519 * returns FALSE if current cell can't be deactivated or
520 * requested cell can't be activated */
522 gtk_sheet_set_active_cell (GtkSheet *sheet,
523 gint row, gint column);
525 gtk_sheet_get_active_cell (GtkSheet *sheet,
526 gint *row, gint *column);
528 /* set cell contents and allocate memory if needed */
530 gtk_sheet_set_cell (GtkSheet *sheet,
532 GtkJustification justification,
535 gtk_sheet_set_cell_text (GtkSheet *sheet,
538 /* get cell contents */
540 gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
542 /* clear cell contents */
544 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
545 /* clear cell contents and remove links */
547 gtk_sheet_cell_delete (GtkSheet *sheet, gint row, gint col);
549 /* clear range contents. If range==NULL the whole sheet will be cleared */
551 gtk_sheet_range_clear (GtkSheet *sheet,
552 const GtkSheetRange *range);
553 /* clear range contents and remove links */
555 gtk_sheet_range_delete (GtkSheet *sheet,
556 const GtkSheetRange *range);
558 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
560 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
562 /* get row and column correspondig to the given position in the screen */
564 gtk_sheet_get_pixel_info (GtkSheet * sheet,
570 /* get area of a given cell */
572 gtk_sheet_get_cell_area (GtkSheet *sheet,
579 gtk_sheet_set_row_height (GtkSheet * sheet,
584 /* delete nrows rows starting in row */
586 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
588 /* append nrows row to the end of the sheet */
590 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
592 /* insert nrows rows before the given row and pull right */
594 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
596 /* set abckground color of the given range */
598 gtk_sheet_range_set_background (GtkSheet *sheet,
599 const GtkSheetRange *range,
600 const GdkColor *color);
602 /* set foreground color (text color) of the given range */
604 gtk_sheet_range_set_foreground (GtkSheet *sheet,
605 const GtkSheetRange *range,
606 const GdkColor *color);
608 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
609 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
610 * default justification for numbers is GTK_JUSTIFY_RIGHT */
612 gtk_sheet_range_set_justification (GtkSheet *sheet,
613 const GtkSheetRange *range,
614 GtkJustification justification);
616 gtk_sheet_column_set_justification (GtkSheet *sheet,
618 GtkJustification justification);
619 /* set if cell contents can be edited or not in the given range:
620 * accepted values are TRUE or FALSE. */
622 gtk_sheet_range_set_editable (GtkSheet *sheet,
623 const GtkSheetRange *range,
626 /* set if cell contents are visible or not in the given range:
627 * accepted values are TRUE or FALSE.*/
629 gtk_sheet_range_set_visible (GtkSheet *sheet,
630 const GtkSheetRange *range,
633 /* set cell border style in the given range.
634 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
636 * width is the width of the border line in pixels
637 * line_style is the line_style for the border line */
639 gtk_sheet_range_set_border (GtkSheet *sheet,
640 const GtkSheetRange *range,
645 /* set border color for the given range */
647 gtk_sheet_range_set_border_color (GtkSheet *sheet,
648 const GtkSheetRange *range,
649 const GdkColor *color);
651 /* set font for the given range */
653 gtk_sheet_range_set_font (GtkSheet *sheet,
654 const GtkSheetRange *range,
655 PangoFontDescription *font);
657 /* get cell attributes of the given cell */
658 /* TRUE means that the cell is currently allocated */
660 gtk_sheet_get_attributes (const GtkSheet *sheet,
662 GtkSheetCellAttr *attributes);
666 gtk_sheet_put (GtkSheet *sheet,
670 gtk_sheet_attach_floating (GtkSheet *sheet,
674 gtk_sheet_attach_default (GtkSheet *sheet,
678 gtk_sheet_attach (GtkSheet *sheet,
688 gtk_sheet_move_child (GtkSheet *sheet,
693 gtk_sheet_get_child_at (GtkSheet *sheet,
697 gtk_sheet_button_attach (GtkSheet *sheet,
703 void gtk_sheet_set_model (GtkSheet *sheet,
706 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
711 #endif /* __cplusplus */
714 #endif /* __GTK_SHEET_H__ */