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;
87 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
90 struct _GtkSheetCellAttr
92 GtkJustification justification;
93 const PangoFontDescription *font_desc;
96 GtkSheetCellBorder border;
107 struct _GtkSheetHoverTitle
115 GtkContainer container;
117 GSheetColumn *column_geometry;
118 GSheetRow *row_geometry;
124 GtkSelectionMode selection_mode;
128 gboolean justify_entry;
132 /* Background colors */
140 /* allocation rectangle after the container_border_width
141 and the width of the shadow border */
142 GdkRectangle internal_allocation;
146 gint16 column_requisition;
147 gint16 row_requisition;
149 gboolean rows_resizable;
150 gboolean columns_resizable;
152 /* Displayed range */
156 GtkSheetCell active_cell;
157 GtkWidget *sheet_entry;
161 /* expanding selection */
162 GtkSheetCell selection_cell;
164 /* timer for flashing clipped range */
168 /* global selection button */
177 /*the scrolling window and it's height and width to
178 * make things a little speedier */
179 GdkWindow *sheet_window;
180 guint sheet_window_width;
181 guint sheet_window_height;
183 /* sheet backing pixmap */
186 /* offsets for scrolling */
189 gfloat old_hadjustment;
190 gfloat old_vadjustment;
192 /* border shadow style */
193 GtkShadowType shadow_type;
196 GdkRectangle column_title_area;
197 GdkWindow *column_title_window;
198 gboolean column_titles_visible;
201 GdkRectangle row_title_area;
202 GdkWindow *row_title_window;
203 gboolean row_titles_visible;
206 GtkAdjustment *hadjustment;
207 GtkAdjustment *vadjustment;
209 /* xor GC for the verticle drag line */
212 /* gc for drawing unselected cells */
216 /* cursor used to indicate dragging */
217 GdkCursor *cursor_drag;
219 /* the current x-pixel location of the xor-drag vline */
222 /* the current y-pixel location of the xor-drag hline */
225 /* current cell being dragged */
226 GtkSheetCell drag_cell;
227 /* current range being dragged */
228 GtkSheetRange drag_range;
231 GtkSheetRange clip_range;
233 /* Used for the subtitle (popups) */
235 GtkSheetHoverTitle *hover_window;
238 struct _GtkSheetClass
240 GtkContainerClass parent_class;
242 void (*set_scroll_adjustments) (GtkSheet *sheet,
243 GtkAdjustment *hadjustment,
244 GtkAdjustment *vadjustment);
246 void (*select_row) (GtkSheet *sheet, gint row);
248 void (*select_column) (GtkSheet *sheet, gint column);
250 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
252 void (*clip_range) (GtkSheet *sheet, GtkSheetRange *clip_range);
254 void (*resize_range) (GtkSheet *sheet,
255 GtkSheetRange *old_range,
256 GtkSheetRange *new_range);
258 void (*move_range) (GtkSheet *sheet,
259 GtkSheetRange *old_range,
260 GtkSheetRange *new_range);
262 gboolean (*traverse) (GtkSheet *sheet,
263 gint row, gint column,
264 gint *new_row, gint *new_column);
266 gboolean (*deactivate) (GtkSheet *sheet,
267 gint row, gint column);
269 gboolean (*activate) (GtkSheet *sheet,
270 gint row, gint column);
272 void (*set_cell) (GtkSheet *sheet,
273 gint row, gint column);
275 void (*clear_cell) (GtkSheet *sheet,
276 gint row, gint column);
278 void (*changed) (GtkSheet *sheet,
279 gint row, gint column);
281 void (*new_column_width) (GtkSheet *sheet,
285 void (*new_row_height) (GtkSheet *sheet,
291 GType gtk_sheet_get_type (void);
292 GtkType gtk_sheet_range_get_type (void);
295 /* create a new sheet */
296 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
303 /* create a new browser sheet. It cells can not be edited */
305 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
308 gtk_sheet_construct_browser (GtkSheet *sheet,
309 guint rows, guint columns, const gchar *title);
311 /* create a new sheet with custom entry */
313 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
318 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
323 /* change scroll adjustments */
325 gtk_sheet_set_hadjustment (GtkSheet *sheet,
326 GtkAdjustment *adjustment);
328 gtk_sheet_set_vadjustment (GtkSheet *sheet,
329 GtkAdjustment *adjustment);
332 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
334 /* Returns sheet's entry widget */
336 gtk_sheet_get_entry (GtkSheet *sheet);
338 gtk_sheet_get_entry_widget (GtkSheet *sheet);
340 /* Returns sheet->state
341 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
343 gtk_sheet_get_state (GtkSheet *sheet);
345 /* Returns sheet's ranges
346 * Added by Murray Cumming */
348 gtk_sheet_get_columns_count (GtkSheet *sheet);
351 gtk_sheet_get_rows_count (GtkSheet *sheet);
354 gtk_sheet_get_visible_range (GtkSheet *sheet,
355 GtkSheetRange *range);
357 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
360 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
363 gtk_sheet_autoresize (GtkSheet *sheet);
366 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
369 gtk_sheet_autoscroll (GtkSheet *sheet);
372 gtk_sheet_set_clip_text (GtkSheet *sheet, gboolean clip_text);
375 gtk_sheet_clip_text (GtkSheet *sheet);
378 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
381 gtk_sheet_justify_entry (GtkSheet *sheet);
384 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
387 gtk_sheet_locked (const GtkSheet *sheet);
389 /* set sheet title */
391 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
393 /* freeze all visual updates of the sheet.
394 * Then thaw the sheet after you have made a number of changes.
395 * The updates will occure in a more efficent way than if
396 * you made them on a unfrozen sheet */
398 gtk_sheet_freeze (GtkSheet *sheet);
400 gtk_sheet_thaw (GtkSheet *sheet);
401 /* Background colors */
403 gtk_sheet_set_background (GtkSheet *sheet,
406 gtk_sheet_set_grid (GtkSheet *sheet,
407 GdkColor *grid_color);
409 gtk_sheet_show_grid (GtkSheet *sheet,
412 gtk_sheet_grid_visible (GtkSheet *sheet);
414 /* set/get column title */
416 gtk_sheet_set_column_title (GtkSheet * sheet,
418 const gchar * title);
421 gtk_sheet_get_column_title (GtkSheet * sheet,
424 /* set/get row title */
426 gtk_sheet_set_row_title (GtkSheet * sheet,
428 const gchar * title);
430 gtk_sheet_get_row_title (GtkSheet * sheet,
434 /* set/get button label */
436 gtk_sheet_row_button_add_label (GtkSheet *sheet,
437 gint row, const gchar *label);
439 gtk_sheet_row_button_get_label (GtkSheet *sheet,
442 gtk_sheet_row_button_justify (GtkSheet *sheet,
443 gint row, GtkJustification justification);
447 /* scroll the viewing area of the sheet to the given column
448 * and row; row_align and col_align are between 0-1 representing the
449 * location the row should appear on the screen, 0.0 being top or left,
450 * 1.0 being bottom or right; if row or column is negative then there
453 gtk_sheet_moveto (GtkSheet *sheet,
461 gtk_sheet_show_row_titles (GtkSheet *sheet);
463 gtk_sheet_hide_row_titles (GtkSheet *sheet);
465 gtk_sheet_row_titles_visible (GtkSheet *sheet);
468 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
469 * otherwise it acts as a title */
471 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
472 gint row, gboolean sensitive);
474 /* set sensitivity for all row buttons */
476 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
478 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
480 gtk_sheet_rows_resizable (GtkSheet *sheet);
482 /* set row visibility. The default value is TRUE. If FALSE, the
485 gtk_sheet_row_set_visibility (GtkSheet *sheet,
486 gint row, gboolean visible);
488 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
489 gint row, gboolean visible);
491 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
494 /* select the row. The range is then highlighted, and the bounds are stored
497 gtk_sheet_select_row (GtkSheet * sheet,
500 /* select the column. The range is then highlighted, and the bounds are stored
503 gtk_sheet_select_column (GtkSheet * sheet,
506 /* save selected range to "clipboard" */
508 gtk_sheet_clip_range (GtkSheet *sheet, const GtkSheetRange *range);
511 gtk_sheet_unclip_range (GtkSheet *sheet);
514 gtk_sheet_in_clip (GtkSheet *sheet);
516 /* get scrollbars adjustment */
518 gtk_sheet_get_vadjustment (GtkSheet * sheet);
520 gtk_sheet_get_hadjustment (GtkSheet * sheet);
522 /* highlight the selected range and store bounds in sheet->range */
523 void gtk_sheet_select_range (GtkSheet *sheet,
524 const GtkSheetRange *range);
527 void gtk_sheet_unselect_range (GtkSheet *sheet);
529 /* set active cell where the entry will be displayed
530 * returns FALSE if current cell can't be deactivated or
531 * requested cell can't be activated */
533 gtk_sheet_set_active_cell (GtkSheet *sheet,
534 gint row, gint column);
536 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
537 ROW and/or COLUMN may be null if the caller is not interested in their
540 gtk_sheet_get_active_cell (GtkSheet *sheet,
541 gint *row, gint *column);
543 /* set cell contents and allocate memory if needed */
545 gtk_sheet_set_cell (GtkSheet *sheet,
547 GtkJustification justification,
550 gtk_sheet_set_cell_text (GtkSheet *sheet,
553 /* get cell contents */
555 gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
557 /* clear cell contents */
559 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
560 /* clear cell contents and remove links */
562 gtk_sheet_cell_delete (GtkSheet *sheet, gint row, gint col);
564 /* clear range contents. If range==NULL the whole sheet will be cleared */
566 gtk_sheet_range_clear (GtkSheet *sheet,
567 const GtkSheetRange *range);
568 /* clear range contents and remove links */
570 gtk_sheet_range_delete (GtkSheet *sheet,
571 const GtkSheetRange *range);
573 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
575 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
577 /* get row and column correspondig to the given position in the screen */
579 gtk_sheet_get_pixel_info (GtkSheet * sheet,
585 /* get area of a given cell */
587 gtk_sheet_get_cell_area (GtkSheet *sheet,
594 gtk_sheet_set_row_height (GtkSheet * sheet,
599 /* delete nrows rows starting in row */
601 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
603 /* append nrows row to the end of the sheet */
605 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
607 /* insert nrows rows before the given row and pull right */
609 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
611 /* set abckground color of the given range */
613 gtk_sheet_range_set_background (GtkSheet *sheet,
614 const GtkSheetRange *range,
615 const GdkColor *color);
617 /* set foreground color (text color) of the given range */
619 gtk_sheet_range_set_foreground (GtkSheet *sheet,
620 const GtkSheetRange *range,
621 const GdkColor *color);
623 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
624 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
625 * default justification for numbers is GTK_JUSTIFY_RIGHT */
627 gtk_sheet_range_set_justification (GtkSheet *sheet,
628 const GtkSheetRange *range,
629 GtkJustification justification);
631 gtk_sheet_column_set_justification (GtkSheet *sheet,
633 GtkJustification justification);
634 /* set if cell contents can be edited or not in the given range:
635 * accepted values are TRUE or FALSE. */
637 gtk_sheet_range_set_editable (GtkSheet *sheet,
638 const GtkSheetRange *range,
641 /* set if cell contents are visible or not in the given range:
642 * accepted values are TRUE or FALSE.*/
644 gtk_sheet_range_set_visible (GtkSheet *sheet,
645 const GtkSheetRange *range,
648 /* set cell border style in the given range.
649 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
651 * width is the width of the border line in pixels
652 * line_style is the line_style for the border line */
654 gtk_sheet_range_set_border (GtkSheet *sheet,
655 const GtkSheetRange *range,
660 /* set border color for the given range */
662 gtk_sheet_range_set_border_color (GtkSheet *sheet,
663 const GtkSheetRange *range,
664 const GdkColor *color);
666 /* set font for the given range */
668 gtk_sheet_range_set_font (GtkSheet *sheet,
669 const GtkSheetRange *range,
670 PangoFontDescription *font);
672 /* get cell attributes of the given cell */
673 /* TRUE means that the cell is currently allocated */
675 gtk_sheet_get_attributes (const GtkSheet *sheet,
677 GtkSheetCellAttr *attributes);
681 gtk_sheet_put (GtkSheet *sheet,
685 gtk_sheet_attach_floating (GtkSheet *sheet,
689 gtk_sheet_attach_default (GtkSheet *sheet,
693 gtk_sheet_attach (GtkSheet *sheet,
703 gtk_sheet_move_child (GtkSheet *sheet,
708 gtk_sheet_get_child_at (GtkSheet *sheet,
712 gtk_sheet_button_attach (GtkSheet *sheet,
718 void gtk_sheet_set_model (GtkSheet *sheet,
721 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
726 #endif /* __cplusplus */
729 #endif /* __GTK_SHEET_H__ */