wxFileName

Methods

• wxFileName
  Copy constructor.
• AppendDir
  Appends a directory component to the path.
• Assign
  Creates the file name from another filename object.
• AssignCwd
  Makes this object refer to the current working directory on the specified volume (or current volume if volume is empty).
• AssignDir
  Sets this file name object to the given directory name.
• AssignHomeDir
  Sets this file name object to the home directory.
• AssignTempFileName
  The function calls CreateTempFileName() to create a temporary file and sets this object to the name of the file.
• Clear
  Reset all components to default, uninitialized state.
• ClearExt
  Removes the extension from the file name resulting in a file name with no trailing dot.
• DirExists
  Returns true if the directory with this name exists.
• FileExists
  Returns true if the file with this name exists.
• GetDirCount
  Returns the number of directories in the file name.
• GetDirs
  Returns the directories in string array form.
• GetExt
  Returns the file name extension.
• GetFullName
  Returns the full name (including extension but excluding directories).
• GetFullPath
  Returns the full path with name and extension.
• GetHumanReadableSize
  Returns the representation of the file size in a human-readable form.
• GetLongPath
  Return the long form of the path (returns identity on non-Windows platforms).
• GetModificationTime
  Returns the last time the file was last modified.
• GetName
  Returns the name part of the filename (without extension).
• GetPath
  Returns the path part of the filename (without the name or extension).
• GetPathWithSep
  Returns the path with the trailing separator, useful for appending the name to the given path.
• GetShortPath
  Return the short form of the path (returns identity on non-Windows platforms).
• GetVolume
  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).
• HasExt
  Returns true if an extension is present.
• HasName
  Returns true if a name is present.
• HasVolume
  Returns true if a volume specifier is present.
• InsertDir
  Inserts a directory component before the zero-based position in the directory list.
• IsAbsolute
  Returns true if this filename is absolute.
• IsDir
  Returns true if this object represents a directory, false otherwise (i.e.
• IsDirReadable
  Returns true if the directory component of this instance is an existing directory and this process has read permissions on it.
• IsDirWritable
  Returns true if the directory component of this instance is an existing directory and this process has write permissions on it.
• IsFileExecutable
  Returns true if a file with this name exists and if this process has execute permissions on it.
• IsFileReadable
  Returns true if a file with this name exists and if this process has read permissions on it.
• IsFileWritable
  Returns true if a file with this name exists and if this process has write permissions on it.
• IsOk
  Returns true if the filename is valid, false if it is not initialized yet.
• IsRelative
  Returns true if this filename is not absolute.
• MakeAbsolute
  Make the file name absolute.
• MakeRelativeTo
  This function tries to put this file name in a form relative to pathBase.
• Mkdir
  Creates a directory.
• Normalize
  Normalize the path.
• PrependDir
  Prepends a directory to the file path.
• RemoveDir
  Removes the specified directory component from the path.
• RemoveLastDir
  Removes last directory component from the path.
• ReplaceEnvVariable
  If the path contains the value of the environment variable named envname then this function replaces it with the string obtained from wxString::Format(replacementFmtString, value_of_envname_variable).
• ReplaceHomeDir
  Replaces, if present in the path, the home directory for the given user (see wxGetHomeDir) with a tilde (~).
• SameAs
  Compares the filename using the rules of this platform.
• SetEmptyExt
  Sets the extension of the file name to be an empty extension.
• SetExt
  Sets the extension of the file name.
• SetFullName
  The full name is the file name and extension (but without the path).
• SetName
  Sets the name part (without extension).
• SetPath
  Sets the path.
• SetTimes
  Sets the file creation and last access/modification times (any of the pointers may be NULL).
• SetVolume
  Sets the volume specifier.
• Touch
  Sets the access and modification times to the current moment.

Static Methods

• CreateTempFileName
  Returns a temporary file name starting with the given prefix.
• DirName
  Returns the object corresponding to the directory with the given name.
• FileName
  Returns the file name object corresponding to the given file.
• GetCwd
  Retrieves the value of the current working directory on the specified volume.
• GetForbiddenChars
  Returns the characters that can't be used in filenames and directory names for the specified format.
• GetFormat
  Returns the canonical path format for this platform.
• GetHomeDir
  Returns the home directory.
• GetPathSeparators
  Returns the string containing all the path separators for this format.
• GetPathTerminators
  Returns the string of characters which may terminate the path part.
• GetTempDir
  Returns the directory used for temporary files.
• GetVolumeSeparator
  Returns the string separating the volume from the path for this format.
• IsCaseSensitive
  Returns true if the file names of this type are case-sensitive.
• IsMSWUniqueVolumeNamePath
  Returns true if the volume part of the path is a unique volume name.
• Rmdir
  Deletes the specified directory from the file system.
• SetCwd
  Changes the current working directory.
• SplitPath
  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.
• SplitVolume
  Splits the given fullpath into the volume part (which may be empty) and the pure path part, not containing any volume.
• StripExtension
  Strip the file extension.

wxFileName

wxFileName ( wxFileName $filename )

Copy constructor.
wxFileName ( )

Default constructor.
wxFileName ( string $fullpath, wxPathFormat $format=wxPATH_NATIVE )

Constructor taking a full filename.
wxFileName ( string $path, string $name, wxPathFormat $format=wxPATH_NATIVE )

Constructor a directory name and file name.
wxFileName ( string $path, string $name, string $ext, wxPathFormat $format=wxPATH_NATIVE )

Constructor from a directory name, base file name and extension.
wxFileName ( string $volume, string $path, string $name, string $ext, wxPathFormat $format=wxPATH_NATIVE )

Constructor from a volume name, a directory name, base file name and extension.

AppendDir

AppendDir ( string $dir )

Appends a directory component to the path.

Assign

Assign ( wxFileName $filepath )

Creates the file name from another filename object.
Assign ( string $fullpath, wxPathFormat $format=wxPATH_NATIVE )

Creates the file name from a full file name with a path.
Assign ( string $volume, string $path, string $name, string $ext, bool $hasExt, wxPathFormat $format=wxPATH_NATIVE )

Creates the file name from volume, path, name and extension.
Assign ( string $volume, string $path, string $name, string $ext, wxPathFormat $format=wxPATH_NATIVE )

Creates the file name from volume, path, name and extension.
Assign ( string $path, string $name, wxPathFormat $format=wxPATH_NATIVE )

Creates the file name from file path and file name.
Assign ( string $path, string $name, string $ext, wxPathFormat $format=wxPATH_NATIVE )

Creates the file name from path, name and extension.

AssignCwd

AssignCwd ( string $volume=wxEmptyString )

Makes this object refer to the current working directory on the specified volume (or current volume if volume is empty).

AssignDir

AssignDir ( string $dir, wxPathFormat $format=wxPATH_NATIVE )

Sets this file name object to the given directory name.

AssignHomeDir

AssignHomeDir ( )

Sets this file name object to the home directory.

AssignTempFileName

AssignTempFileName ( string $prefix )

The function calls CreateTempFileName() to create a temporary file and sets this object to the name of the file.
AssignTempFileName ( string $prefix, wxFile &$fileTemp )

The function calls CreateTempFileName() to create a temporary file name and open fileTemp with it.
AssignTempFileName ( string $prefix, wxFFile &$fileTemp )

The function calls CreateTempFileName() to create a temporary file name and open fileTemp with it.

Clear

Clear ( )

Reset all components to default, uninitialized state.

ClearExt

ClearExt ( )

Removes the extension from the file name resulting in a file name with no trailing dot.

CreateTempFileName

static string CreateTempFileName ( string $prefix, wxFile &$fileTemp=NULL )

Returns a temporary file name starting with the given prefix.
static string CreateTempFileName ( string $prefix, wxFFile &$fileTemp=NULL )

Returns a temporary file name starting with the given prefix.

DirExists

bool DirExists ( )

Returns true if the directory with this name exists.
static bool DirExists ( string $dir )

Returns true if the directory with name dir exists.

DirName

static wxFileName DirName ( string $dir, wxPathFormat $format=wxPATH_NATIVE )

Returns the object corresponding to the directory with the given name.

FileExists

bool FileExists ( )

Returns true if the file with this name exists.
static bool FileExists ( string $file )

Returns true if the file with name file exists.

FileName

static wxFileName FileName ( string $file, wxPathFormat $format=wxPATH_NATIVE )

Returns the file name object corresponding to the given file.

GetCwd

static string GetCwd ( string $volume=wxEmptyString )

Retrieves the value of the current working directory on the specified volume.

GetDirCount

integer GetDirCount ( )

Returns the number of directories in the file name.

GetDirs

array GetDirs ( )

Returns the directories in string array form.

GetExt

string GetExt ( )

Returns the file name extension.

GetForbiddenChars

static string GetForbiddenChars ( wxPathFormat $format=wxPATH_NATIVE )

Returns the characters that can't be used in filenames and directory names for the specified format.

GetFormat

static wxPathFormat GetFormat ( wxPathFormat $format=wxPATH_NATIVE )

Returns the canonical path format for this platform.

GetFullName

string GetFullName ( )

Returns the full name (including extension but excluding directories).

GetFullPath

string GetFullPath ( wxPathFormat $format=wxPATH_NATIVE )

Returns the full path with name and extension.

GetHomeDir

static string GetHomeDir ( )

Returns the home directory.

GetHumanReadableSize

string GetHumanReadableSize ( string $failmsg=_("Not available"), integer $precision=1, wxSizeConvention $conv=wxSIZE_CONV_TRADITIONAL )

Returns the representation of the file size in a human-readable form.

GetLongPath

string GetLongPath ( )

Return the long form of the path (returns identity on non-Windows platforms).

GetModificationTime

timestamp GetModificationTime ( )

Returns the last time the file was last modified.

GetName

string GetName ( )

Returns the name part of the filename (without extension).

GetPath

string GetPath ( integer $flags=wxPATH_GET_VOLUME, wxPathFormat $format=wxPATH_NATIVE )

Returns the path part of the filename (without the name or extension).

GetPathSeparators

static string GetPathSeparators ( wxPathFormat $format=wxPATH_NATIVE )

Returns the string containing all the path separators for this format.

GetPathTerminators

static string GetPathTerminators ( wxPathFormat $format=wxPATH_NATIVE )

Returns the string of characters which may terminate the path part.

GetPathWithSep

string GetPathWithSep ( wxPathFormat $format=wxPATH_NATIVE )

Returns the path with the trailing separator, useful for appending the name to the given path.

GetShortPath

string GetShortPath ( )

Return the short form of the path (returns identity on non-Windows platforms).

GetTempDir

static string GetTempDir ( )

Returns the directory used for temporary files.

GetVolume

string GetVolume ( )

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).

GetVolumeSeparator

static string GetVolumeSeparator ( wxPathFormat $format=wxPATH_NATIVE )

Returns the string separating the volume from the path for this format.

HasExt

bool HasExt ( )

Returns true if an extension is present.

HasName

bool HasName ( )

Returns true if a name is present.

HasVolume

bool HasVolume ( )

Returns true if a volume specifier is present.

InsertDir

InsertDir ( integer $before, string $dir )

Inserts a directory component before the zero-based position in the directory list.

IsAbsolute

bool IsAbsolute ( wxPathFormat $format=wxPATH_NATIVE )

Returns true if this filename is absolute.

IsCaseSensitive

static bool IsCaseSensitive ( wxPathFormat $format=wxPATH_NATIVE )

Returns true if the file names of this type are case-sensitive.

IsDir

bool IsDir ( )

Returns true if this object represents a directory, false otherwise (i.e.

IsDirReadable

bool IsDirReadable ( )

Returns true if the directory component of this instance is an existing directory and this process has read permissions on it.
static bool IsDirReadable ( string $dir )

Returns true if the given dir is an existing directory and this process has read permissions on it.

IsDirWritable

bool IsDirWritable ( )

Returns true if the directory component of this instance is an existing directory and this process has write permissions on it.
static bool IsDirWritable ( string $dir )

Returns true if the given dir is an existing directory and this process has write permissions on it.

IsFileExecutable

bool IsFileExecutable ( )

Returns true if a file with this name exists and if this process has execute permissions on it.
static bool IsFileExecutable ( string $file )

Returns true if a file with this name exists and if this process has execute permissions on it.

IsFileReadable

bool IsFileReadable ( )

Returns true if a file with this name exists and if this process has read permissions on it.
static bool IsFileReadable ( string $file )

Returns true if a file with this name exists and if this process has read permissions on it.

IsFileWritable

bool IsFileWritable ( )

Returns true if a file with this name exists and if this process has write permissions on it.
static bool IsFileWritable ( string $file )

Returns true if a file with this name exists and if this process has write permissions on it.

IsMSWUniqueVolumeNamePath

static bool IsMSWUniqueVolumeNamePath ( string $path, wxPathFormat $format=wxPATH_NATIVE )

Returns true if the volume part of the path is a unique volume name.

IsOk

bool IsOk ( )

Returns true if the filename is valid, false if it is not initialized yet.

IsRelative

bool IsRelative ( wxPathFormat $format=wxPATH_NATIVE )

Returns true if this filename is not absolute.

MakeAbsolute

bool MakeAbsolute ( string $cwd=wxEmptyString, wxPathFormat $format=wxPATH_NATIVE )

Make the file name absolute.

MakeRelativeTo

bool MakeRelativeTo ( string $pathBase=wxEmptyString, wxPathFormat $format=wxPATH_NATIVE )

This function tries to put this file name in a form relative to pathBase.

Mkdir

bool Mkdir ( integer $perm=wxS_DIR_DEFAULT, integer $flags )

Creates a directory.
static bool Mkdir ( string $dir, integer $perm=wxS_DIR_DEFAULT, integer $flags )

Creates a directory.

Normalize

bool Normalize ( integer $flags=wxPATH_NORM_ALL, string $cwd=wxEmptyString, wxPathFormat $format=wxPATH_NATIVE )

Normalize the path.

PrependDir

PrependDir ( string $dir )

Prepends a directory to the file path.

RemoveDir

RemoveDir ( integer $pos )

Removes the specified directory component from the path.

RemoveLastDir

RemoveLastDir ( )

Removes last directory component from the path.

ReplaceEnvVariable

bool ReplaceEnvVariable ( string $envname, string $replacementFmtString="$%s", wxPathFormat $format=wxPATH_NATIVE )

If the path contains the value of the environment variable named envname then this function replaces it with the string obtained from wxString::Format(replacementFmtString, value_of_envname_variable).

ReplaceHomeDir

bool ReplaceHomeDir ( wxPathFormat $format=wxPATH_NATIVE )

Replaces, if present in the path, the home directory for the given user (see wxGetHomeDir) with a tilde (~).

Rmdir

static bool Rmdir ( string $dir, integer $flags )

Deletes the specified directory from the file system.
bool Rmdir ( integer $flags )

Deletes the specified directory from the file system.

SameAs

bool SameAs ( wxFileName $filepath, wxPathFormat $format=wxPATH_NATIVE )

Compares the filename using the rules of this platform.

SetCwd

static bool SetCwd ( string $cwd )

Changes the current working directory.
bool SetCwd ( )

Changes the current working directory.

SetEmptyExt

SetEmptyExt ( )

Sets the extension of the file name to be an empty extension.

SetExt

SetExt ( string $ext )

Sets the extension of the file name.

SetFullName

SetFullName ( string $fullname )

The full name is the file name and extension (but without the path).

SetName

SetName ( string $name )

Sets the name part (without extension).

SetPath

SetPath ( string $path, wxPathFormat $format=wxPATH_NATIVE )

Sets the path.

SetTimes

bool SetTimes ( array $dtAccess, array $dtMod, array $dtCreate )

Sets the file creation and last access/modification times (any of the pointers may be NULL).

SetVolume

SetVolume ( string $volume )

Sets the volume specifier.

SplitPath

static SplitPath ( string $fullpath, string &$path, string &$name, string &$ext, wxPathFormat $format=wxPATH_NATIVE )

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.
static SplitPath ( string $fullpath, string &$volume, string &$path, string &$name, string &$ext, wxPathFormat $format )

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.
static SplitPath ( string $fullpath, string &$volume, string &$path, string &$name, string &$ext, bool &$hasExt=NULL, wxPathFormat $format=wxPATH_NATIVE )

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.

SplitVolume

static SplitVolume ( string $fullpath, string &$volume, string &$path, wxPathFormat $format=wxPATH_NATIVE )

Splits the given fullpath into the volume part (which may be empty) and the pure path part, not containing any volume.

StripExtension

static string StripExtension ( string $fullname )

Strip the file extension.

Touch

bool Touch ( )

Sets the access and modification times to the current moment.