/**
@class wxFileName
- wxFileName encapsulates a file name. This class serves two purposes: first, it
- provides the functions to split the file names into components and to recombine
- these components in the full file name which can then be passed to the OS file
- functions (and @ref overview_filefunctions "wxWidgets functions" wrapping them).
+ wxFileName encapsulates a file name.
+
+ This class serves two purposes: first, it provides the functions to split the
+ file names into components and to recombine these components in the full file
+ name which can then be passed to the OS file functions
+ (and @ref group_funcmacro_file "wxWidgets functions" wrapping them).
Second, it includes the functions for working with the files itself. Note that
to change the file data you should use wxFile class instead.
wxFileName provides functions for working with the file attributes.
*/
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
an invalid state (see IsOk())
*/
- void AssignTempFileName(const wxString& prefix,
- wxFile* fileTemp = NULL);
+ void AssignTempFileName(const wxString& prefix, wxFile* fileTemp);
+ void AssignTempFileName(const wxString& prefix, wxFFile* fileTemp);
+ //@}
/**
Reset all components to default, uninitialized state.
not be read (because e.g. the file is locked by another process) the returned
value is ::wxInvalidSize.
*/
- wxULongLong GetSize();
+ wxULongLong GetSize() const;
/**
Returns the size of the file If the file does not exist or its size could
In other words, it returns the file name which should be used to access
this file if the current directory were pathBase.
- @param pathBase.
+ @param pathBase
The directory to use as root, current directory is used by default
@param format
The file name format, native by default
@param perm
The permissions for the newly created directory.
- See wxPosixPermissions enumeration for more info.
+ See the ::wxPosixPermissions enumeration for more info.
@param flags
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
@param dir
The directory to create
- @param parm
+ @param perm
The permissions for the newly created directory.
- See wxPosixPermissions enumeration for more info.
+ See the ::wxPosixPermissions enumeration for more info.
@param flags
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