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

4 5
#include "solver.h"

6 7 8
#define SHEET_MAX_ROWS (16 * 1024)
#define SHEET_MAX_COLS 256

9 10
typedef GList ColStyleList;

11 12 13 14 15 16 17 18 19 20 21
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;
22 23

typedef struct {
24
	char       *filename;
25 26

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

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

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

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

49
	
50 51 52
	/* A list with all of the formulas */
	GList      *formula_cell_list;

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

57
	int        generation;
58

59 60
	/* The clipboard for this workbook */
	CellRegion *clipboard_contents;
61 62

	gboolean   have_x_selection;
63

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

	void       *toolbar;
Arturo Espinosa's avatar
Arturo Espinosa committed
74 75
} Workbook;

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

82 83 84 85 86
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
87 88
	SHEET_MODE_CREATE_ARROW,
	SHEET_MODE_OBJECT_SELECTED,
89 90
} SheetModeType;

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

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

Miguel de Icaza's avatar
Miguel de Icaza committed
101 102
	ColRowInfo  default_col_style;
	GList       *cols_info;
103

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

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

Miguel de Icaza's avatar
Miguel de Icaza committed
109
	GList       *selections;
110

Miguel de Icaza's avatar
Miguel de Icaza committed
111 112
	int         max_col_used;
	int         max_row_used;
113

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

121 122
	/* Objects */
	SheetModeType mode;	/* Sheet mode */
Miguel de Icaza's avatar
Miguel de Icaza committed
123 124 125 126
	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
127 128 129 130
	/*
	 * 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
131 132 133
	String      *editing_saved_text;
	Cell        *editing_cell;
	int         editing;
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
134
	
Miguel de Icaza's avatar
Miguel de Icaza committed
135
	gboolean    modified;
136
	
137 138 139 140
	/* For walking trough a selection */
	struct {
		SheetSelection *current;
	} walk_info;
141 142 143

        /* Solver parameters */
        SolverParameters solver_parameters;
144 145
} Sheet;

146 147 148
#define SHEET_SIGNATURE 0x12349876
#define IS_SHEET(x) (((Sheet *) x)->signature == SHEET_SIGNATURE)

Arturo Espinosa's avatar
Arturo Espinosa committed
149 150 151
typedef  void (*sheet_col_row_callback)(Sheet *sheet, ColRowInfo *ci,
					void *user_data);

Arturo Espinosa's avatar
Arturo Espinosa committed
152 153
typedef  int (*sheet_cell_foreach_callback)(Sheet *sheet, int col, int row,
					    Cell *cell, void *user_data);
154

Arturo Espinosa's avatar
Arturo Espinosa committed
155
Sheet      *sheet_new                  	 (Workbook *wb, char *name);
Miguel de Icaza's avatar
Miguel de Icaza committed
156
void        sheet_rename                 (Sheet *sheet, const char *new_name);
Arturo Espinosa's avatar
Arturo Espinosa committed
157 158 159 160 161 162 163 164
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
165
void        sheet_cursor_set             (Sheet *sheet,
166
					  int base_col,  int base_row,
Arturo Espinosa's avatar
Arturo Espinosa committed
167 168 169
					  int start_col, int start_row,
					  int end_col,   int end_row);
void        sheet_cursor_move            (Sheet *sheet, int col, int row);
170
void        sheet_make_cell_visible      (Sheet *sheet, int col, int row);
171 172

/* Selection management */
173
void        sheet_select_all             (Sheet *sheet);
174
int         sheet_is_all_selected        (Sheet *sheet);
175 176
void        sheet_selection_append       (Sheet *sheet, int col, int row);
void        sheet_selection_extend_to    (Sheet *sheet, int col, int row);
177 178 179
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
180 181
void        sheet_selection_reset        (Sheet *sheet);
void        sheet_selection_reset_only   (Sheet *sheet);
182
int         sheet_selection_equal        (SheetSelection *a, SheetSelection *b);
Arturo Espinosa's avatar
Arturo Espinosa committed
183 184
void        sheet_selection_append_range (Sheet *sheet,
					  int base_col,  int base_row,
185 186
					  int start_col, int start_row,
					  int end_col,   int end_row);
187 188 189 190
int         sheet_selection_first_range  (Sheet *sheet,
					  int *base_col,  int *base_row,
					  int *start_col, int *start_row,
					  int *end_col,   int *end_row);
Miguel de Icaza's avatar
Today:  
Miguel de Icaza committed
191
CellList   *sheet_selection_to_list      (Sheet *sheet);
192

Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
193
/* Operations on the selection */
194
void        sheet_selection_clear             (Sheet *sheet);
195
void        sheet_selection_clear_content     (Sheet *sheet);
196
void        sheet_selection_clear_comments    (Sheet *sheet);
197
void        sheet_selection_clear_formats     (Sheet *sheet);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
198

199
/* Cut/Copy/Paste on the workbook selection */
200 201 202
gboolean    sheet_selection_copy              (Sheet *sheet);
gboolean    sheet_selection_cut               (Sheet *sheet);
void        sheet_selection_paste             (Sheet *sheet,
203
					       int dest_col,    int dest_row,
Miguel de Icaza's avatar
Miguel de Icaza committed
204
					       int paste_flags, guint32 time32);
205 206 207 208
int         sheet_selection_walk_step         (Sheet *sheet,
					       int   forward,     int horizontal,
					       int   current_col, int current_row,
					       int   *new_col,    int *new_row);
209 210 211
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
212

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

Arturo Espinosa's avatar
Arturo Espinosa committed
215
/* Cell management */
Miguel de Icaza's avatar
Miguel de Icaza committed
216 217
void        sheet_set_text                (Sheet *sheet, int col, int row,
					   char *str);
218 219 220 221 222 223 224 225 226 227
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);
228
Cell       *sheet_cell_fetch              (Sheet *sheet, int col, int row);
229 230 231
void        sheet_cell_comment_link       (Cell *cell);
void        sheet_cell_comment_unlink     (Cell *cell);

232 233
void        sheet_cell_formula_link       (Cell *cell);
void        sheet_cell_formula_unlink     (Cell *cell);
234 235
gboolean    sheet_is_region_empty_or_selected (Sheet *sheet, int start_col, int start_row,
					       int end_col, int end_row);
Arturo Espinosa's avatar
Arturo Espinosa committed
236

Arturo Espinosa's avatar
Arturo Espinosa committed
237
/* Create new ColRowInfos from the default sheet style */
238 239 240 241
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
242 243

/* Duplicates the information of a col/row */
244
ColRowInfo *sheet_duplicate_colrow        (ColRowInfo *original);
Arturo Espinosa's avatar
Arturo Espinosa committed
245 246

/* Retrieve information from a col/row */
247 248
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
249

Arturo Espinosa's avatar
Arturo Espinosa committed
250
/* Returns a pointer to a ColRowInfo: existed or freshly created */
251 252
ColRowInfo *sheet_row_get                 (Sheet *sheet, int pos);
ColRowInfo *sheet_col_get                 (Sheet *sheet, int pos);
Arturo Espinosa's avatar
Arturo Espinosa committed
253

Arturo Espinosa's avatar
Arturo Espinosa committed
254
/* Add a ColRowInfo to the Sheet */
255 256
void        sheet_col_add                 (Sheet *sheet, ColRowInfo *cp);
void        sheet_row_add                 (Sheet *sheet, ColRowInfo *cp);
Arturo Espinosa's avatar
Arturo Espinosa committed
257 258

/* Measure distances in pixels from one col/row to another */
259 260
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
261
 
262 263 264 265 266 267 268 269 270
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);
271 272 273
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
274 275

/* Sets the width/height of a column row in terms of pixels */
276 277
void        sheet_col_set_width           (Sheet *sheet,
				           int col, int width);
278 279
void        sheet_col_info_set_width      (Sheet *sheet,
				           ColRowInfo *ci, int width);
280 281 282
void        sheet_row_set_height          (Sheet *sheet,
				           int row, int width,
				           gboolean height_set_by_user);
283 284 285
void        sheet_row_info_set_height     (Sheet *sheet,
				           ColRowInfo *ri, int width,
				           gboolean height_set_by_user);
286 287 288 289 290
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
291
				       
292 293 294
Style      *sheet_style_compute           (Sheet *sheet,
					   int col, int row,
					   int *non_default_style_flags);
Arturo Espinosa's avatar
Arturo Espinosa committed
295

296
/* Redraw */
297 298 299 300 301 302
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
303
				       
304
void        sheet_update_auto_expr        (Sheet *sheet);
305

306 307
void        sheet_mark_clean              (Sheet *sheet);

308
/* Sheet information manipulation */
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
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);
325
Sheet      *sheet_lookup_by_name          (Sheet *base, char *name);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
326 327 328 329 330 331

/*
 * Sheet visual editing
 */
void        sheet_start_editing_at_cursor (Sheet *sheet);
void        sheet_set_current_value       (Sheet *sheet);
332
void        sheet_accept_pending_input    (Sheet *sheet);
Arturo Espinosa's avatar
Today:  
Arturo Espinosa committed
333 334
void        sheet_cancel_pending_input    (Sheet *sheet);
void        sheet_load_cell_val           (Sheet *sheet);
335 336 337

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
338

339 340 341 342 343 344
/*
 * Event state manipulation (for mode operation)
 */
void        sheet_set_mode_type           (Sheet *sheet, SheetModeType type);


Miguel de Icaza's avatar
Miguel de Icaza committed
345 346 347 348 349
/*
 * Callback routines.
 */
void        sheet_fill_selection_with     (Sheet *sheet, char *text);

Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
350 351 352 353 354 355
/*
 * Hiding/showing the cursor
 */
void        sheet_show_cursor             (Sheet *sheet);
void        sheet_hide_cursor             (Sheet *sheet);

356
char        *cellref_name                 (CellRef *cell_ref,
357 358 359 360
					   Sheet *eval_sheet,
					   int eval_col,
					   int eval_row);

Arturo Espinosa's avatar
Arturo Espinosa committed
361 362 363
/*
 * Workbook
 */
364
Workbook   *workbook_new                 (void);
Arturo Espinosa's avatar
Arturo Espinosa committed
365
void        workbook_destroy             (Workbook *wb);
366
Workbook   *workbook_new_with_sheets     (int sheet_count);
367

368 369
void        workbook_set_filename        (Workbook *, const char *);
void        workbook_set_title           (Workbook *, const char *);
370
Workbook   *workbook_read                (const char *filename);
371

372 373
void        workbook_save_as             (Workbook *);
void        workbook_save                (Workbook *);
374
void        workbook_attach_sheet        (Workbook *, Sheet *);
Arturo Espinosa's avatar
Arturo Espinosa committed
375
gboolean    workbook_detach_sheet        (Workbook *, Sheet *);
376
Sheet      *workbook_focus_current_sheet (Workbook *wb);
Arturo Espinosa's avatar
Arturo Espinosa committed
377
Sheet      *workbook_get_current_sheet   (Workbook *wb);
378
char       *workbook_sheet_get_free_name (Workbook *wb);
379
void        workbook_auto_expr_label_set (Workbook *wb, char *text);
380
void        workbook_next_generation     (Workbook *wb);
381 382
void        workbook_set_region_status   (Workbook *wb, char *str);
int         workbook_parse_and_jump      (Workbook *wb, char *text);
383
Sheet      *workbook_sheet_lookup        (Workbook *wb, char *sheet_name);
384
void        workbook_mark_clean          (Workbook *wb);
385
gboolean    workbook_rename_sheet        (Workbook *wb,
Miguel de Icaza's avatar
Miguel de Icaza committed
386 387
					  const char *old_name,
					  const char *new_name);
388
int         workbook_sheet_count         (Workbook *wb);
Arturo Espinosa's avatar
Arturo Espinosa committed
389
gboolean    workbook_can_detach_sheet    (Workbook *wb, Sheet *sheet);
Arturo Espinosa's avatar
Arturo Espinosa committed
390

Arturo Espinosa's avatar
Arturo Espinosa committed
391 392 393 394
/*
 * Does any pending recalculations
 */
void        workbook_recalc              (Workbook *wb);
395
void        workbook_recalc_all          (Workbook *wb);
Arturo Espinosa's avatar
Arturo Espinosa committed
396

397 398 399 400
/*
 * Callback routine: invoked when the first view ItemGrid
 * is realized to allocate the default styles
 */
401
void     workbook_realized            (Workbook *, GdkWindow *);
402

403 404 405 406 407
typedef gboolean (*WorkbookCallback)(Workbook *, gpointer data);

void     workbook_foreach             (WorkbookCallback cback,
				       gpointer data);

Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
408 409 410 411 412 413 414 415 416 417 418 419
/*
 * Feedback routines
 */
typedef enum {
	WORKBOOK_FEEDBACK_BOLD,
	WORKBOOK_FEEDBACK_ITALIC
} WorkbookFeedbackType;

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

420
extern   Workbook *current_workbook;
421
#endif /* GNUMERIC_SHEET_H */
Miguel de Icaza's avatar
New:  
Miguel de Icaza committed
422