X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fexporter.h;h=ec1c9d6495fdbae61cce1e21eee08f82de6a42e8;hb=7aa50e8f2bc942e4bb3d7a45e62fdfbe6a21654e;hp=0cdbd4e96e4801f21d78d4b5d804851a2717ac0d;hpb=fa29d7ee984e9240554f093862fe53239f776582;p=lyx.git

diff --git a/src/exporter.h b/src/exporter.h
index 0cdbd4e96e..ec1c9d6495 100644
--- a/src/exporter.h
+++ b/src/exporter.h
@@ -18,6 +18,9 @@
 #include <vector>
 
 
+namespace lyx {
+
+
 class Buffer;
 class Format;
 
@@ -33,19 +36,20 @@ public:
 		    bool put_in_tempdir);
 	///
 	static
-	bool Preview(Buffer * buffer, std::string const & format);
+	bool preview(Buffer * buffer, std::string const & format);
 	///
 	static
-	bool IsExportable(Buffer const & buffer, std::string const & format);
+	bool isExportable(Buffer const & buffer, std::string const & format);
 	///
 	static
 	std::vector<Format const *> const
-	GetExportableFormats(Buffer const & buffer, bool only_viewable);
+	getExportableFormats(Buffer const & buffer, bool only_viewable);
 	///
 };
 
 
-struct ExportedFile {
+class ExportedFile {
+public:
 	ExportedFile(std::string const &, std::string const &);
 	/// absolute name of the source file
 	std::string sourceName;
@@ -66,15 +70,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 &, 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,
+			     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 & 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
@@ -83,4 +96,7 @@ private:
 	FileMap externalfiles;
 };
 
+
+} // namespace lyx
+
 #endif