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"
45 GTK_SHEET_JUSTIFICATION,
47 GTK_SHEET_BORDER_COLOR,
48 GTK_SHEET_IS_EDITABLE,
57 GTK_SHEET_ROW_SELECTED,
58 GTK_SHEET_COLUMN_SELECTED,
59 GTK_SHEET_RANGE_SELECTED
63 #define GTK_TYPE_SHEET_RANGE (gtk_sheet_range_get_type ())
64 #define GTK_TYPE_SHEET (gtk_sheet_get_type ())
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 ())
72 #define GTK_SHEET_AUTORESIZE(sheet) gtk_sheet_autoresize (sheet)
73 #define GTK_SHEET_AUTO_SCROLL(sheet) gtk_sheet_autoscroll (sheet)
74 #define GTK_SHEET_JUSTIFY_ENTRY(sheet) gtk_sheet_justify_entry (sheet)
77 typedef struct _GtkSheetClass GtkSheetClass;
78 typedef struct _GtkSheetCellAttr GtkSheetCellAttr;
79 typedef struct _GtkSheetCell GtkSheetCell;
80 typedef struct _GtkSheetHoverTitle GtkSheetHoverTitle;
83 struct _GtkSheetCellAttr
85 GtkJustification justification;
86 const PangoFontDescription *font_desc;
89 GtkSheetCellBorder border;
101 struct _GtkSheetHoverTitle
112 gboolean dispose_has_run;
113 GSheetColumn *column_geometry;
114 GSheetRow *row_geometry;
120 GtkSelectionMode selection_mode;
123 gboolean justify_entry;
125 /* Background colors */
130 /* allocation rectangle after the container_border_width
131 and the width of the shadow border */
132 GdkRectangle internal_allocation;
134 gint16 column_requisition;
135 gint16 row_requisition;
137 gboolean rows_resizable;
138 gboolean columns_resizable;
141 GtkSheetCell active_cell;
143 /* The GtkEntry used for editing the cells */
144 GtkWidget *entry_widget;
146 /* The widget containing entry_widget, or
147 entry_widget itself if no container */
148 GtkWidget *entry_container;
150 /* The type of entry_widget */
153 /* expanding selection */
154 GtkSheetCell selection_cell;
156 /* global selection button */
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;
171 /* sheet backing pixmap */
174 /* border shadow style */
175 GtkShadowType shadow_type;
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;
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;
192 GtkAdjustment *hadjustment;
193 GtkAdjustment *vadjustment;
195 /* xor GC for the verticle drag line */
198 /* gc for drawing unselected cells */
202 /* cursor used to indicate dragging */
203 GdkCursor *cursor_drag;
205 /* the current x-pixel location of the xor-drag vline */
208 /* the current y-pixel location of the xor-drag hline */
211 /* current cell being dragged */
212 GtkSheetCell drag_cell;
213 /* current range being dragged */
214 GtkSheetRange drag_range;
216 /* Used for the subtitle (popups) */
218 GtkSheetHoverTitle *hover_window;
221 struct _GtkSheetClass
223 GtkBinClass parent_class;
225 void (*set_scroll_adjustments) (GtkSheet *sheet,
226 GtkAdjustment *hadjustment,
227 GtkAdjustment *vadjustment);
229 void (*select_row) (GtkSheet *sheet, gint row);
231 void (*select_column) (GtkSheet *sheet, gint column);
233 void (*select_range) (GtkSheet *sheet, GtkSheetRange *range);
235 void (*resize_range) (GtkSheet *sheet,
236 GtkSheetRange *old_range,
237 GtkSheetRange *new_range);
239 void (*move_range) (GtkSheet *sheet,
240 GtkSheetRange *old_range,
241 GtkSheetRange *new_range);
243 gboolean (*traverse) (GtkSheet *sheet,
244 gint row, gint column,
245 gint *new_row, gint *new_column);
247 gboolean (*deactivate) (GtkSheet *sheet,
248 gint row, gint column);
250 gboolean (*activate) (GtkSheet *sheet,
251 gint row, gint column);
253 void (*changed) (GtkSheet *sheet,
254 gint row, gint column);
257 GType gtk_sheet_get_type (void);
258 GtkType gtk_sheet_range_get_type (void);
261 /* create a new sheet */
262 GtkWidget * gtk_sheet_new (GSheetRow *vgeo, GSheetColumn *hgeo,
265 /* create a new sheet with custom entry */
267 gtk_sheet_new_with_custom_entry (GSheetRow *vgeo,
271 gtk_sheet_construct_with_custom_entry (GtkSheet *sheet,
276 void gtk_sheet_change_entry (GtkSheet *sheet, GtkType entry_type);
278 GtkWidget *gtk_sheet_get_entry (GtkSheet *sheet);
281 guint gtk_sheet_get_columns_count (GtkSheet *sheet);
283 guint gtk_sheet_get_rows_count (GtkSheet *sheet);
285 void gtk_sheet_get_selected_range (GtkSheet *sheet,
286 GtkSheetRange *range);
288 void gtk_sheet_set_selection_mode (GtkSheet *sheet, gint mode);
290 void gtk_sheet_set_autoresize (GtkSheet *sheet, gboolean autoresize);
292 gboolean gtk_sheet_autoresize (GtkSheet *sheet);
294 void gtk_sheet_set_autoscroll (GtkSheet *sheet, gboolean autoscroll);
296 gboolean gtk_sheet_autoscroll (GtkSheet *sheet);
298 void gtk_sheet_set_justify_entry (GtkSheet *sheet, gboolean justify);
300 gboolean gtk_sheet_justify_entry (GtkSheet *sheet);
302 /* Background colors */
303 void gtk_sheet_set_background (GtkSheet *sheet,
306 void gtk_sheet_set_grid (GtkSheet *sheet,
307 GdkColor *grid_color);
309 void gtk_sheet_show_grid (GtkSheet *sheet,
312 gboolean gtk_sheet_grid_visible (GtkSheet *sheet);
314 /* set/get column title */
315 void gtk_sheet_set_column_title (GtkSheet * sheet,
317 const gchar * title);
319 const gchar *gtk_sheet_get_column_title (GtkSheet * sheet,
322 /* set/get row title */
323 void gtk_sheet_set_row_title (GtkSheet * sheet,
325 const gchar * title);
327 const gchar *gtk_sheet_get_row_title (GtkSheet * sheet,
330 /* set/get button label */
331 void gtk_sheet_row_button_add_label (GtkSheet *sheet,
332 gint row, const gchar *label);
334 const gchar *gtk_sheet_row_button_get_label (GtkSheet *sheet,
337 void gtk_sheet_row_button_justify (GtkSheet *sheet,
338 gint row, GtkJustification justification);
340 /* scroll the viewing area of the sheet to the given column
341 * and row; row_align and col_align are between 0-1 representing the
342 * location the row should appear on the screen, 0.0 being top or left,
343 * 1.0 being bottom or right; if row or column is negative then there
345 void gtk_sheet_moveto (GtkSheet *sheet,
352 void gtk_sheet_show_row_titles (GtkSheet *sheet);
353 void gtk_sheet_hide_row_titles (GtkSheet *sheet);
354 void gtk_sheet_show_column_titles (GtkSheet *sheet);
355 void gtk_sheet_hide_column_titles (GtkSheet *sheet);
357 gboolean gtk_sheet_row_titles_visible (GtkSheet *sheet);
360 /* set row button sensitivity. If sensitivity is TRUE can be toggled,
361 * otherwise it acts as a title */
362 void gtk_sheet_row_set_sensitivity (GtkSheet *sheet,
363 gint row, gboolean sensitive);
365 /* set sensitivity for all row buttons */
366 void gtk_sheet_rows_set_sensitivity (GtkSheet *sheet, gboolean sensitive);
367 void gtk_sheet_rows_set_resizable (GtkSheet *sheet, gboolean resizable);
368 gboolean gtk_sheet_rows_resizable (GtkSheet *sheet);
370 /* set row visibility. The default value is TRUE. If FALSE, the
372 void gtk_sheet_row_set_visibility (GtkSheet *sheet,
373 gint row, gboolean visible);
375 void gtk_sheet_row_label_set_visibility (GtkSheet *sheet,
376 gint row, gboolean visible);
378 void gtk_sheet_rows_labels_set_visibility (GtkSheet *sheet, gboolean visible);
381 /* select the row. The range is then highlighted, and the bounds are stored
383 void gtk_sheet_select_row (GtkSheet * sheet, gint row);
385 /* select the column. The range is then highlighted, and the bounds are stored
387 void gtk_sheet_select_column (GtkSheet * sheet, gint column);
389 /* highlight the selected range and store bounds in sheet->range */
390 void gtk_sheet_select_range (GtkSheet *sheet, const GtkSheetRange *range);
392 void gtk_sheet_get_visible_range (GtkSheet *sheet, GtkSheetRange *range);
396 void gtk_sheet_unselect_range (GtkSheet *sheet);
398 /* set active cell where the entry will be displayed
399 * returns FALSE if current cell can't be deactivated or
400 * requested cell can't be activated */
401 gboolean gtk_sheet_set_active_cell (GtkSheet *sheet,
402 gint row, gint column);
404 /* Sets *ROW and *COLUMN to be the coordinates of the active cell.
405 ROW and/or COLUMN may be null if the caller is not interested in their
407 void gtk_sheet_get_active_cell (GtkSheet *sheet,
408 gint *row, gint *column);
410 /* get cell contents */
411 gchar *gtk_sheet_cell_get_text (const GtkSheet *sheet, gint row, gint col);
413 /* clear cell contents */
414 void gtk_sheet_cell_clear (GtkSheet *sheet, gint row, gint col);
416 /* clear range contents. If range==NULL the whole sheet will be cleared */
417 void gtk_sheet_range_clear (GtkSheet *sheet,
418 const GtkSheetRange *range);
420 /* get cell state: GTK_STATE_NORMAL, GTK_STATE_SELECTED */
421 GtkStateType gtk_sheet_cell_get_state (GtkSheet *sheet, gint row, gint col);
423 /* get area of a given cell */
424 gboolean gtk_sheet_get_cell_area (GtkSheet *sheet,
430 void gtk_sheet_set_row_height (GtkSheet * sheet,
435 /* delete nrows rows starting in row */
436 void gtk_sheet_delete_rows (GtkSheet *sheet, guint row, guint nrows);
438 /* append nrows row to the end of the sheet */
439 void gtk_sheet_add_row (GtkSheet *sheet, guint nrows);
441 /* insert nrows rows before the given row and pull right */
442 void gtk_sheet_insert_rows (GtkSheet *sheet, guint row, guint nrows);
444 /* set abckground color of the given range */
445 void gtk_sheet_range_set_background (GtkSheet *sheet,
446 const GtkSheetRange *range,
447 const GdkColor *color);
449 /* set foreground color (text color) of the given range */
450 void gtk_sheet_range_set_foreground (GtkSheet *sheet,
451 const GtkSheetRange *range,
452 const GdkColor *color);
454 /* set text justification (GTK_JUSTIFY_LEFT, RIGHT, CENTER) of the given range.
455 * The default value is GTK_JUSTIFY_LEFT. If autoformat is on, the
456 * default justification for numbers is GTK_JUSTIFY_RIGHT */
457 void gtk_sheet_range_set_justification (GtkSheet *sheet,
458 const GtkSheetRange *range,
459 GtkJustification justification);
461 void gtk_sheet_column_set_justification (GtkSheet *sheet,
463 GtkJustification justification);
465 /* set if cell contents can be edited or not in the given range:
466 * accepted values are TRUE or FALSE. */
467 void gtk_sheet_range_set_editable (GtkSheet *sheet,
468 const GtkSheetRange *range,
471 /* set if cell contents are visible or not in the given range:
472 * accepted values are TRUE or FALSE.*/
473 void gtk_sheet_range_set_visible (GtkSheet *sheet,
474 const GtkSheetRange *range,
477 /* set cell border style in the given range.
478 * mask values are CELL_LEFT_BORDER, CELL_RIGHT_BORDER, CELL_TOP_BORDER,
480 * width is the width of the border line in pixels
481 * line_style is the line_style for the border line */
482 void gtk_sheet_range_set_border (GtkSheet *sheet,
483 const GtkSheetRange *range,
488 /* set border color for the given range */
489 void gtk_sheet_range_set_border_color (GtkSheet *sheet,
490 const GtkSheetRange *range,
491 const GdkColor *color);
493 /* set font for the given range */
494 void gtk_sheet_range_set_font (GtkSheet *sheet,
495 const GtkSheetRange *range,
496 PangoFontDescription *font);
498 /* get cell attributes of the given cell */
499 /* TRUE means that the cell is currently allocated */
500 gboolean gtk_sheet_get_attributes (const GtkSheet *sheet,
502 GtkSheetCellAttr *attributes);
505 void gtk_sheet_set_model (GtkSheet *sheet,
508 GSheetModel * gtk_sheet_get_model (const GtkSheet *sheet);
514 #endif /* __GTK_SHEET_H__ */