lib/sheet.h

   1 /* Dia -- an diagram creation/manipulation program
   2  * Copyright (C) 1998 Alexander Larsson
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18 #ifndef SHEET_H
  19 #define SHEET_H
  20
  21 #include <glib.h>
  22
  23 #include "diatypes.h"
  24
  25 struct _SheetObject {
  26   char *object_type;
  27   char *description;
  28   char **pixmap; /* in xpm format */
  29
  30   void *user_data;
  31   enum { USER_DATA_IS_INTDATA, USER_DATA_IS_OTHER } user_data_type;
  32
  33   gboolean line_break;
  34
  35   char *pixmap_file; /* fallback if pixmap is NULL */
  36   gboolean has_icon_on_sheet;
  37 };
  38
  39 typedef enum
  40 {
  41   SHEET_SCOPE_SYSTEM,
  42   SHEET_SCOPE_USER
  43 }
  44 SheetScope;
  45
  46 struct _Sheet {
  47   char *name;
  48   char *description;
  49   char *filename;
  50
  51   SheetScope scope;
  52   Sheet *shadowing;           /* If (scope == USER), the system sheet that this
  53                                  user sheet is shadowing.
  54                                  If (scope == SYSTEM), there has been a name
  55                                  collision between a system sheet and a user
  56                                  sheet and the system sheet appears to be more
  57                                  recent than the user sheet.
  58                                  Can be NULL. */
  59
  60   GSList *objects; /* list of SheetObject */
  61 };
  62
  63 Sheet *new_sheet(char *name, char *description, char *filename,
  64                  SheetScope scope, Sheet *shadowing);
  65 void sheet_prepend_sheet_obj(Sheet *sheet, SheetObject *type);
  66 void sheet_append_sheet_obj(Sheet *sheet, SheetObject *type);
  67 void register_sheet(Sheet *sheet);
  68 GSList *get_sheets_list(void);
  69
  70 void load_all_sheets(void);
  71 void dia_sort_sheets(void);
  72
  73 #endif /* SHEET_H */