wxITEM_FOO instead of wxItem_Foo, for the sake of consistency

[wxWidgets.git] / include / wx / filename.h

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 0b8bec879f3aaa71429e790fb3877b5df1f2974a..ceb0fc820e14b775b4bc072e3e9b59d3e39788c4 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -38,6 +38,8 @@
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 
+class WXDLLEXPORT wxFile;
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
@@ -96,6 +98,14 @@ public:
                wxPathFormat format = wxPATH_NATIVE)
         { Assign(path, name, format); }
 
+        // from a volume, directory name, file base name and extension
+    wxFileName(const wxString& volume,
+               const wxString& path,
+               const wxString& name,
+               const wxString& ext,
+               wxPathFormat format = wxPATH_NATIVE)
+        { Assign(volume, path, name, ext, format); }
+
         // from a directory name, file base name and extension
     wxFileName(const wxString& path,
                const wxString& name,
@@ -186,6 +196,16 @@ public:
         return dtMod;
     }
 
+#ifdef __WXMAC__
+    bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
+    bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
+    // gets the 'common' type and creator for a certain extension
+    static bool MacFindDefaultTypeAndCreator( const wxString& ext , wxUint32 *type , wxUint32 *creator ) ;
+    // registers application defined extensions and their default type and creator
+    static void MacRegisterDefaultTypeAndCreator( const wxString& ext , wxUint32 type , wxUint32 creator ) ;
+    // looks up the appropriate type and creator from the registration and then sets
+    bool MacSetDefaultTypeAndCreator() ;
+#endif
     // various file/dir operations
 
         // retrieve the value of the current working directory
@@ -200,9 +220,12 @@ public:
     void AssignHomeDir();
     static wxString GetHomeDir();
 
-        // get a temp file name starting with the specified prefix
-    void AssignTempFileName(const wxString& prefix);
-    static wxString CreateTempFileName(const wxString& prefix);
+        // get a temp file name starting with the specified prefix and open the
+        // file passed to us using this name for writing (atomically if
+        // possible)
+    void AssignTempFileName(const wxString& prefix, wxFile *fileTemp = NULL);
+    static wxString CreateTempFileName(const wxString& prefix,
+                                       wxFile *fileTemp = NULL);
 
     // directory creation and removal.
     // if full is TRUE, will try to make each directory in the path.
@@ -219,10 +242,22 @@ public:
         // variables will be expanded in it
         //
         // this may be done using another (than current) value of cwd
-    bool Normalize(wxPathNormalize flags = wxPATH_NORM_ALL,
+    bool Normalize(int flags = wxPATH_NORM_ALL,
                    const wxString& cwd = wxEmptyString,
                    wxPathFormat format = wxPATH_NATIVE);
 
+        // get a path path relative to the given base directory, i.e. opposite
+        // of Normalize
+        //
+        // pass an empty string to get a path relative to the working directory
+        //
+        // returns TRUE if the file name was modified, FALSE if we failed to do
+        // anything with it (happens when the file is on a different volume,
+        // for example)
+    bool MakeRelativeTo(const wxString& pathBase = _T(""),
+                        wxPathFormat format = wxPATH_NATIVE);
+
+
     // Comparison
 
         // compares with the rules of this platform
@@ -234,17 +269,22 @@ public:
     bool operator==(const wxString& filename)
         { return *this == wxFileName(filename); }
 
-    // Tests
-
         // are the file names of this type cases sensitive?
     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
 
         // is this filename absolute?
-    bool IsAbsolute( wxPathFormat format = wxPATH_NATIVE );
+    bool IsAbsolute() const
+        { return !m_relative; }
 
         // is this filename relative?
-    bool IsRelative( wxPathFormat format = wxPATH_NATIVE )
-        { return !IsAbsolute(format); }
+    bool IsRelative() const
+        { return m_relative; }
+        
+        // forcibly set the flag
+    void SetAbsolute()
+        { m_relative = FALSE; }
+    void SetRelative()
+        { m_relative = TRUE; }
 
     // Information about path format
 
@@ -289,6 +329,8 @@ public:
     // Construct path only - possibly with the trailing separator
     wxString GetPath( bool add_separator = FALSE,
                       wxPathFormat format = wxPATH_NATIVE ) const;
+    // Replace current path with this one
+    void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );
 
     // more readable synonym
     wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
@@ -334,6 +376,9 @@ private:
     // the file name and extension (empty for directories)
     wxString        m_name,
                     m_ext;
+                    
+    // is the path relative
+    bool            m_relative;
 };
 
 #endif // _WX_FILENAME_H_