always let the multiline text control process the Enter key presses

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

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 3ad1a98fa70a6dac5a78d4a5a9a099e1fd5c5673..4e5923d5d2b99c01f6d2bec32b12f847823e452b 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -38,6 +38,8 @@
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 

+class WXDLLEXPORT wxFile;
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -71,6 +73,19 @@ enum wxPathNormalize
     wxPATH_NORM_ALL      = 0x003f
 };
 
     wxPATH_NORM_ALL      = 0x003f
 };
 

+// what exactly should GetPath() return?
+enum
+{
+    wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
+    wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
+};
+
+// MkDir flags
+enum
+{
+    wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
+};
+

 // ----------------------------------------------------------------------------
 // wxFileName: encapsulates a file path
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxFileName: encapsulates a file path
 // ----------------------------------------------------------------------------


@@ -171,20 +186,20 @@ public:
 
     // time functions
 
 
     // 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)
         // (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();
 
 
         // 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,
         // (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
 
         // convenience wrapper: get just the last mod time of the file
     wxDateTime GetModificationTime() const


@@ -194,6 +209,16 @@ public:
         return dtMod;
     }
 
         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
     // various file/dir operations
 
         // retrieve the value of the current working directory


@@ -208,14 +233,17 @@ public:
     void AssignHomeDir();
     static wxString GetHomeDir();
 
     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.
 
     // directory creation and removal.
     // if full is TRUE, will try to make each directory in the path.

-    bool Mkdir( int perm = 0777, bool full = FALSE);
-    static bool Mkdir( const wxString &dir, int perm = 0777, bool full = FALSE );
+    bool Mkdir( int perm = 0777, int flags = 0);
+    static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );

 
     bool Rmdir();
     static bool Rmdir( const wxString &dir );
 
     bool Rmdir();
     static bool Rmdir( const wxString &dir );


@@ -227,7 +255,7 @@ public:
         // variables will be expanded in it
         //
         // this may be done using another (than current) value of cwd
         // 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);
 
                    const wxString& cwd = wxEmptyString,
                    wxPathFormat format = wxPATH_NATIVE);
 


@@ -254,33 +282,33 @@ public:
     bool operator==(const wxString& filename)
         { return *this == wxFileName(filename); }
 
     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?
         // are the file names of this type cases sensitive?
     static bool IsCaseSensitive( wxPathFormat format = wxPATH_NATIVE );
 
         // is this filename absolute?

-    bool IsAbsolute() const
-        { return !m_relative; }
+    bool IsAbsolute(wxPathFormat format = wxPATH_NATIVE) const;

 
         // is this filename relative?
 
         // is this filename relative?

-    bool IsRelative() const
-        { return m_relative; }
+    bool IsRelative(wxPathFormat format = wxPATH_NATIVE) const
+        { return !IsAbsolute(format); }

 
     // Information about path 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);
 
     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);
 
     // 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 );
     // Dir accessors
     void AppendDir( const wxString &dir );
     void PrependDir( const wxString &dir );


@@ -307,13 +335,11 @@ public:
 
     const wxArrayString& GetDirs() const        { return m_dirs; }
 
 
     const wxArrayString& GetDirs() const        { return m_dirs; }
 

-    // Construct path only - possibly with the trailing separator
-    wxString GetPath( bool add_separator = FALSE,
-                      wxPathFormat format = wxPATH_NATIVE ) const;
+    // flags are combination of wxPATH_GET_XXX flags
+    wxString GetPath(int flags = 0, wxPathFormat format = wxPATH_NATIVE) const;

 
 

-    // more readable synonym
-    wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
-        { return GetPath(TRUE /* add separator */, format); }
+    // Replace current path with this one
+    void SetPath( const wxString &path, wxPathFormat format = wxPATH_NATIVE );

 
     // Construct full path with name and ext
     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;
 
     // Construct full path with name and ext
     wxString GetFullPath( wxPathFormat format = wxPATH_NATIVE ) const;


@@ -324,6 +350,9 @@ public:
     // Return the long form of the path (returns identity on non-Windows platforms)
     wxString GetLongPath() const;
 
     // 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
     // various helpers
 
         // get the canonical path format for this platform


@@ -345,6 +374,16 @@ public:
                           wxString *ext,
                           wxPathFormat format = wxPATH_NATIVE);
 
                           wxString *ext,
                           wxPathFormat format = wxPATH_NATIVE);
 

+
+    // deprecated methods, don't use any more
+    // --------------------------------------
+
+    wxString GetPath( bool withSep, wxPathFormat format = wxPATH_NATIVE ) const
+        { return GetPath(withSep ? wxPATH_GET_SEPARATOR : 0, format); }
+
+    wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE ) const
+        { return GetPath(wxPATH_GET_SEPARATOR, format); }
+

 private:
     // the drive/volume/device specification (always empty for Unix)
     wxString        m_volume;
 private:
     // the drive/volume/device specification (always empty for Unix)
     wxString        m_volume;


@@ -355,8 +394,15 @@ private:
     // the file name and extension (empty for directories)
     wxString        m_name,
                     m_ext;
     // the file name and extension (empty for directories)
     wxString        m_name,
                     m_ext;

-                    
-    // is the path relative
+
+    // 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;
 };
 
     bool            m_relative;
 };