Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more f*h interface file revisions

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55890 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-09-25 19:15:28 +00:00
parent cfaf8bd177
commit 0b70c946a3
8 changed files with 797 additions and 498 deletions
Download Patch File Download Diff File Expand all files Collapse all files

595
interface/wx/filename.h
View File

@@ -6,6 +6,50 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/** The various values for the path format: this mainly affects the path
separator but also whether or not the path has the drive part
(as under Windows).
See wxFileName for more info.
*/
enum wxPathFormat
{
wxPATH_NATIVE = 0, //!< the path format for the current platform.
wxPATH_UNIX,
wxPATH_BEOS = wxPATH_UNIX,
wxPATH_MAC,
wxPATH_DOS,
wxPATH_WIN = wxPATH_DOS,
wxPATH_OS2 = wxPATH_DOS,
wxPATH_VMS,
wxPATH_MAX //!< Not a valid value for specifying path format
};
/** The kind of normalization to do with the file name: these values can be
or'd together to perform several operations at once.
See wxFileName::Normalize() for more info.
*/
enum wxPathNormalize
{
wxPATH_NORM_ENV_VARS = 0x0001, //!< replace env vars with their values.
wxPATH_NORM_DOTS = 0x0002, //!< squeeze all .. and . and prepend cwd.
wxPATH_NORM_TILDE = 0x0004, //!< Unix only: replace ~ and ~user.
wxPATH_NORM_CASE = 0x0008, //!< if case insensitive => tolower.
wxPATH_NORM_ABSOLUTE = 0x0010, //!< make the path absolute.
wxPATH_NORM_LONG = 0x0020, //!< make the path the long form.
wxPATH_NORM_SHORTCUT = 0x0040, //!< resolve the shortcut, if it is a shortcut.
wxPATH_NORM_ALL = 0x00ff & ~wxPATH_NORM_CASE
};
/**
The return value of wxFileName::GetSize() in case of error.
*/
wxULongLong wxInvalidSize;
/**
@class wxFileName
@@ -26,26 +70,22 @@
MyMethod( dirname.GetPath() );
@endcode
The same can be done using the static method wxFileName::DirName:
The same can be done using the static method wxFileName::DirName():
@code
wxFileName dirname = wxFileName::DirName( "C:\mydir" );
MyMethod( dirname.GetPath() );
@endcode
Accordingly, methods dealing with directories or directory names
like wxFileName::IsDirReadable use
wxFileName::GetPath whereas methods dealing
with file names like wxFileName::IsFileReadable
use wxFileName::GetFullPath.
Accordingly, methods dealing with directories or directory names like
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 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. This will only work if the directory actually exists,
of course:
If it is not known wether 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.
This will only work if the directory actually exists, of course:
@code
wxString user_input;
@@ -58,98 +98,126 @@
fname.Assign( user_input );
@endcode
These functions allow to examine and modify the individual directories
of the path:
@li AppendDir()
@li InsertDir()
@li GetDirCount()
@li PrependDir()
@li RemoveDir()
@li RemoveLastDir()
To change the components of the file name individually you can use the
following functions:
@li GetExt()
@li GetName()
@li GetVolume()
@li HasExt()
@li HasName()
@li HasVolume()
@li SetExt()
@li ClearExt()
@li SetEmptyExt()
@li SetName()
@li SetVolume()
You can initialize a wxFileName instance using one of the following functions:
@li wxFileName()
@li Assign()
@li AssignCwd()
@li AssignDir()
@li AssignHomeDir()
@li DirName()
@li FileName()
wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS
and VMS formats (Mac OS no longer being maintained as OS X uses the Unix notation).
Although these formats are quite different, wxFileName tries to treat them all
in the same generic way. It supposes that all file names consist of the following
parts: the volume (also known as drive under Windows or device under VMS), the
path which is a sequence of directory names separated by the
@ref getpathseparators() "path separators"
and the full filename itself which, in turn, is composed from the base file name
and the extension. All of the individual components of the file name may be empty
and, for example, the volume name is always empty under Unix, but if they are all
empty simultaneously, the filename object is considered to be in an invalid
state and IsOk() returns @false for it.
File names can be case-sensitive or not, the function IsCaseSensitive() allows to
determine this. The rules for determining whether the file name is absolute or
relative also depend on the file name format and the only portable way to answer
this question is to use IsAbsolute() or IsRelative() method. Note that on Windows,
"X:" refers to the current working directory on drive X. Therefore, a wxFileName
instance constructed from for example "X:dir/file.ext" treats the portion beyond
drive separator as being relative to that directory. To ensure that the filename
is absolute, you may use MakeAbsolute(). There is also an inverse function
MakeRelativeTo() which undoes what Normalize(wxPATH_NORM_DOTS) does.
Other functions returning information about the file format provided by this
class are GetVolumeSeparator(), IsPathSeparator().
Please note that many wxFileName methods accept the path format argument
which is by @c wxPATH_NATIVE by default meaning to use the path format
native for the current platform.
The path format affects the operation of wxFileName functions in several ways:
first and foremost, it defines the path separator character to use, but it
also affects other things such as whether the path has the drive part or not.
See wxPathFormat for more info.
Before doing other tests, you should use IsOk() to verify that the filename
is well defined. If it is, FileExists() can be used to test whether a file
with such name exists and DirExists() can be used to test for directory existence.
File names should be compared using the SameAs() method or operator=(). For testing
basic access modes, you can use:
@li IsDirWritable()
@li IsDirReadable()
@li IsFileWritable()
@li IsFileReadable()
@li IsFileExecutable()
These methods allow to work with the file creation, access and modification
times. Note that not all filesystems under all platforms implement these times
in the same way. For example, the access time under Windows has a resolution of
one day (so it is really the access date and not time). The access time may be
updated when the file is executed or not depending on the platform.
@li GetModificationTime()
@li GetTimes()
@li SetTimes()
@li Touch()
Other file system operations functions are:
@li Mkdir()
@li Rmdir()
@section filename_format File name format
wxFileName currently supports the file names in the Unix, DOS/Windows,
Mac OS and VMS formats. Although these formats are quite different,
wxFileName tries to treat them all in the same generic way.
It supposes that all file names consist of the following parts: the volume
(also known as drive under Windows or device under VMS), the path which is
a sequence of directory names separated by the path separators and the full
filename itself which, in turn, is composed from the base file name and the
extension. All of the individual components of the file name may be empty
and, for example, the volume name is always empty under Unix, but if they
are all empty simultaneously, the filename object is considered to be in an
invalid state and wxFileName::IsOk() returns false for it.
File names can be case-sensitive or not, the function wxFileName::IsCaseSensitive()
allows to determine this. The rules for determining whether the file name is
absolute or relative also depend on the file name format and the only portable way
to answer this question is to use wxFileName::IsAbsolute() or wxFileName::IsRelative()
method.
Note that on Windows,"X:" refers to the current working directory on drive X.
Therefore, a wxFileName instance constructed from for example "X:dir/file.ext"
treats the portion beyond drive separator as being relative to that directory.
To ensure that the filename is absolute, you may use wxFileName::MakeAbsolute().
There is also an inverse function wxFileName::MakeRelativeTo() which undoes
what wxFileName::Normalize(wxPATH_NORM_DOTS) does.
Other functions returning information about the file format provided by this
class are wxFileName::GetVolumeSeparator(), wxFileName::IsPathSeparator().
@section filename_construction File name construction
You can initialize a wxFileName instance using one of the following functions:
@li wxFileName::wxFileName()
@li wxFileName::Assign()
@li wxFileName::AssignCwd()
@li wxFileName::AssignDir()
@li wxFileName::AssignHomeDir()
@li wxFileName::DirName()
@li wxFileName::FileName()
@li wxFileName::operator=()
@section filename_tests File name tests
Before doing other tests, you should use wxFileName::IsOk() to verify that
the filename is well defined. If it is, FileExists() can be used to test whether
a file with such name exists and wxFileName::DirExists() can be used to test
for directory existence.
File names should be compared using the wxFileName::SameAs() method or
wxFileName::operator==(). For testing basic access modes, you can use:
@li wxFileName::IsDirWritable()
@li wxFileName::IsDirReadable()
@li wxFileName::IsFileWritable()
@li wxFileName::IsFileReadable()
@li wxFileName::IsFileExecutable()
@section filename_components File name components
These functions allow to examine and modify the individual directories
of the path:
@li wxFileName::AppendDir()
@li wxFileName::InsertDir()
@li wxFileName::GetDirCount()
@li wxFileName::PrependDir()
@li wxFileName::RemoveDir()
@li wxFileName::RemoveLastDir()
To change the components of the file name individually you can use the
following functions:
@li wxFileName::GetExt()
@li wxFileName::GetName()
@li wxFileName::GetVolume()
@li wxFileName::HasExt()
@li wxFileName::HasName()
@li wxFileName::HasVolume()
@li wxFileName::SetExt()
@li wxFileName::ClearExt()
@li wxFileName::SetEmptyExt()
@li wxFileName::SetName()
@li wxFileName::SetVolume()
You can initialize a wxFileName instance using one of the following functions:
@section filename_operations File name operations
These methods allow to work with the file creation, access and modification
times. Note that not all filesystems under all platforms implement these times
in the same way. For example, the access time under Windows has a resolution of
one day (so it is really the access date and not time). The access time may be
updated when the file is executed or not depending on the platform.
@li wxFileName::GetModificationTime()
@li wxFileName::GetTimes()
@li wxFileName::SetTimes()
@li wxFileName::Touch()
Other file system operations functions are:
@li wxFileName::Mkdir()
@li wxFileName::Rmdir()
@library{wxbase}
@category{file}
@see wxFileName::GetCwd
*/
class wxFileName
{
@@ -158,26 +226,35 @@ public:
Default constructor.
*/
wxFileName();
/**
Copy constructor.
*/
wxFileName(const wxFileName& filename);
/**
Constructor from a full file name including the path.
Constructor taking a full filename.
If it terminates with a '/', a directory path is constructed
(the name will be empty), otherwise a file name and extension
are extracted from it.
*/
wxFileName(const wxString& fullpath,
wxPathFormat format = wxPATH_NATIVE);
/**
Constructor a directory name and file name.
*/
wxFileName(const wxString& path, const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
/**
Constructor from a directory name, base file name and extension.
*/
wxFileName(const wxString& path, const wxString& name,
const wxString& ext,
wxPathFormat format = wxPATH_NATIVE);
/**
Constructor from a volume name, a directory name, base file name and extension.
*/
@@ -198,11 +275,13 @@ public:
Creates the file name from another filename object.
*/
void Assign(const wxFileName& filepath);
/**
Creates the file name from a full file name with a path.
*/
void Assign(const wxString& fullpath,
wxPathFormat format = wxPATH_NATIVE);
/**
Creates the file name from volumne, path, name and extension.
*/
@@ -211,6 +290,7 @@ public:
const wxString& ext,
bool hasExt,
wxPathFormat format = wxPATH_NATIVE);
/**
Creates the file name from volumne, path, name and extension.
*/
@@ -218,11 +298,13 @@ public:
const wxString& name,
const wxString& ext,
wxPathFormat format = wxPATH_NATIVE);
/**
Creates the file name from file path and file name.
*/
void Assign(const wxString& path, const wxString& name,
wxPathFormat format = wxPATH_NATIVE);
/**
Creates the file name from path, name and extension.
*/
@@ -239,8 +321,8 @@ public:
static void AssignCwd(const wxString& volume = wxEmptyString);
/**
Sets this file name object to the given directory name. The name and extension
will be empty.
Sets this file name object to the given directory name.
The name and extension will be empty.
*/
void AssignDir(const wxString& dir,
wxPathFormat format = wxPATH_NATIVE);
@@ -251,10 +333,10 @@ public:
void AssignHomeDir();
/**
The function calls CreateTempFileName() to
create a temporary file and sets this object to the name of the file. If a
temporary file couldn't be created, the object is put into the
@ref isok() invalid state.
The function calls CreateTempFileName() to create a temporary file
and sets this object to the name of the file.
If a temporary file couldn't be created, the object is put into
an invalid state (see IsOk())
*/
void AssignTempFileName(const wxString& prefix,
wxFile* fileTemp = NULL);
@@ -273,12 +355,13 @@ public:
void ClearExt();
/**
Returns a temporary file name starting with the given @e prefix. If
the @a prefix is an absolute path, the temporary file is created in this
Returns a temporary file name starting with the given @e prefix.
If the @a prefix is an absolute path, the temporary file is created in this
directory, otherwise it is created in the default system directory for the
temporary files or in the current directory.
If the function succeeds, the temporary file is actually created. If
@a fileTemp is not @NULL, this file will be opened using the name of
If the function succeeds, the temporary file is actually created.
If @a fileTemp is not @NULL, this file will be opened using the name of
the temporary file. When possible, this is done in an atomic way ensuring that
no race condition occurs between the temporary file name generation and opening
it which could often lead to security compromise on the multiuser systems.
@@ -299,12 +382,12 @@ public:
/**
Returns @true if the directory with this name exists.
*/
bool DirExists();
bool DirExists() const;
/**
Returns @true if the directory with this name exists.
*/
const static bool DirExists(const wxString& dir);
static bool DirExists(const wxString& dir);
/**
Returns the object corresponding to the directory with the given name.
@@ -318,14 +401,14 @@ public:
@see DirExists()
*/
bool FileExists();
bool FileExists() const;
/**
Returns @true if the file with this name exists.
@see DirExists()
*/
const static bool FileExists(const wxString& file);
static bool FileExists(const wxString& file);
/**
Returns the file name object corresponding to the given @e file. This
@@ -335,16 +418,16 @@ public:
wxPathFormat format = wxPATH_NATIVE);
/**
Retrieves the value of the current working directory on the specified volume. If
the volume is empty, the program's current working directory is returned for the
current volume.
Retrieves the value of the current working directory on the specified volume.
If the volume is empty, the program's current working directory is returned for
the current volume.
@return The string containing the current working directory or an empty
string on error.
string on error.
@see AssignCwd()
*/
static wxString GetCwd(const wxString& volume = "");
static wxString GetCwd(const wxString& volume = wxEmptyString);
/**
Returns the number of directories in the file name.
@@ -354,7 +437,7 @@ public:
/**
Returns the directories in string array form.
*/
const wxArrayString GetDirs() const;
const wxArrayString& GetDirs() const;
/**
Returns the file name extension.
@@ -362,8 +445,8 @@ public:
wxString GetExt() const;
/**
Returns the characters that can't be used in filenames and directory names for
the specified format.
Returns the characters that can't be used in filenames and directory names
for the specified format.
*/
static wxString GetForbiddenChars(wxPathFormat format = wxPATH_NATIVE);
@@ -389,6 +472,7 @@ public:
/**
Returns the size of the file in a human-readable form.
If the size could not be retrieved the @c failmsg string
is returned. In case of success, the returned string is
a floating-point number with @c precision decimal digits
@@ -396,21 +480,23 @@ public:
bytes, kilobytes, megabytes, gigabytes, terabytes).
*/
wxString GetHumanReadableSize(const wxString& failmsg = "Not available",
int precision = 1);
/**
Returns the size of the given number of bytes in a human-readable form.
If @c bytes is @c wxInvalidSize or zero, then @c nullsize is returned.
In case of success, the returned string is a floating-point number with @c
precision decimal digits followed by the size unit (B, kB, MB, GB,
TB: respectively bytes, kilobytes, megabytes, gigabytes, terabytes).
*/
const static wxString GetHumanReadableSize(const wxULongLong& bytes,
const wxString& nullsize = "Not available",
int precision = 1);
int precision = 1) const;
/**
Return the long form of the path (returns identity on non-Windows platforms)
Returns the size of the given number of bytes in a human-readable form.
If @a bytes is ::wxInvalidSize or zero, then @a nullsize is returned.
In case of success, the returned string is a floating-point number with
@a precision decimal digits followed by the size unit (B, kB, MB, GB,
TB: respectively bytes, kilobytes, megabytes, gigabytes, terabytes).
*/
static wxString GetHumanReadableSize(const wxULongLong& bytes,
const wxString& nullsize = "Not available",
int precision = 1);
/**
Return the long form of the path (returns identity on non-Windows platforms).
*/
wxString GetLongPath() const;
@@ -431,18 +517,15 @@ public:
The possible flags values are:
@b wxPATH_GET_VOLUME
- @b wxPATH_GET_VOLUME
Return the path with the volume (does nothing for the filename formats
without volumes), otherwise the path without volume part is returned.
@b wxPATH_GET_SEPARATOR
- @b wxPATH_GET_SEPARATOR:
Return the path with the trailing separator, if this flag is not given
there will be no separator at the end of the path.
@b wxPATH_NO_SEPARATOR
- @b wxPATH_NO_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.
@@ -451,37 +534,39 @@ public:
wxPathFormat format = wxPATH_NATIVE) const;
/**
Returns the usually used path separator for this format. For all formats but
@c wxPATH_DOS there is only one path separator anyhow, but for DOS there
are two of them and the native one, i.e. the backslash is returned by this
method.
Returns the usually used path separator for this format.
For all formats but @c wxPATH_DOS there is only one path separator anyhow,
but for DOS there are two of them and the native one, i.e. the backslash
is returned by this method.
@see GetPathSeparators()
*/
static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE);
/**
Returns the string containing all the path separators for this format. For all
formats but @c wxPATH_DOS this string contains only one character but for
DOS and Windows both @c '/' and @c '\' may be used as
separators.
Returns the string containing all the path separators for this format.
For all formats but @c wxPATH_DOS this string contains only one character
but for DOS and Windows both @c '/' and @c '\' may be used as separators.
@see GetPathSeparator()
*/
static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
/**
Returns the string of characters which may terminate the path part. This is the
same as GetPathSeparators() except for VMS
Returns the string of characters which may terminate the path part.
This is the same as GetPathSeparators() except for VMS
path format where ] is used at the end of the path part.
*/
static wxString GetPathTerminators(wxPathFormat format = wxPATH_NATIVE);
/**
Returns the path with the trailing separator, useful for appending the name to
the given path.
This is the same as calling GetPath()
@c (wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format).
Returns the path with the trailing separator, useful for appending the name
to the given path.
This is the same as calling
@code
GetPath(wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format)
@endcode
*/
wxString GetPathWithSep(wxPathFormat format = wxPATH_NATIVE) const;
@@ -493,13 +578,14 @@ public:
/**
Returns the size of the file If the file does not exist or its size could
not be read (because e.g. the file is locked by another process) the returned
value is @c wxInvalidSize.
value is ::wxInvalidSize.
*/
wxULongLong GetSize();
/**
Returns the size of the file If the file does not exist or its size could
not be read (because e.g. the file is locked by another process) the returned
value is @c wxInvalidSize.
value is ::wxInvalidSize.
*/
const static wxULongLong GetSize(const wxString& filename);
@@ -509,20 +595,20 @@ public:
static wxString GetTempDir();
/**
Returns the last access, last modification and creation times. The last access
time is updated whenever the file is read or written (or executed in the case
of Windows), last modification time is only changed when the file is written
to. Finally, the creation time is indeed the time when the file was created
Returns the last access, last modification and creation times.
The last access time is updated whenever the file is read or written
(or executed in the case of Windows), last modification time is only
changed when the file is written to.
Finally, the creation time is indeed the time when the file was created
under Windows and the inode change time under Unix (as it is impossible to
retrieve the real file creation time there anyhow) which can also be changed
by many operations after the file creation.
If no filename or extension is specified in this instance of wxFileName
(and therefore IsDir() returns @true) then
this function will return the directory times of the path specified by
GetPath(), otherwise the file times of the
file specified by GetFullPath().
Any of the pointers may be @NULL if the corresponding time is not
needed.
(and therefore IsDir() returns @true) then this function will return the
directory times of the path specified by GetPath(), otherwise the file
times of the file specified by GetFullPath().
Any of the pointers may be @NULL if the corresponding time is not needed.
@return @true on success, @false if we failed to retrieve the times.
*/
@@ -531,8 +617,8 @@ public:
/**
Returns the string containing the volume for this file name, empty if it
doesn't have one or if the file system doesn't support volumes at all (for
example, Unix).
doesn't have one or if the file system doesn't support volumes at all
(for example, Unix).
*/
wxString GetVolume() const;
@@ -550,11 +636,11 @@ public:
@since 2.9.0
@param drive
The drive letter, 'A' through 'Z' or 'a' through 'z'.
The drive letter, 'A' through 'Z' or 'a' through 'z'.
@param flags
@c wxPATH_NO_SEPARATOR or @c wxPATH_GET_SEPARATOR to omit or include
the trailing path separator, the default is to include it.
@c wxPATH_NO_SEPARATOR or @c wxPATH_GET_SEPARATOR to omit or include
the trailing path separator, the default is to include it.
@return Volume path string.
*/
@@ -593,10 +679,10 @@ public:
/**
Returns @true if this object represents a directory, @false otherwise
(i.e. if it is a file). Note that this method doesn't test whether the
directory or file really exists, you should use
DirExists() or
FileExists() for this.
(i.e. if it is a file).
Note that this method doesn't test whether the directory or file really
exists, you should use DirExists() or FileExists() for this.
*/
bool IsDir() const;
@@ -607,7 +693,7 @@ public:
doesn't imply that you have read permissions on the files contained.
*/
bool IsDirReadable() const;
/**
Returns @true if the given @e dir is an existing directory and this process
has read permissions on it. Read permissions on a directory mean that you
@@ -623,9 +709,10 @@ public:
directory.
*/
bool IsDirWritable() const;
/**
Returns @true if the given @e dir
is an existing directory and this process has write permissions on it.
Returns @true if the given @a dir is an existing directory and this
process has write permissions on it.
Write permissions on a directory mean that you can create new files in the
directory.
*/
@@ -636,7 +723,7 @@ public:
permissions on it.
*/
bool IsFileExecutable() const;
/**
Returns @true if a file with this name exists and if this process has execute
permissions on it.
@@ -648,7 +735,7 @@ public:
permissions on it.
*/
bool IsFileReadable() const;
/**
Returns @true if a file with this name exists and if this process has read
permissions on it.
@@ -660,6 +747,7 @@ public:
permissions on it.
*/
bool IsFileWritable() const;
/**
Returns @true if a file with this name exists and if this process has write
permissions on it.
@@ -667,9 +755,8 @@ public:
static bool IsFileWritable(const wxString& file);
/**
Returns @true if the filename is valid, @false if it is not
initialized yet. The assignment functions and
Clear() may reset the object to the uninitialized,
Returns @true if the filename is valid, @false if it is not initialized yet.
The assignment functions and Clear() may reset the object to the uninitialized,
invalid state (the former only do it on failure).
*/
bool IsOk() const;
@@ -689,27 +776,30 @@ public:
On Mac OS, gets the common type and creator for the given extension.
*/
static bool MacFindDefaultTypeAndCreator(const wxString& ext,
wxUint32* type,
wxUint32* creator);
wxUint32* type,
wxUint32* creator);
/**
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.
*/
static void MacRegisterDefaultTypeAndCreator(const wxString& ext,
wxUint32 type,
wxUint32 creator);
wxUint32 type,
wxUint32 creator);
/**
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.
*/
bool MacSetDefaultTypeAndCreator();
/**
Make the file name absolute. This is a shortcut for
@c wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
wxPATH_NORM_TILDE, cwd, format).
Make the file name absolute.
This is a shortcut for
@code
wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
wxPATH_NORM_TILDE, cwd, format)
@endcode
@see MakeRelativeTo(), Normalize(), IsAbsolute()
*/
@@ -718,21 +808,18 @@ public:
/**
This function tries to put this file name in a form relative to
@a pathBase.
In other words, it returns the file name which should be used to access
this file if the current directory were pathBase.
@param pathBase.
In other words, it returns the file name which should be used to access this
file if the current directory were pathBase.
pathBase
the directory to use as root, current directory is used by
default
The directory to use as root, current directory is used by default
@param format
the file name format, native by default
The file name format, native by default
@return @true if the file name has been changed, @false if we failed to do
anything with it (currently this only happens if the
file name is on a volume different from the volume
specified by pathBase).
anything with it (currently this only happens if the file name
is on a volume different from the volume specified by @a pathBase).
@see Normalize()
*/
@@ -741,32 +828,33 @@ public:
/**
Creates a directory.
@param parm
the permissions for the newly created directory
@param perm
The permissions for the newly created directory
@param flags
if the flags contain wxPATH_MKDIR_FULL flag,
try to create each directory in the path and also don't return an error
if the target directory already exists.
If the flags contain @c wxPATH_MKDIR_FULL flag, try to create each
directory in the path and also don't return an error if the target
directory already exists.
@return Returns @true if the directory was successfully created, @false
otherwise.
otherwise.
*/
bool Mkdir(int perm = 0777, int flags = 0);
/**
Creates a directory.
@param dir
the directory to create
@param parm
the permissions for the newly created directory
@param flags
if the flags contain wxPATH_MKDIR_FULL flag,
try to create each directory in the path and also don't return an error
if the target directory already exists.
if the flags contain @c wxPATH_MKDIR_FULL flag, try to create each
directory in the path and also don't return an error if the target
directory already exists.
@return Returns @true if the directory was successfully created, @false
otherwise.
otherwise.
*/
static bool Mkdir(const wxString& dir, int perm = 0777,
int flags = 0);
@@ -778,23 +866,10 @@ public:
@param flags
The kind of normalization to do with the file name. It can be
any or-combination of the following constants:
- wxPATH_NORM_ENV_VARS: replace env vars with their values
- wxPATH_NORM_DOTS: squeeze all .. and . when possible; if
there are too many .. and thus they cannot be all removed,
@false will be returned
- wxPATH_NORM_CASE: if filesystem is case insensitive, transform
to lower case
- wxPATH_NORM_ABSOLUTE: make the path absolute prepending cwd
- wxPATH_NORM_LONG: make the path the long form
- wxPATH_NORM_SHORTCUT: resolve if it is a shortcut (Windows only)
- wxPATH_NORM_TILDE: replace ~ and ~user (Unix only)
- wxPATH_NORM_ALL: all of previous flags except wxPATH_NORM_CASE
any or-combination of the wxPathNormalize enumeration values.
@param cwd
If not empty, this directory will be used instead of current
working directory in normalization (see wxPATH_NORM_ABSOLUTE).
working directory in normalization (see @c wxPATH_NORM_ABSOLUTE).
@param format
The file name format to use when processing the paths, native by default.
@@ -804,10 +879,9 @@ public:
const wxString& cwd = wxEmptyString,
wxPathFormat format = wxPATH_NATIVE);
/**
Prepends a directory to the file path. Please see
AppendDir() for important notes.
Prepends a directory to the file path.
Please see AppendDir() for important notes.
*/
void PrependDir(const wxString& dir);
@@ -827,6 +901,7 @@ public:
Deletes the specified directory from the file system.
*/
bool Rmdir();
/**
Deletes the specified directory from the file system.
*/
@@ -842,6 +917,7 @@ public:
Changes the current working directory.
*/
bool SetCwd();
/**
Changes the current working directory.
*/
@@ -857,9 +933,10 @@ public:
void SetEmptyExt();
/**
Sets the extension of the file name. Setting an empty string
as the extension will remove the extension resulting in a file
name without a trailing dot, unlike a call to
Sets the extension of the file name.
Setting an empty string as the extension will remove the extension
resulting in a file name without a trailing dot, unlike a call to
SetEmptyExt().
@see SetEmptyExt(), ClearExt()
@@ -895,14 +972,17 @@ public:
/**
This function splits a full file name into components: the volume (with the
first version) path (including the volume in the second version), the base name
and the extension. Any of the output parameters (@e volume, @e path,
@a name or @e ext) may be @NULL if you are not interested in the
value of a particular component. Also, @a fullpath may be empty on entry.
and the extension.
Any of the output parameters (@e volume, @e path, @a name or @e ext) may
be @NULL if you are not interested in the value of a particular component.
Also, @a fullpath may be empty on entry.
On return, @a path contains the file path (without the trailing separator),
@a name contains the file name and @a ext contains the file extension
without leading dot. All three of them may be empty if the corresponding
component is. The old contents of the strings pointed to by these parameters
will be overwritten in any case (if the pointers are not @NULL).
Note that for a filename "foo." the extension is present, as indicated by the
trailing dot, but empty. If you need to cope with such cases, you should use
@a hasExt instead of relying on testing whether @a ext is empty or not.
@@ -946,31 +1026,34 @@ public:
Returns @true if the filenames are different. The string @e filenames
is interpreted as a path in the native filename format.
*/
bool operator operator!=(const wxFileName& filename) const;
bool operator!=(const wxFileName& filename) const;
/**
Returns @true if the filenames are different. The string @e filenames
is interpreted as a path in the native filename format.
*/
bool operator operator!=(const wxString& filename) const;
/**
Assigns the new value to this filename object.
*/
wxFileName& operator operator=(const wxFileName& filename);
/**
Assigns the new value to this filename object.
*/
wxFileName& operator operator=(const wxString& filename);
bool operator!=(const wxString& filename) const;
/**
Returns @true if the filenames are equal. The string @e filenames is
interpreted as a path in the native filename format.
*/
bool operator operator==(const wxFileName& filename) const;
bool operator==(const wxFileName& filename) const;
/**
Returns @true if the filenames are equal. The string @e filenames is
interpreted as a path in the native filename format.
*/
bool operator operator==(const wxString& filename) const;
bool operator==(const wxString& filename) const;
/**
Assigns the new value to this filename object.
*/
wxFileName& operator=(const wxFileName& filename);
/**
Assigns the new value to this filename object.
*/
wxFileName& operator=(const wxString& filename);
};