Contents Up Previous Next

wxPathList

The path list is a convenient way of storing a number of directories, and when presented with a filename without a directory, searching for an existing file in those directories. Storing the filename only in an application's files and using a locally-defined list of directories makes the application and its files more portable.

Use the wxFileNameFromPath global function to extract the filename from the path.

Derived from

wxList
wxObject

Include files

<wx/filefn.h>

See also

wxList

Members

wxPathList::wxPathList
wxPathList::AddEnvList
wxPathList::Add
wxPathList::EnsureFileAccessible
wxPathList::FindAbsoluteValidPath
wxPathList::FindValidPath
wxPathList::Member


wxPathList::wxPathList

wxPathList()

Constructor.


wxPathList::AddEnvList

void AddEnvList(const wxString& env_variable)

Finds the value of the given environment variable, and adds all paths to the path list. Useful for finding files in the PATH variable, for example.


wxPathList::Add

void Add(const wxString& path)

Adds the given directory to the path list, but does not check if the path was already on the list (use wxPathList::Member() for this).


wxPathList::EnsureFileAccessible

void EnsureFileAccessible(const wxString& filename)

Given a full filename (with path), ensures that files in the same path can be accessed using the pathlist. It does this by stripping the filename and adding the path to the list if not already there.


wxPathList::FindAbsoluteValidPath

wxString FindAbsoluteValidPath(const wxString& file)

Searches for a full path for an existing file by appending file to successive members of the path list. If the file wasn't found, an empty string is returned.


wxPathList::FindValidPath

wxString FindValidPath(const wxString& file)

Searches for a full path for an existing file by appending file to successive members of the path list. If the file wasn't found, an empty string is returned. This path may be relative to the current working directory.


wxPathList::Member

bool Member(const wxString& file)

true if the path is in the path list (ignoring case).