]> git.lyx.org Git - lyx.git/blobdiff - src/exporter.h
Rewording in GTK document dialog
[lyx.git] / src / exporter.h
index 0cdbd4e96e4801f21d78d4b5d804851a2717ac0d..9bd2d038aca805b2b610a5de3e09617c75e1c80b 100644 (file)
@@ -45,7 +45,8 @@ public:
 };
 
 
-struct ExportedFile {
+class ExportedFile {
+public:
        ExportedFile(std::string const &, std::string const &);
        /// absolute name of the source file
        std::string sourceName;
@@ -66,15 +67,24 @@ public:
         *  with this method.
         *  Then the exporter mechanism copies them to the right place, asks
         *  for confirmation before overwriting existing files etc.
+        * \param format     format that references the given file
+        * \param sourceName source file name. Needs to be absolute
+        * \param exportName resulting file name. Can be either absolute
+        *                   or relative to the exported document.
+        */
+       void addExternalFile(std::string const & format,
+                            std::string const & sourceName,
+                            std::string const & exportName);
+       /** add a referenced file for one format.
+        *  The final name is the source file name without path.
+        * \param format     format that references the given file
+        * \param sourceName source file name. Needs to be absolute
         */
-       void addExternalFile(std::string const &, std::string const &,
-                            std::string const &);
-       /// add a referenced file for one format.
-       /// The final name is the source file name without path
-       void addExternalFile(std::string const &, std::string const &);
-       /// get referenced files for one format
+       void addExternalFile(std::string const & format,
+                            std::string const & sourceName);
+       /// get referenced files for \p format
        std::vector<ExportedFile> const
-       externalFiles(std::string const &) const;
+       externalFiles(std::string const & format) const;
 private:
        typedef std::map<std::string, std::vector<ExportedFile> > FileMap;
        /** Files that are referenced by the export result in the