X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/906c935a80b10d53cecf57f71ab5f3f4f1d529ec..cb8ae61385f1c65552585cb55d8f7bd9f1f690b4:/interface/wx/filename.h diff --git a/interface/wx/filename.h b/interface/wx/filename.h index 7bbd0cd527..8854f1f062 100644 --- a/interface/wx/filename.h +++ b/interface/wx/filename.h @@ -452,11 +452,19 @@ public: /** 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; /** Returns @true if the directory with name @a dir exists. + + @see FileExists(), Exists() */ static bool DirExists(const wxString& dir); @@ -467,17 +475,40 @@ public: 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. - @see DirExists() + @see DirExists(), Exists() */ bool FileExists() const; /** Returns @true if the file with name @a file exists. - @see DirExists() + @see DirExists(), Exists() */ static bool FileExists(const wxString& file); @@ -878,6 +909,8 @@ public: /** On Mac OS, gets the common type and creator for the given extension. + + @onlyfor{wxosx} */ static bool MacFindDefaultTypeAndCreator(const wxString& ext, wxUint32* type, @@ -886,6 +919,8 @@ public: /** On Mac OS, registers application defined extensions and their default type and creator. + + @onlyfor{wxosx} */ static void MacRegisterDefaultTypeAndCreator(const wxString& ext, wxUint32 type, @@ -894,6 +929,8 @@ public: /** On Mac OS, looks up the appropriate type and creator from the registration and then sets it. + + @onlyfor{wxosx} */ bool MacSetDefaultTypeAndCreator(); @@ -1134,10 +1171,14 @@ public: 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() */