Code

Node tool: special case node duplication for endnodes - select new endnode
[inkscape.git] / src / extension / system.h
index 6c23b2f0dde073affcd553e0ff816a4df729ba08..b6740e10978900ffcf9eb02a15c17cf2281f24d9 100644 (file)
 namespace Inkscape {
 namespace Extension {
 
+/**
+ * Used to distinguish between the various invocations of the save dialogs (and thus to determine
+ * the file type and save path offered in the dialog)
+ */
+enum FileSaveMethod {
+    FILE_SAVE_METHOD_SAVE_AS,
+    FILE_SAVE_METHOD_SAVE_COPY,
+    FILE_SAVE_METHOD_EXPORT,
+    // Fallback for special cases (e.g., when saving a document for the first time or after saving
+    // it in a lossy format)
+    FILE_SAVE_METHOD_INKSCAPE_SVG,
+    // For saving temporary files; we return the same data as for FILE_SAVE_METHOD_SAVE_AS
+    FILE_SAVE_METHOD_TEMPORARY,
+};
+
 SPDocument *open(Extension *key, gchar const *filename);
 void save(Extension *key, SPDocument *doc, gchar const *filename,
-          bool setextension, bool check_overwrite, bool official);
+          bool setextension, bool check_overwrite, bool official,
+          Inkscape::Extension::FileSaveMethod save_method);
 Print *get_print(gchar const *key);
 Extension *build_from_file(gchar const *filename);
 Extension *build_from_mem(gchar const *buffer, Implementation::Implementation *in_imp);
 
+/**
+ * Determine the desired default file extension depending on the given file save method.
+ * The returned string is guaranteed to be non-empty.
+ *
+ * @param method the file save method of the dialog
+ * @return the corresponding default file extension
+ */
+Glib::ustring get_file_save_extension (FileSaveMethod method);
+
+/**
+ * Determine the desired default save path depending on the given FileSaveMethod.
+ * The returned string is guaranteed to be non-empty.
+ *
+ * @param method the file save method of the dialog
+ * @param doc the file's document
+ * @return the corresponding default save path
+ */
+Glib::ustring get_file_save_path (SPDocument *doc, FileSaveMethod method);
+
+/**
+ * Write the given file extension back to prefs so that it can be used later on.
+ *
+ * @param extension the file extension which should be written to prefs
+ * @param method the file save mathod of the dialog
+ */
+void store_file_extension_in_prefs (Glib::ustring extension, FileSaveMethod method);
+
+/**
+ * Write the given path back to prefs so that it can be used later on.
+ *
+ * @param path the path which should be written to prefs
+ * @param method the file save mathod of the dialog
+ */
+void store_save_path_in_prefs (Glib::ustring path, FileSaveMethod method);
+
 } } /* namespace Inkscape::Extension */
 
 #endif /* INKSCAPE_EXTENSION_SYSTEM_H__ */