sheet.h 14 KB
Newer Older
1 2
#ifndef GNUMERIC_SHEET_H
#define GNUMERIC_SHEET_H
3

4 5 6
#define SHEET_MAX_ROWS (16 * 1024)
#define SHEET_MAX_COLS 256

7 8
typedef GList ColStyleList;

9 10 11 12 13 14 15 16 17 18 19
typedef struct {
	int start_col, start_row;
	int end_col, end_row;
} Range;

gboolean   range_contains (Range *range, int col, int row);

typedef struct {
	Range  range;
	Style  *style;
} StyleRegion;
20 21

typedef struct {
22
	char       *filename;
23 24

        GtkWidget  *toplevel; 
Arturo Espinosa's avatar
Arturo Espinosa committed
25
	GtkWidget  *notebook;
26 27 28 29 30 31
	GtkWidget  *table;

	/* Edit area */
	GtkWidget  *ea_status;
	GtkWidget  *ea_button_box;
	GtkWidget  *ea_input;
Arturo Espinosa's avatar
Arturo Espinosa committed
32

33 34 35
        /* The status bar */
        GnomeAppBar * appbar;
  
Arturo Espinosa's avatar
Arturo Espinosa committed
36 37
	/* The auto-expression */
	ExprTree   *auto_expr;
38
	String     *auto_expr_desc;
Arturo Espinosa's avatar
Arturo Espinosa committed
39
	GnomeCanvasItem  *auto_expr_label;
Arturo Espinosa's avatar
Arturo Espinosa committed
40
	
Arturo Espinosa's avatar
Arturo Espinosa committed
41
	/* Styles */
Arturo Espinosa's avatar
Arturo Espinosa committed
42
	Style      style;
43 44

	/* The sheets */ 
Arturo Espinosa's avatar
Arturo Espinosa committed
45
	GHashTable *sheets;	/* keeps a list of the Sheets on this workbook */
46

47
	
48 49 50
	/* A list with all of the formulas */
	GList      *formula_cell_list;

Arturo Espinosa's avatar
Arturo Espinosa committed
51 52
	/* A queue with the cells to be evaluated */
	GList      *eval_queue;
53
	int        max_iterations;
54

55
	int        generation;
56

57 58
	/* The clipboard for this workbook */
	CellRegion *clipboard_contents;
59 60

	gboolean   have_x_selection;
61

Miguel de Icaza's avatar
Miguel de Icaza committed
62 63 64
	/* The Symbol table used for naming cell ranges in the workbook */
	SymbolTable *symbol_names;
	
65 66 67 68 69
	/*
	 * This is  used during the clipboard paste command to pass information
	 * to the asyncronous paste callback
	 */
	void       *clipboard_paste_callback_data;
70 71

	void       *toolbar;
Arturo Espinosa's avatar
Arturo Espinosa committed
72 73
} Workbook;

74 75 76 77 78 79
typedef struct {
	int        base_col, base_row;
	int        start_col, start_row;
	int        end_col, end_row;
} SheetSelection;

80 81 82 83 84
typedef enum {
	SHEET_MODE_SHEET,
	SHEET_MODE_CREATE_LINE,
	SHEET_MODE_CREATE_BOX,
	SHEET_MODE_CREATE_OVAL,
Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
85 86
	SHEET_MODE_CREATE_ARROW,
	SHEET_MODE_OBJECT_SELECTED,
87 88
} SheetModeType;

Arturo Espinosa's avatar
Arturo Espinosa committed
89
typedef struct {
Miguel de Icaza's avatar
Miguel de Icaza committed
90
	int         signature;
91
	
Miguel de Icaza's avatar
Miguel de Icaza committed
92 93
	Workbook    *workbook;
	GList       *sheet_views;
94
	
Miguel de Icaza's avatar
Miguel de Icaza committed
95
	char        *name;
96

Miguel de Icaza's avatar
Miguel de Icaza committed
97
	GList       *style_list;	/* The list of styles applied to the sheets */
98

Miguel de Icaza's avatar
Miguel de Icaza committed
99 100
	ColRowInfo  default_col_style;
	GList       *cols_info;
101

Miguel de Icaza's avatar
Miguel de Icaza committed
102 103
	ColRowInfo  default_row_style;
	GList       *rows_info;
Arturo Espinosa's avatar
Arturo Espinosa committed
104

Miguel de Icaza's avatar
Miguel de Icaza committed
105
	GHashTable  *cell_hash;	/* The cells in hashed format */
106

Miguel de Icaza's avatar
Miguel de Icaza committed
107
	GList       *selections;
108

Miguel de Icaza's avatar
Miguel de Icaza committed
109 110
	int         max_col_used;
	int         max_row_used;
111

Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
112 113
	int         cursor_col, cursor_row;
	
114 115 116
	/* The list of cells that have a comment */
	GList       *comment_list;
	
Miguel de Icaza's avatar
Miguel de Icaza committed
117
	double      last_zoom_factor_used;
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
118

119 120
	/* Objects */
	SheetModeType mode;	/* Sheet mode */
Miguel de Icaza's avatar
Miguel de Icaza committed
121 122 123 124
	GList       *objects;	/* List of objects in the spreadsheet */
	GList       *coords;	/* During creation time: keeps click coordinates */
	void        *current_object;

Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
125 126 127 128
	/*
	 * When editing a cell: the cell (may be NULL) and
	 * the original text of the cell
	 */
Miguel de Icaza's avatar
Miguel de Icaza committed
129 130 131
	String      *editing_saved_text;
	Cell        *editing_cell;
	int         editing;
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
132
	
Miguel de Icaza's avatar
Miguel de Icaza committed
133
	gboolean    modified;
134
	
135 136 137 138
	/* For walking trough a selection */
	struct {
		SheetSelection *current;
	} walk_info;
139 140
} Sheet;

141 142 143
#define SHEET_SIGNATURE 0x12349876
#define IS_SHEET(x) (((Sheet *) x)->signature == SHEET_SIGNATURE)

Arturo Espinosa's avatar
Arturo Espinosa committed
144 145 146
typedef  void (*sheet_col_row_callback)(Sheet *sheet, ColRowInfo *ci,
					void *user_data);

Arturo Espinosa's avatar
Arturo Espinosa committed
147 148
typedef  int (*sheet_cell_foreach_callback)(Sheet *sheet, int col, int row,
					    Cell *cell, void *user_data);
149

Arturo Espinosa's avatar
Arturo Espinosa committed
150
Sheet      *sheet_new                  	 (Workbook *wb, char *name);
Miguel de Icaza's avatar
Miguel de Icaza committed
151
void        sheet_rename                 (Sheet *sheet, const char *new_name);
Arturo Espinosa's avatar
Arturo Espinosa committed
152 153 154 155 156 157 158 159
void        sheet_destroy              	 (Sheet *sheet);
void        sheet_foreach_col          	 (Sheet *sheet,
					  sheet_col_row_callback callback,
					  void *user_data);
void        sheet_foreach_row          	 (Sheet *sheet,
					  sheet_col_row_callback,
					  void *user_data);
void        sheet_set_zoom_factor      	 (Sheet *sheet, double factor);
Arturo Espinosa's avatar
Arturo Espinosa committed
160
void        sheet_cursor_set             (Sheet *sheet,
161
					  int base_col,  int base_row,
Arturo Espinosa's avatar
Arturo Espinosa committed
162 163 164
					  int start_col, int start_row,
					  int end_col,   int end_row);
void        sheet_cursor_move            (Sheet *sheet, int col, int row);
165
void        sheet_make_cell_visible      (Sheet *sheet, int col, int row);
166 167

/* Selection management */
168
void        sheet_select_all             (Sheet *sheet);
169
int         sheet_is_all_selected        (Sheet *sheet);
170 171
void        sheet_selection_append       (Sheet *sheet, int col, int row);
void        sheet_selection_extend_to    (Sheet *sheet, int col, int row);
172 173 174
void	    sheet_selection_set		 (Sheet *sheet,
					  int start_col, int start_row,
					  int end_col, int end_row);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
175 176
void        sheet_selection_reset        (Sheet *sheet);
void        sheet_selection_reset_only   (Sheet *sheet);
177
int         sheet_selection_equal        (SheetSelection *a, SheetSelection *b);
Arturo Espinosa's avatar
Arturo Espinosa committed
178 179
void        sheet_selection_append_range (Sheet *sheet,
					  int base_col,  int base_row,
180 181
					  int start_col, int start_row,
					  int end_col,   int end_row);
Miguel de Icaza's avatar
Today:  
Miguel de Icaza committed
182
CellList   *sheet_selection_to_list      (Sheet *sheet);
183

Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
184
/* Operations on the selection */
185
void        sheet_selection_clear             (Sheet *sheet);
186
void        sheet_selection_clear_content     (Sheet *sheet);
187
void        sheet_selection_clear_comments    (Sheet *sheet);
188
void        sheet_selection_clear_formats     (Sheet *sheet);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
189

190
/* Cut/Copy/Paste on the workbook selection */
191 192 193
gboolean    sheet_selection_copy              (Sheet *sheet);
gboolean    sheet_selection_cut               (Sheet *sheet);
void        sheet_selection_paste             (Sheet *sheet,
194
					       int dest_col,    int dest_row,
Miguel de Icaza's avatar
Miguel de Icaza committed
195
					       int paste_flags, guint32 time32);
196 197 198 199
int         sheet_selection_walk_step         (Sheet *sheet,
					       int   forward,     int horizontal,
					       int   current_col, int current_row,
					       int   *new_col,    int *new_row);
200 201 202
void        sheet_selection_extend_horizontal (Sheet *sheet, int count);
void        sheet_selection_extend_vertical   (Sheet *sheet, int count);
int         sheet_selection_is_cell_selected  (Sheet *sheet, int col, int row);
Arturo Espinosa's avatar
Arturo Espinosa committed
203

Miguel de Icaza's avatar
Today:  
Miguel de Icaza committed
204 205
gboolean    sheet_verify_selection_simple     (Sheet *sheet, char *command_name);

Arturo Espinosa's avatar
Arturo Espinosa committed
206
/* Cell management */
Miguel de Icaza's avatar
Miguel de Icaza committed
207 208
void        sheet_set_text                (Sheet *sheet, int col, int row,
					   char *str);
209 210 211 212 213 214 215 216 217 218
Cell       *sheet_cell_new                (Sheet *sheet, int col, int row);
void        sheet_cell_add                (Sheet *sheet, Cell *cell,
				           int col, int row);
void        sheet_cell_remove             (Sheet *sheet, Cell *cell);
int         sheet_cell_foreach_range      (Sheet *sheet, int only_existing,
				           int start_col, int start_row,
				           int end_col, int end_row,
				           sheet_cell_foreach_callback callback,
				           void *closure);
Cell       *sheet_cell_get                (Sheet *sheet, int col, int row);
219
Cell       *sheet_cell_fetch              (Sheet *sheet, int col, int row);
220 221 222
void        sheet_cell_comment_link       (Cell *cell);
void        sheet_cell_comment_unlink     (Cell *cell);

223 224
void        sheet_cell_formula_link       (Cell *cell);
void        sheet_cell_formula_unlink     (Cell *cell);
225 226
gboolean    sheet_is_region_empty         (Sheet *sheet, int start_col, int start_row,
					   int end_col, int end_row);
Arturo Espinosa's avatar
Arturo Espinosa committed
227

Arturo Espinosa's avatar
Arturo Espinosa committed
228
/* Create new ColRowInfos from the default sheet style */
229 230 231 232
ColRowInfo *sheet_col_new                  (Sheet *sheet);
ColRowInfo *sheet_row_new                  (Sheet *sheet);
int         sheet_row_check_bound          (int row, int diff);
int         sheet_col_check_bound          (int col, int diff);
Arturo Espinosa's avatar
Arturo Espinosa committed
233 234

/* Duplicates the information of a col/row */
235
ColRowInfo *sheet_duplicate_colrow        (ColRowInfo *original);
Arturo Espinosa's avatar
Arturo Espinosa committed
236 237

/* Retrieve information from a col/row */
238 239
ColRowInfo *sheet_col_get_info            (Sheet *sheet, int col);
ColRowInfo *sheet_row_get_info            (Sheet *sheet, int row);
Arturo Espinosa's avatar
Arturo Espinosa committed
240

Arturo Espinosa's avatar
Arturo Espinosa committed
241
/* Returns a pointer to a ColRowInfo: existed or freshly created */
242 243
ColRowInfo *sheet_row_get                 (Sheet *sheet, int pos);
ColRowInfo *sheet_col_get                 (Sheet *sheet, int pos);
Arturo Espinosa's avatar
Arturo Espinosa committed
244

Arturo Espinosa's avatar
Arturo Espinosa committed
245
/* Add a ColRowInfo to the Sheet */
246 247
void        sheet_col_add                 (Sheet *sheet, ColRowInfo *cp);
void        sheet_row_add                 (Sheet *sheet, ColRowInfo *cp);
Arturo Espinosa's avatar
Arturo Espinosa committed
248 249

/* Measure distances in pixels from one col/row to another */
250 251
int         sheet_col_get_distance        (Sheet *sheet, int from_col, int to_col);
int         sheet_row_get_distance        (Sheet *sheet, int from_row, int to_row);
Arturo Espinosa's avatar
Arturo Espinosa committed
252
 
253 254 255 256 257 258 259 260 261
void        sheet_clear_region            (Sheet *sheet,
				           int start_col, int start_row,
				           int end_col,   int end_row);
void        sheet_clear_region_formats    (Sheet *sheet,
				           int start_col, int start_row,
				           int end_col,   int end_row);
void        sheet_clear_region_content    (Sheet *sheet,
				           int start_col, int start_row,
				           int end_col,   int end_row);
262 263 264
void        sheet_clear_region_comments   (Sheet *sheet,
				           int start_col, int start_row,
				           int end_col,   int end_row);	
Arturo Espinosa's avatar
Arturo Espinosa committed
265 266

/* Sets the width/height of a column row in terms of pixels */
267 268
void        sheet_col_set_width           (Sheet *sheet,
				           int col, int width);
269 270
void        sheet_col_info_set_width      (Sheet *sheet,
				           ColRowInfo *ci, int width);
271 272 273
void        sheet_row_set_height          (Sheet *sheet,
				           int row, int width,
				           gboolean height_set_by_user);
274 275 276
void        sheet_row_info_set_height     (Sheet *sheet,
				           ColRowInfo *ri, int width,
				           gboolean height_set_by_user);
277 278 279 280 281
void        sheet_row_set_internal_height (Sheet *sheet, ColRowInfo *ri, int height);
void        sheet_col_set_selection       (Sheet *sheet,
					   ColRowInfo *ci, int value);
void        sheet_row_set_selection       (Sheet *sheet,
					   ColRowInfo *ri, int value);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
282
				       
283 284 285
Style      *sheet_style_compute           (Sheet *sheet,
					   int col, int row,
					   int *non_default_style_flags);
Arturo Espinosa's avatar
Arturo Espinosa committed
286

287
/* Redraw */
288 289 290 291 292 293
void        sheet_compute_visible_ranges  (Sheet *sheet);
void        sheet_redraw_cell_region      (Sheet *sheet,
				           int start_col, int start_row,
				           int end_col,   int end_row);
void        sheet_redraw_selection        (Sheet *sheet, SheetSelection *ss);
void        sheet_redraw_all              (Sheet *sheet);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
294
				       
295
void        sheet_update_auto_expr        (Sheet *sheet);
296

297 298
void        sheet_mark_clean              (Sheet *sheet);

299
/* Sheet information manipulation */
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
void        sheet_insert_col              (Sheet *sheet,  int col, int count);
void        sheet_delete_col              (Sheet *sheet,  int col, int count);
void        sheet_insert_row              (Sheet *sheet,  int row, int count);
void        sheet_delete_row              (Sheet *sheet,  int row, int count);
void        sheet_shift_row               (Sheet *sheet,  int col, int row, int count);
void        sheet_shift_rows              (Sheet *sheet,  int col,
				           int start_row, int end_row, int count);
void        sheet_shift_col               (Sheet *sheet,  int col, int row, int count);
void        sheet_shift_cols              (Sheet *sheet,
				           int start_col, int end_col,
				           int row,       int count);

void        sheet_style_attach            (Sheet *sheet,
					   int    start_col, int start_row,
					   int    end_col,   int end_row,
					   Style  *style);
316
Sheet      *sheet_lookup_by_name          (Sheet *base, char *name);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
317 318 319 320 321 322

/*
 * Sheet visual editing
 */
void        sheet_start_editing_at_cursor (Sheet *sheet);
void        sheet_set_current_value       (Sheet *sheet);
323
void        sheet_accept_pending_input    (Sheet *sheet);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
324 325
void        sheet_cancel_pending_input    (Sheet *sheet);
void        sheet_load_cell_val           (Sheet *sheet);
326 327 328

int         sheet_col_selection_type      (Sheet *sheet, int col);
int         sheet_row_selection_type      (Sheet *sheet, int row);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
329

330 331 332 333 334 335
/*
 * Event state manipulation (for mode operation)
 */
void        sheet_set_mode_type           (Sheet *sheet, SheetModeType type);


Miguel de Icaza's avatar
Miguel de Icaza committed
336 337 338 339 340
/*
 * Callback routines.
 */
void        sheet_fill_selection_with     (Sheet *sheet, char *text);

Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
341 342 343 344 345 346
/*
 * Hiding/showing the cursor
 */
void        sheet_show_cursor             (Sheet *sheet);
void        sheet_hide_cursor             (Sheet *sheet);

347
char        *cellref_name                 (CellRef *cell_ref,
348 349 350 351
					   Sheet *eval_sheet,
					   int eval_col,
					   int eval_row);

Arturo Espinosa's avatar
Arturo Espinosa committed
352 353 354
/*
 * Workbook
 */
355
Workbook   *workbook_new                 (void);
Arturo Espinosa's avatar
Arturo Espinosa committed
356
void        workbook_destroy             (Workbook *wb);
357
Workbook   *workbook_new_with_sheets     (int sheet_count);
358

359 360
void        workbook_set_filename        (Workbook *, char *);
void        workbook_set_title           (Workbook *, char *);
361
Workbook   *workbook_read                (const char *filename);
362

363 364
void        workbook_save_as             (Workbook *);
void        workbook_save                (Workbook *);
365
void        workbook_attach_sheet        (Workbook *, Sheet *);
Arturo Espinosa's avatar
Arturo Espinosa committed
366
gboolean    workbook_detach_sheet        (Workbook *, Sheet *);
367
Sheet      *workbook_focus_current_sheet (Workbook *wb);
Arturo Espinosa's avatar
Arturo Espinosa committed
368
Sheet      *workbook_get_current_sheet   (Workbook *wb);
369
char       *workbook_sheet_get_free_name (Workbook *wb);
370
void        workbook_auto_expr_label_set (Workbook *wb, char *text);
371
void        workbook_next_generation     (Workbook *wb);
372 373
void        workbook_set_region_status   (Workbook *wb, char *str);
int         workbook_parse_and_jump      (Workbook *wb, char *text);
374
Sheet      *workbook_sheet_lookup        (Workbook *wb, char *sheet_name);
375
void        workbook_mark_clean          (Workbook *wb);
376
gboolean    workbook_rename_sheet        (Workbook *wb,
Miguel de Icaza's avatar
Miguel de Icaza committed
377 378
					  const char *old_name,
					  const char *new_name);
379
int         workbook_sheet_count         (Workbook *wb);
Arturo Espinosa's avatar
Arturo Espinosa committed
380
gboolean    workbook_can_detach_sheet    (Workbook *wb, Sheet *sheet);
Arturo Espinosa's avatar
Arturo Espinosa committed
381

Arturo Espinosa's avatar
Arturo Espinosa committed
382 383 384 385
/*
 * Does any pending recalculations
 */
void        workbook_recalc              (Workbook *wb);
386
void        workbook_recalc_all          (Workbook *wb);
Arturo Espinosa's avatar
Arturo Espinosa committed
387

388 389 390 391
/*
 * Callback routine: invoked when the first view ItemGrid
 * is realized to allocate the default styles
 */
392
void     workbook_realized            (Workbook *, GdkWindow *);
393

Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
394 395 396 397 398 399 400 401 402 403 404 405
/*
 * Feedback routines
 */
typedef enum {
	WORKBOOK_FEEDBACK_BOLD,
	WORKBOOK_FEEDBACK_ITALIC
} WorkbookFeedbackType;

void     workbook_feedback_set        (Workbook *,
				       WorkbookFeedbackType type,
				       void *data);

406
extern   Workbook *current_workbook;
407
#endif /* GNUMERIC_SHEET_H */
Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
408