/////////////////////////////////////////////////////////////////////////////
// Name: filefn.h
-// Purpose: documentation for wxPathList class
+// Purpose: interface of wxPathList
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{file}
- @seealso
- wxArrayString, wxStandardPaths, wxFileName
+ @see wxArrayString, wxStandardPaths, wxFileName
*/
class wxPathList : public wxArrayString
{
Note in fact that wxPathList can be used to store both relative and absolute
paths so that
if you Added() relative paths, then the current working directory
- (see wxGetCwd and wxSetWorkingDirectory)
+ (see wxGetCwd() and wxSetWorkingDirectory())
may affect the value returned by this function!
*/
wxString FindValidPath(const wxString& file) const;
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
/**
Returns @true if the @a pattern matches the @e text; if @a dot_special is @true,
filenames beginning with a dot are not matched
- with wildcard characters. See wxIsWild.
+ with wildcard characters. See wxIsWild().
*/
bool wxMatchWild(const wxString& pattern, const wxString& text,
bool dot_special);
/**
- @b NB: This function is deprecated: use wxGetCwd instead.
+ @b NB: This function is deprecated: use wxGetCwd() instead.
Copies the current working directory into the buffer if supplied, or
copies the working directory into new storage (which you must delete
yourself) if the buffer is @NULL.
wxString wxPathOnly(const wxString& path);
/**
- Returns @true if the pattern contains wildcards. See wxMatchWild.
+ Returns @true if the pattern contains wildcards. See wxMatchWild().
*/
bool wxIsWild(const wxString& pattern);
bool wxIsAbsolutePath(const wxString& filename);
/**
- Returns the next file that matches the path passed to wxFindFirstFile.
- See wxFindFirstFile for an example.
+ Returns the next file that matches the path passed to wxFindFirstFile().
+ See wxFindFirstFile() for an example.
*/
wxString wxFindNextFile();
/**
This function does directory searching; returns the first file
- that matches the path @e spec, or the empty string. Use wxFindNextFile to
+ that matches the path @e spec, or the empty string. Use wxFindNextFile() to
get the next matching file. Neither will report the current directory "." or the
parent directory "..".
*/