]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/filename.h
fixed typo
[wxWidgets.git] / include / wx / filename.h
index 0b8bec879f3aaa71429e790fb3877b5df1f2974a..9768a8739530c7d3fb219baa2f58ecfaac583acb 100644 (file)
@@ -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,
@@ -163,20 +173,20 @@ public:
 
     // time functions
 
-        // set the file creation and last access/mod times
+        // set the file last access/mod and creation times
         // (any of the pointers may be NULL)
-    bool SetTimes(const wxDateTime *dtCreate,
-                  const wxDateTime *dtAccess,
-                  const wxDateTime *dtMod);
+    bool SetTimes(const wxDateTime *dtAccess,
+                  const wxDateTime *dtMod,
+                  const wxDateTime *dtCreate);
 
         // set the access and modification times to the current moment
     bool Touch();
 
-        // return the last access, last modification and last change times
+        // return the last access, last modification and create times
         // (any of the pointers may be NULL)
     bool GetTimes(wxDateTime *dtAccess,
                   wxDateTime *dtMod,
-                  wxDateTime *dtChange) const;
+                  wxDateTime *dtCreate) const;
 
         // convenience wrapper: get just the last mod time of the file
     wxDateTime GetModificationTime() const
@@ -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,32 +269,33 @@ 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(wxPathFormat format = wxPATH_NATIVE) const;
 
         // is this filename relative?
-    bool IsRelative( wxPathFormat format = wxPATH_NATIVE )
+    bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
         { return !IsAbsolute(format); }
 
     // Information about path format
 
-    // get the string separating the volume from the path for this format
+    // get the string separating the volume from the path for this format,
+    // return an empty string if this format doesn't support the notion of
+    // volumes at all
     static wxString GetVolumeSeparator(wxPathFormat format = wxPATH_NATIVE);
 
     // get the string of path separators for this format
     static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
 
+    // get the canonical path separator for this format
+    static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE)
+        { return GetPathSeparators(format)[0u]; }
+
     // is the char a path separator for this format?
     static bool IsPathSeparator(wxChar ch, wxPathFormat format = wxPATH_NATIVE);
 
-    // FIXME: what exactly does this do?
-    bool IsWild( wxPathFormat format = wxPATH_NATIVE );
-
     // Dir accessors
     void AppendDir( const wxString &dir );
     void PrependDir( const wxString &dir );
@@ -289,6 +325,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
@@ -303,6 +341,9 @@ public:
     // Return the long form of the path (returns identity on non-Windows platforms)
     wxString GetLongPath() const;
 
+    // Is this a file or directory (not necessarily an existing one)
+    bool IsDir() const { return m_name.empty() && m_ext.empty(); }
+
     // various helpers
 
         // get the canonical path format for this platform
@@ -334,6 +375,16 @@ private:
     // the file name and extension (empty for directories)
     wxString        m_name,
                     m_ext;
+
+    // when m_dirs is empty it may mean either that we have no path at all or
+    // that our path is '/', i.e. the root directory
+    //
+    // we use m_relative to distinguish between these two cases, it will be
+    // TRUE in the former and FALSE in the latter
+    //
+    // NB: the path is not absolute just because m_relative is FALSE, it still
+    //     needs the drive (i.e. volume) in some formats (Windows)
+    bool            m_relative;
 };
 
 #endif // _WX_FILENAME_H_