Transfer tempName() implementation to FileName.

[lyx.git] / src / support / FileName.h

diff --git a/src/support/FileName.h b/src/support/FileName.h
index c8886a80288b6185f17f22f3a23b6880b3e103b7..dd3932a2dde336e678dc095d971cdfb6f39e6d3c 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -90,26 +90,39 @@ public:
        
        /// copy a file
        /// \return true when file/directory is writable (write test file)
-       /// \param overwrite: set to true if we should erase the \c target 
-       /// file if it exists,
-       bool copyTo(FileName const & target, bool overwrite = false) const;
+       /// \warning This methods has different semantics when system level
+       /// copy command, it will overwrite the \c target file if it exists,
+       bool copyTo(FileName const & target) const;
 
        /// remove pointed file.
-       /// \retrun true on success.
+       /// \return true on success.
        bool removeFile() const;
 
        /// rename pointed file.
-       /// \retrun true on success.
+       /// \return false if the operation fails or if the \param target file
+       /// already exists.
+       /// \return true on success.
        bool renameTo(FileName const & target) const;
 
+       /// move pointed file to \param target.
+       /// \return true on success.
+       bool moveTo(FileName const & target) const;
+
        /// change mode of pointed file.
-       /// \retrun true on success.
+       /// This methods does nothing and return true on platforms that does not
+       /// support this.
+       /// \return true on success.
        bool changePermission(unsigned long int mode) const;
 
-       /// remove directory and all contents, returns true on success
+       /// remove pointed directory and all contents.
+       /// \return true on success.
        bool destroyDirectory() const;
-       /// Creates directory. Returns true on success
+       /// Creates pointed directory.
+       /// \return true on success.
        bool createDirectory(int permissions) const;
+       /// Creates pointed path.
+       /// \return true on success.
+       bool createPath() const;
 
        /// Get the contents of a file as a huge docstring.
        /// \param encoding defines the encoding of the file contents.