/////////////////////////////////////////////////////////////////////////////
// Name: dirctrl.h
-// Purpose: documentation for wxGenericDirCtrl class
+// Purpose: interface of wxGenericDirCtrl
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
//@{
/**
Main constructor.
-
+
@param parent
- Parent window.
-
+ Parent window.
@param id
- Window identifier.
-
+ Window identifier.
@param dir
- Initial folder.
-
+ Initial folder.
@param pos
- Position.
-
+ Position.
@param size
- Size.
-
+ Size.
@param style
- Window style. Please see wxGenericDirCtrl for a list of possible styles.
-
+ Window style. Please see wxGenericDirCtrl for a list of possible styles.
@param filter
- A filter string, using the same syntax as that for wxFileDialog. This may be
- empty if filters
- are not being used.
-
- Example: "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
-
+ A filter string, using the same syntax as that for wxFileDialog. This may
+ be empty if filters
+ are not being used.
+ Example: "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
@param defaultFilter
- The zero-indexed default filter setting.
-
+ The zero-indexed default filter setting.
@param name
- The window name.
+ The window name.
*/
wxGenericDirCtrl();
wxGenericDirCtrl(wxWindow* parent, const wxWindowID id = -1,
/**
Gets the default path.
*/
- wxString GetDefaultPath();
+ wxString GetDefaultPath() const;
/**
Gets selected filename path only (else empty string).
-
This function doesn't count a directory as a selection.
*/
- wxString GetFilePath();
+ wxString GetFilePath() const;
/**
Returns the filter string.
*/
- wxString GetFilter();
+ wxString GetFilter() const;
/**
Returns the current filter index (zero-based).
*/
- int GetFilterIndex();
+ int GetFilterIndex() const;
/**
Returns a pointer to the filter list control (if present).
*/
- wxDirFilterListCtrl* GetFilterListCtrl();
+ wxDirFilterListCtrl* GetFilterListCtrl() const;
/**
Gets the currently-selected directory or filename.
*/
- wxString GetPath();
+ wxString GetPath() const;
/**
Returns the root id for the tree control.
/**
Returns a pointer to the tree control.
*/
- wxTreeCtrl* GetTreeCtrl();
+ wxTreeCtrl* GetTreeCtrl() const;
/**
Initializes variables.
/**
@param show
- If @true, hidden folders and files will be displayed by the
- control. If @false, they will not be displayed.
+ If @true, hidden folders and files will be displayed by the
+ control. If @false, they will not be displayed.
*/
void ShowHidden(bool show);
};
+