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_ROW_TITLES_VISIBLE(sheet) gtk_sheet_row_titles_visible (sheet)
78 #define GTK_SHEET_COL_TITLES_VISIBLE(sheet) gtk_sheet_column_titles_visible (sheet)
79 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll (sheet)
80 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry (sheet)
83 typedef struct _GtkSheetClass GtkSheetClass;
84 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
85 typedef struct _GtkSheetCell GtkSheetCell;
86 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
89 struct _GtkSheetCellAttr
91 GtkJustification justification;
92 const PangoFontDescription *font_desc;
95 GtkSheetCellBorder border;
106 struct _GtkSheetHoverTitle
115 GtkContainer container;
118 gboolean dispose_has_run;
119 GSheetColumn *column_geometry;
120 GSheetRow *row_geometry;
126 GtkSelectionMode selection_mode;
129 gboolean justify_entry;
131 /* Background colors */
139 /* allocation rectangle after the container_border_width
140 and the width of the shadow border */
141 GdkRectangle internal_allocation;
143 gint16 column_requisition;
144 gint16 row_requisition;
146 gboolean rows_resizable;
147 gboolean columns_resizable;
150 GtkSheetCell active_cell;
152 /* The GtkEntry used for editing the cells */
153 GtkWidget *entry_widget;
155 /* The widget containing entry_widget, or
156 entry_widget itself if no container */
157 GtkWidget *entry_container;
159 /* The type of entry_widget */
162 /* expanding selection */
163 GtkSheetCell selection_cell;
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;
208 /* xor GC for the verticle drag line */
211 /* gc for drawing unselected cells */
215 /* cursor used to indicate dragging */
216 GdkCursor *cursor_drag;
218 /* the current x-pixel location of the xor-drag vline */
221 /* the current y-pixel location of the xor-drag hline */
224 /* current cell being dragged */
225 GtkSheetCell drag_cell;
226 /* current range being dragged */
227 GtkSheetRange drag_range;
229 /* Used for the subtitle (popups) */
231 GtkSheetHoverTitle *hover_window;
234 struct _GtkSheetClass
236 GtkContainerClass parent_class;
238 void (*set_scroll_adjustments) (GtkSheet *sheet,
239 GtkAdjustment *hadjustment,
240 GtkAdjustment *vadjustment);
242 void (*select_row) (GtkSheet *sheet, gint row);
244 void (*select_column) (GtkSheet *sheet, gint column);
246 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
248 void (*resize_range) (GtkSheet *sheet,
249 GtkSheetRange *old_range,
250 GtkSheetRange *new_range);
252 void (*move_range) (GtkSheet *sheet,
253 GtkSheetRange *old_range,
254 GtkSheetRange *new_range);
256 gboolean (*traverse) (GtkSheet *sheet,
257 gint row, gint column,
258 gint *new_row, gint *new_column);
260 gboolean (*deactivate) (GtkSheet *sheet,
261 gint row, gint column);
263 gboolean (*activate) (GtkSheet *sheet,
264 gint row, gint column);
266 void (*changed) (GtkSheet *sheet,
267 gint row, gint column);
270 GType gtk_sheet_get_type (void);
271 GtkType gtk_sheet_range_get_type (void);
274 /* create a new sheet */
275 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
281 /* create a new browser sheet. It cells can not be edited */
283 gtk_sheet_new_browser (guint rows, guint columns, const gchar *title);
286 gtk_sheet_construct_browser (GtkSheet *sheet,
287 guint rows, guint columns, const gchar *title);
289 /* create a new sheet with custom entry */
291 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
295 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
299 /* change scroll adjustments */
301 gtk_sheet_set_hadjustment (GtkSheet *sheet,
302 GtkAdjustment *adjustment);
304 gtk_sheet_set_vadjustment (GtkSheet *sheet,
305 GtkAdjustment *adjustment);
308 gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
310 /* Returns sheet's entry widget */
312 gtk_sheet_get_entry (GtkSheet *sheet);
314 gtk_sheet_get_entry_widget (GtkSheet *sheet);
316 /* Returns sheet->state
317 * Added by Steven Rostedt <steven.rostedt@lmco.com> */
319 gtk_sheet_get_state (GtkSheet *sheet);
321 /* Returns sheet's ranges
322 * Added by Murray Cumming */
324 gtk_sheet_get_columns_count (GtkSheet *sheet);
327 gtk_sheet_get_rows_count (GtkSheet *sheet);
330 gtk_sheet_get_visible_range (GtkSheet *sheet,
331 GtkSheetRange *range);
334 gtk_sheet_get_selected_range (GtkSheet *sheet,
335 GtkSheetRange *range);
338 gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
341 gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
344 gtk_sheet_autoresize (GtkSheet *sheet);
347 gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
350 gtk_sheet_autoscroll (GtkSheet *sheet);
353 gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
356 gtk_sheet_justify_entry (GtkSheet *sheet);
359 gtk_sheet_set_locked (GtkSheet *sheet, gboolean lock);
362 gtk_sheet_locked (const GtkSheet *sheet);
364 /* set sheet title */
366 gtk_sheet_set_title (GtkSheet *sheet, const gchar *title);
368 /* freeze all visual updates of the sheet.
369 * Then thaw the sheet after you have made a number of changes.
370 * The updates will occure in a more efficent way than if
371 * you made them on a unfrozen sheet */
373 gtk_sheet_freeze (GtkSheet *sheet);
375 gtk_sheet_thaw (GtkSheet *sheet);
376 /* Background colors */
378 gtk_sheet_set_background (GtkSheet *sheet,
381 gtk_sheet_set_grid (GtkSheet *sheet,
382 GdkColor *grid_color);
384 gtk_sheet_show_grid (GtkSheet *sheet,
387 gtk_sheet_grid_visible (GtkSheet *sheet);
389 /* set/get column title */
391 gtk_sheet_set_column_title (GtkSheet * sheet,
393 const gchar * title);
396 gtk_sheet_get_column_title (GtkSheet * sheet,
399 /* set/get row title */
401 gtk_sheet_set_row_title (GtkSheet * sheet,
403 const gchar * title);
405 gtk_sheet_get_row_title (GtkSheet * sheet,
409 /* set/get button label */
411 gtk_sheet_row_button_add_label (GtkSheet *sheet,
412 gint row, const gchar *label);
414 gtk_sheet_row_button_get_label (GtkSheet *sheet,
417 gtk_sheet_row_button_justify (GtkSheet *sheet,
418 gint row, GtkJustification justification);
422 /* scroll the viewing area of the sheet to the given column
423 * and row; row_align and col_align are between 0-1 representing the
424 * location the row should appear on the screen, 0.0 being top or left,
425 * 1.0 being bottom or right; if row or column is negative then there
428 gtk_sheet_moveto (GtkSheet *sheet,
436 gtk_sheet_show_row_titles (GtkSheet *sheet);
438 gtk_sheet_hide_row_titles (GtkSheet *sheet);
440 gtk_sheet_show_column_titles (GtkSheet *sheet);
442 gtk_sheet_hide_column_titles (GtkSheet *sheet);
445 gtk_sheet_row_titles_visible (GtkSheet *sheet);
448 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
449 * otherwise it acts as a title */
451 gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
452 gint row, gboolean sensitive);
454 /* set sensitivity for all row buttons */
456 gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
458 gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
460 gtk_sheet_rows_resizable (GtkSheet *sheet);
462 /* set row visibility. The default value is TRUE. If FALSE, the
465 gtk_sheet_row_set_visibility (GtkSheet *sheet,
466 gint row, gboolean visible);
468 gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
469 gint row, gboolean visible);
471 gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
474 /* select the row. The range is then highlighted, and the bounds are stored
477 gtk_sheet_select_row (GtkSheet * sheet,
480 /* select the column. The range is then highlighted, and the bounds are stored
483 gtk_sheet_select_column (GtkSheet * sheet,
486 /* get scrollbars adjustment */
488 gtk_sheet_get_vadjustment (GtkSheet * sheet);
490 gtk_sheet_get_hadjustment (GtkSheet * sheet);
492 /* highlight the selected range and store bounds in sheet->range */
493 void gtk_sheet_select_range (GtkSheet *sheet,
494 const GtkSheetRange *range);
497 void gtk_sheet_unselect_range (GtkSheet *sheet);
499 /* set active cell where the entry will be displayed
500 * returns FALSE if current cell can't be deactivated or
501 * requested cell can't be activated */
503 gtk_sheet_set_active_cell (GtkSheet *sheet,
504 gint row, gint column);
506 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
507 ROW and/or COLUMN may be null if the caller is not interested in their
510 gtk_sheet_get_active_cell (GtkSheet *sheet,
511 gint *row, gint *column);
513 /* set cell contents and allocate memory if needed */
515 gtk_sheet_set_cell (GtkSheet *sheet,
517 GtkJustification justification,
520 gtk_sheet_set_cell_text (GtkSheet *sheet,
523 /* get cell contents */
525 gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
527 /* clear cell contents */
529 gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
531 /* clear range contents. If range==NULL the whole sheet will be cleared */
533 gtk_sheet_range_clear (GtkSheet *sheet,
534 const GtkSheetRange *range);
536 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
538 gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
540 /* get row and column correspondig to the given position in the screen */
542 gtk_sheet_get_pixel_info (GtkSheet * sheet,
548 /* get area of a given cell */
550 gtk_sheet_get_cell_area (GtkSheet *sheet,
557 gtk_sheet_set_row_height (GtkSheet * sheet,
562 /* delete nrows rows starting in row */
564 gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
566 /* append nrows row to the end of the sheet */
568 gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
570 /* insert nrows rows before the given row and pull right */
572 gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
574 /* set abckground color of the given range */
576 gtk_sheet_range_set_background (GtkSheet *sheet,
577 const GtkSheetRange *range,
578 const GdkColor *color);
580 /* set foreground color (text color) of the given range */
582 gtk_sheet_range_set_foreground (GtkSheet *sheet,
583 const GtkSheetRange *range,
584 const GdkColor *color);
586 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
587 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
588 * default justification for numbers is GTK_JUSTIFY_RIGHT */
590 gtk_sheet_range_set_justification (GtkSheet *sheet,
591 const GtkSheetRange *range,
592 GtkJustification justification);
594 gtk_sheet_column_set_justification (GtkSheet *sheet,
596 GtkJustification justification);
597 /* set if cell contents can be edited or not in the given range:
598 * accepted values are TRUE or FALSE. */
600 gtk_sheet_range_set_editable (GtkSheet *sheet,
601 const GtkSheetRange *range,
604 /* set if cell contents are visible or not in the given range:
605 * accepted values are TRUE or FALSE.*/
607 gtk_sheet_range_set_visible (GtkSheet *sheet,
608 const GtkSheetRange *range,
611 /* set cell border style in the given range.
612 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
614 * width is the width of the border line in pixels
615 * line_style is the line_style for the border line */
617 gtk_sheet_range_set_border (GtkSheet *sheet,
618 const GtkSheetRange *range,
623 /* set border color for the given range */
625 gtk_sheet_range_set_border_color (GtkSheet *sheet,
626 const GtkSheetRange *range,
627 const GdkColor *color);
629 /* set font for the given range */
631 gtk_sheet_range_set_font (GtkSheet *sheet,
632 const GtkSheetRange *range,
633 PangoFontDescription *font);
635 /* get cell attributes of the given cell */
636 /* TRUE means that the cell is currently allocated */
638 gtk_sheet_get_attributes (const GtkSheet *sheet,
640 GtkSheetCellAttr *attributes);
644 gtk_sheet_put (GtkSheet *sheet,
648 gtk_sheet_attach_floating (GtkSheet *sheet,
652 gtk_sheet_attach_default (GtkSheet *sheet,
656 gtk_sheet_attach (GtkSheet *sheet,
666 gtk_sheet_move_child (GtkSheet *sheet,
671 gtk_sheet_get_child_at (GtkSheet *sheet,
675 gtk_sheet_button_attach (GtkSheet *sheet,
681 void gtk_sheet_set_model (GtkSheet *sheet,
684 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
689 #endif /* __cplusplus */
692 #endif /* __GTK_SHEET_H__ */