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

minor additions and clarifications

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64053 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2010-04-19 18:54:26 +00:00
parent fde2aa3a95
commit 7f01b1fe21
2 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
interface/wx/dir.h
View File

@@ -104,6 +104,8 @@ enum wxDirFlags
wxDIR_HIDDEN = 0x0004, ///< Includes hidden files. wxDIR_HIDDEN = 0x0004, ///< Includes hidden files.
wxDIR_DOTDOT = 0x0008, ///< Includes "." and "..". wxDIR_DOTDOT = 0x0008, ///< Includes "." and "..".
//! Combination of the @c wxDIR_FILES, @c wxDIR_DIRS, @c wxDIR_HIDDEN flags
//! defined above.
wxDIR_DEFAULT = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN wxDIR_DEFAULT = wxDIR_FILES | wxDIR_DIRS | wxDIR_HIDDEN
}; };
@@ -195,6 +197,10 @@ public:
would be unchanged and should include ::wxDIR_DIRS flag to recurse into would be unchanged and should include ::wxDIR_DIRS flag to recurse into
subdirectories (both flags are included in the value by default). subdirectories (both flags are included in the value by default).
See ::wxDirFlags for the list of the possible flags. See ::wxDirFlags for the list of the possible flags.
@return Returns the total number of files found while traversing
the directory @a dirname (i.e. the number of entries appended
to the @a files array).
@see Traverse() @see Traverse()
*/ */
@@ -277,7 +283,7 @@ public:
given. given.
See ::wxDirFlags for the list of the possible flags. See ::wxDirFlags for the list of the possible flags.
For each found directory, @ref wxDirTraverser::OnDir() "sink.OnDir()" For each directory found, @ref wxDirTraverser::OnDir() "sink.OnDir()"
is called and @ref wxDirTraverser::OnFile() "sink.OnFile()" is called is called and @ref wxDirTraverser::OnFile() "sink.OnFile()" is called
for every file. Depending on the return value, the enumeration may for every file. Depending on the return value, the enumeration may
continue or stop. continue or stop.

7
interface/wx/volume.h
View File

@@ -70,13 +70,13 @@ public:
/** /**
Default ctor. Use Create() later. Default ctor. Use Create() later.
*/ */
wxFSVolumeBase(); wxFSVolume();
/** /**
Create the volume object with the given @a name (which should be one of Create the volume object with the given @a name (which should be one of
those returned by GetVolumes()). those returned by GetVolumes()).
*/ */
wxFSVolumeBase(const wxString& name); wxFSVolume(const wxString& name);
/** /**
Create the volume object with the given @a name (which should be one of Create the volume object with the given @a name (which should be one of
@@ -90,6 +90,7 @@ public:
Only the volumes with @e flags such that the expression Only the volumes with @e flags such that the expression
@code (flags & flagsSet) == flagsSet && !(flags & flagsUnset) @endcode @code (flags & flagsSet) == flagsSet && !(flags & flagsUnset) @endcode
is @true, are returned. By default, all mounted ones are returned. is @true, are returned. By default, all mounted ones are returned.
See ::wxFSVolumeFlags enumeration values for a list of valid flags.
This operation may take a while and, even if this function is This operation may take a while and, even if this function is
synchronous, it can be stopped using CancelSearch(). synchronous, it can be stopped using CancelSearch().
@@ -114,7 +115,7 @@ public:
wxFSVolumeKind GetKind() const; wxFSVolumeKind GetKind() const;
/** /**
Returns the flags of this volume. See wxFSVolumeFlags. Returns the flags of this volume. See ::wxFSVolumeFlags enumeration values.
*/ */
int GetFlags() const; int GetFlags() const;