Restrict button size restrictions documentation to OSX/Carbon only.

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

diff --git a/interface/wx/filename.h b/interface/wx/filename.h
index c491cc4cb95b5c6c5e272b6a8eed09100d110217..e6c8fa5fea5f796937770560240d97cda37a5d04 100644 (file)
--- a/interface/wx/filename.h
+++ b/interface/wx/filename.h
@@ -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,


@@ -557,8 +557,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 +611,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;


@@ -1130,10 +1134,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()
      */