src/file.h

   1 #ifndef __SP_FILE_H__
   2 #define __SP_FILE_H__
   3
   4 /*
   5  * File/Print operations
   6  *
   7  * Authors:
   8  *   Lauris Kaplinski <lauris@kaplinski.com>
   9  *   Chema Celorio <chema@celorio.com>
  10  *
  11  * Copyright (C) 2006 Johan Engelen <johan@shouraizou.nl>
  12  * Copyright (C) 2001-2002 Ximian, Inc.
  13  * Copyright (C) 1999-2002 Authors
  14  *
  15  * Released under GNU GPL, read the file 'COPYING' for more information
  16  */
  17
  18 #include <gtkmm.h>
  19 #include <glib/gslist.h>
  20 #include <gtk/gtkwidget.h>
  21
  22 #include "extension/extension-forward.h"
  23
  24 struct SPDesktop;
  25 struct SPDocument;
  26
  27 namespace Inkscape {
  28     namespace Extension {
  29         struct Extension;
  30     }
  31 }
  32
  33 /*######################
  34 ## N E W
  35 ######################*/
  36
  37 /**
  38  * Creates a new Inkscape document and window.
  39  * Return value is a pointer to the newly created desktop.
  40  */
  41 SPDesktop* sp_file_new (const Glib::ustring &templ);
  42 SPDesktop* sp_file_new_default (void);
  43
  44 /*######################
  45 ## D E L E T E
  46 ######################*/
  47
  48 /**
  49  * Close the document/view
  50  */
  51 void sp_file_exit (void);
  52
  53 /*######################
  54 ## O P E N
  55 ######################*/
  56
  57 /**
  58  * Opens a new file and window from the given URI
  59  */
  60 bool sp_file_open(
  61     const Glib::ustring &uri,
  62     Inkscape::Extension::Extension *key,
  63     bool add_to_recent = true,
  64     bool replace_empty = true
  65     );
  66
  67 /**
  68  * Displays a file open dialog. Calls sp_file_open on
  69  * an OK.
  70  */
  71 void sp_file_open_dialog (Gtk::Window &parentWindow, gpointer object, gpointer data);
  72
  73 /**
  74  * Reverts file to disk-copy on "YES"
  75  */
  76 void sp_file_revert_dialog ();
  77
  78 /*######################
  79 ## S A V E
  80 ######################*/
  81
  82 /*
  83  * Added to make only the local savings.
  84  */
  85
  86 bool file_save_local(Gtk::Window &parentWindow, SPDocument *doc, const Glib::ustring &uri,
  87                 Inkscape::Extension::Extension *key, bool saveas, bool official);
  88
  89
  90 /*
  91  * Added to make only the remote savings.
  92  */
  93
  94 bool file_save_remote(SPDocument *doc, const Glib::ustring &uri,
  95                  Inkscape::Extension::Extension *key, bool saveas, bool official);
  96
  97
  98
  99 /**
 100  *
 101  */
 102 bool sp_file_save (Gtk::Window &parentWindow, gpointer object, gpointer data);
 103
 104 /**
 105  *  Saves the given document.  Displays a file select dialog
 106  *  to choose the new name.
 107  */
 108 bool sp_file_save_as (Gtk::Window &parentWindow, gpointer object, gpointer data);
 109
 110 /**
 111  *  Saves a copy of the given document.  Displays a file select dialog
 112  *  to choose a name for the copy.
 113  */
 114 bool sp_file_save_a_copy (Gtk::Window &parentWindow, gpointer object, gpointer data);
 115
 116
 117 /**
 118  *  Saves the given document.  Displays a file select dialog
 119  *  if needed.
 120  */
 121 bool sp_file_save_document (Gtk::Window &parentWindow, SPDocument *document);
 122
 123 /* Do the saveas dialog with a document as the parameter */
 124 bool sp_file_save_dialog (Gtk::Window &parentWindow, SPDocument *doc, bool bAsCopy = FALSE);
 125
 126
 127 /*######################
 128 ## I M P O R T
 129 ######################*/
 130
 131 /**
 132  * Displays a file selector dialog, to allow the
 133  * user to import data into the current document.
 134  */
 135 void sp_file_import (Gtk::Window &parentWindow);
 136
 137 /**
 138  * Imports a resource
 139  */
 140 void file_import(SPDocument *in_doc, const Glib::ustring &uri,
 141                  Inkscape::Extension::Extension *key);
 142
 143 /*######################
 144 ## E X P O R T
 145 ######################*/
 146
 147 /**
 148  * Displays a FileExportDialog for the user, with an
 149  * additional type selection, to allow the user to export
 150  * the a document as a given type.
 151  */
 152 bool sp_file_export_dialog (void *widget);
 153
 154
 155 /*######################
 156 ## E X P O R T  T O  O C A L
 157 ######################*/
 158
 159 /**
 160  * Export the current document to OCAL
 161  */
 162 void sp_file_export_to_ocal (Gtk::Window &parentWindow );
 163
 164
 165 /**
 166  * Export the current document to OCAL
 167  */
 168 bool sp_file_export_to_ocal_dialog (void *widget);
 169
 170
 171
 172 /*######################
 173 ## P R I N T
 174 ######################*/
 175
 176 /* These functions are redundant now, but
 177 would be useful as instance methods
 178 */
 179
 180 /**
 181  *
 182  */
 183 void sp_file_print (void);
 184
 185 /**
 186  *
 187  */
 188 void sp_file_print_direct (void);
 189
 190 /**
 191  *
 192  */
 193 void sp_file_print_preview (gpointer object, gpointer data);
 194
 195 /*#####################
 196 ## U T I L I T Y
 197 #####################*/
 198
 199 /**
 200  * clean unused defs out of file
 201  */
 202 void sp_file_vacuum ();
 203
 204
 205 namespace Inkscape {
 206 namespace IO {
 207
 208 void fixupHrefs( SPDocument *doc, const gchar *uri, gboolean spns );
 209
 210 }
 211 }
 212
 213
 214 #endif