synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/filename.h b/interface/wx/filename.h
index 0e78b2d38fa7933ff004c1ce0e0b8061afbb0311..8854f1f062ad0a4c4650042c816c007b38bb0534 100644 (file)
--- a/interface/wx/filename.h
+++ b/interface/wx/filename.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxFileName
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxFileName
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -129,7 +129,7 @@ wxULongLong wxInvalidSize;
     wxFileName::IsDirReadable() use wxFileName::GetPath() whereas methods dealing
     with file names like wxFileName::IsFileReadable() use wxFileName::GetFullPath().
 
     wxFileName::IsDirReadable() use wxFileName::GetPath() whereas methods dealing
     with file names like wxFileName::IsFileReadable() use wxFileName::GetFullPath().
 

-    If it is not known wether a string contains a directory name or a complete
+    If it is not known whether a string contains a directory name or a complete

     file name (such as when interpreting user input) you need to use the static
     function wxFileName::DirExists() (or its identical variants wxDir::Exists() and
     wxDirExists()) and construct the wxFileName instance accordingly.
     file name (such as when interpreting user input) you need to use the static
     function wxFileName::DirExists() (or its identical variants wxDir::Exists() and
     wxDirExists()) and construct the wxFileName instance accordingly.


@@ -332,7 +332,7 @@ public:
                 wxPathFormat format = wxPATH_NATIVE);
 
     /**
                 wxPathFormat format = wxPATH_NATIVE);
 
     /**

-        Creates the file name from volumne, path, name and extension.
+        Creates the file name from volume, path, name and extension.

     */
     void Assign(const wxString& volume, const wxString& path,
                 const wxString& name,
     */
     void Assign(const wxString& volume, const wxString& path,
                 const wxString& name,


@@ -341,7 +341,7 @@ public:
                 wxPathFormat format = wxPATH_NATIVE);
 
     /**
                 wxPathFormat format = wxPATH_NATIVE);
 
     /**

-        Creates the file name from volumne, path, name and extension.
+        Creates the file name from volume, path, name and extension.

     */
     void Assign(const wxString& volume, const wxString& path,
                 const wxString& name,
     */
     void Assign(const wxString& volume, const wxString& path,
                 const wxString& name,


@@ -452,11 +452,19 @@ public:
 
     /**
         Returns @true if the directory with this name exists.
 
     /**
         Returns @true if the directory with this name exists.

+
+        Notice that this function tests the directory part of this object,
+        i.e. the string returned by GetPath(), and not the full path returned
+        by GetFullPath().
+
+        @see FileExists(), Exists()

     */
     bool DirExists() const;
 
     /**
     */
     bool DirExists() const;
 
     /**

-        Returns @true if the directory with this name exists.
+        Returns @true if the directory with name @a dir exists.
+
+        @see FileExists(), Exists()

     */
     static bool DirExists(const wxString& dir);
 
     */
     static bool DirExists(const wxString& dir);
 


@@ -467,17 +475,40 @@ public:
     static wxFileName DirName(const wxString& dir,
                               wxPathFormat format = wxPATH_NATIVE);
 
     static wxFileName DirName(const wxString& dir,
                               wxPathFormat format = wxPATH_NATIVE);
 

+    /**
+        Calls the static overload of this function with the full path of this
+        object.
+
+        @since 2.9.4
+     */
+    bool Exists() const;
+
+    /**
+        Returns @true if either a file or a directory or something else with
+        this name exists in the file system.
+
+        This method is equivalent to @code FileExists() || DirExists() @endcode
+        under most systems but under Unix it also returns true if the file
+        identifies a special file system object such as a device, a socket or a
+        FIFO.
+
+        @since 2.9.4
+
+        @see FileExists(), DirExists()
+     */
+    static bool Exists(const wxString& path);
+

     /**
         Returns @true if the file with this name exists.
 
     /**
         Returns @true if the file with this name exists.
 

-        @see DirExists()
+        @see DirExists(), Exists()

     */
     bool FileExists() const;
 
     /**
     */
     bool FileExists() const;
 
     /**

-        Returns @true if the file with this name exists.
+        Returns @true if the file with name @a file exists.

 
 

-        @see DirExists()
+        @see DirExists(), Exists()

     */
     static bool FileExists(const wxString& file);
 
     */
     static bool FileExists(const wxString& file);
 


@@ -557,8 +588,8 @@ public:
         units for multiples of 1024 is used, i.e. returned string will use
         suffixes of B, KB, MB, GB, TB for bytes, kilobytes, megabytes,
         gigabytes and terabytes respectively. With the IEC convention the names
         units for multiples of 1024 is used, i.e. returned string will use
         suffixes of B, KB, MB, GB, TB for bytes, kilobytes, megabytes,
         gigabytes and terabytes respectively. With the IEC convention the names

-        of the units are changed to B, KiB, MiB, GiB and TiB fofr bytes,
-        kibibytes, mebibyes, gibibytes and tebibytes. Finally, with SI
+        of the units are changed to B, KiB, MiB, GiB and TiB for bytes,
+        kibibytes, mebibytes, gibibytes and tebibytes. Finally, with SI

         convention the same B, KB, MB, GB and TB suffixes are used but in their
         correct SI meaning, i.e. as multiples of 1000 and not 1024.
 
         convention the same B, KB, MB, GB and TB suffixes are used but in their
         correct SI meaning, i.e. as multiples of 1000 and not 1024.
 


@@ -611,6 +642,10 @@ public:
         Don't include the trailing separator in the returned string. This is
         the default (the value of this flag is 0) and exists only for symmetry
         with wxPATH_GET_SEPARATOR.
         Don't include the trailing separator in the returned string. This is
         the default (the value of this flag is 0) and exists only for symmetry
         with wxPATH_GET_SEPARATOR.

+
+        @note If the path is a toplevel one (e.g. @c "/" on Unix or @c "C:\" on
+              Windows), then the returned path will contain trailing separator
+              even with @c wxPATH_NO_SEPARATOR.

     */
     wxString GetPath(int flags = wxPATH_GET_VOLUME,
                      wxPathFormat format = wxPATH_NATIVE) const;
     */
     wxString GetPath(int flags = wxPATH_GET_VOLUME,
                      wxPathFormat format = wxPATH_NATIVE) const;


@@ -874,6 +909,8 @@ public:
 
     /**
         On Mac OS, gets the common type and creator for the given extension.
 
     /**
         On Mac OS, gets the common type and creator for the given extension.

+
+        @onlyfor{wxosx}

     */
     static bool MacFindDefaultTypeAndCreator(const wxString& ext,
                                             wxUint32* type,
     */
     static bool MacFindDefaultTypeAndCreator(const wxString& ext,
                                             wxUint32* type,


@@ -882,6 +919,8 @@ public:
     /**
         On Mac OS, registers application defined extensions and their default type
         and creator.
     /**
         On Mac OS, registers application defined extensions and their default type
         and creator.

+
+        @onlyfor{wxosx}

     */
     static void MacRegisterDefaultTypeAndCreator(const wxString& ext,
                                                 wxUint32 type,
     */
     static void MacRegisterDefaultTypeAndCreator(const wxString& ext,
                                                 wxUint32 type,


@@ -890,6 +929,8 @@ public:
     /**
         On Mac OS, looks up the appropriate type and creator from the registration
         and then sets it.
     /**
         On Mac OS, looks up the appropriate type and creator from the registration
         and then sets it.

+
+        @onlyfor{wxosx}

     */
     bool MacSetDefaultTypeAndCreator();
 
     */
     bool MacSetDefaultTypeAndCreator();
 


@@ -962,9 +1003,16 @@ public:
                       int flags = 0);
 
     /**
                       int flags = 0);
 
     /**

-        Normalize the path. With the default flags value, the path will be
-        made absolute, without any ".." and "." and all environment
-        variables will be expanded in it.
+        Normalize the path.
+
+        With the default flags value, the path will be made absolute, without
+        any ".." and "." and all environment variables will be expanded in it.
+
+        Notice that in some rare cases normalizing a valid path may result in
+        an invalid wxFileName object. E.g. normalizing "./" path using
+        wxPATH_NORM_DOTS but not wxPATH_NORM_ABSOLUTE will result in a
+        completely empty and thus invalid object. As long as there is a non
+        empty file name the result of normalization will be valid however.

 
         @param flags
             The kind of normalization to do with the file name. It can be
 
         @param flags
             The kind of normalization to do with the file name. It can be


@@ -1123,10 +1171,14 @@ public:
     void SetName(const wxString& name);
 
     /**
     void SetName(const wxString& name);
 
     /**

-        Sets the full path.
+        Sets the path.
+
+        The @a path argument includes both the path and the volume, if
+        supported by @a format.

 
 

-        The @a path argument includes both the path (and the volume, if
-        supported by @a format) and the name and extension.
+        Calling this function doesn't affect the name and extension components,
+        to change them as well you can use Assign() or just an assignment
+        operator.

 
         @see GetPath()
      */
 
         @see GetPath()
      */