interface/wx/dirctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dirctrl.h
   3 // Purpose:     interface of wxGenericDirCtrl
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxGenericDirCtrl
  11
  12     This control can  be used to place a directory listing (with optional
  13     files) on an arbitrary window.
  14
  15     The control contains a wxTreeCtrl window representing the directory
  16     hierarchy, and optionally, a wxChoice window containing a list of filters.
  17
  18     @beginStyleTable
  19     @style{wxDIRCTRL_DIR_ONLY}
  20            Only show directories, and not files.
  21     @style{wxDIRCTRL_3D_INTERNAL}
  22            Use 3D borders for internal controls.
  23     @style{wxDIRCTRL_SELECT_FIRST}
  24            When setting the default path, select the first file in the
  25            directory.
  26     @style{wxDIRCTRL_EDIT_LABELS}
  27            Allow the folder and file labels to be editable.
  28     @endStyleTable
  29
  30     @library{wxbase}
  31     @category{ctrl}
  32     <!-- @appearance{genericdirctrl.png} -->
  33 */
  34 class wxGenericDirCtrl : public wxControl
  35 {
  36 public:
  37     /**
  38         Default constructor.
  39     */
  40     wxGenericDirCtrl();
  41     /**
  42         Main constructor.
  43
  44         @param parent
  45             Parent window.
  46         @param id
  47             Window identifier.
  48         @param dir
  49             Initial folder.
  50         @param pos
  51             Position.
  52         @param size
  53             Size.
  54         @param style
  55             Window style. Please see wxGenericDirCtrl for a list of possible
  56             styles.
  57         @param filter
  58             A filter string, using the same syntax as that for wxFileDialog.
  59             This may be empty if filters are not being used. Example:
  60             @c "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
  61         @param defaultFilter
  62             The zero-indexed default filter setting.
  63         @param name
  64             The window name.
  65     */
  66     wxGenericDirCtrl(wxWindow* parent, const wxWindowID id = -1,
  67                      const wxString& dir = wxDirDialogDefaultFolderStr,
  68                      const wxPoint& pos = wxDefaultPosition,
  69                      const wxSize& size = wxDefaultSize,
  70                      long style = wxDIRCTRL_3D_INTERNAL|wxBORDER_SUNKEN,
  71                      const wxString& filter = wxEmptyString,
  72                      int defaultFilter = 0,
  73                      const wxString& name = wxTreeCtrlNameStr);
  74
  75     /**
  76         Destructor.
  77     */
  78     virtual ~wxGenericDirCtrl();
  79
  80     /**
  81         Collapse the given @a path.
  82     */
  83     virtual bool CollapsePath(const wxString& path);
  84
  85     /**
  86         Collapses the entire tree.
  87     */
  88     virtual void CollapseTree();
  89
  90     /**
  91         Create function for two-step construction. See wxGenericDirCtrl() for
  92         details.
  93     */
  94     bool Create(wxWindow* parent, const wxWindowID id = wxID_ANY,
  95                 const wxString& dir = wxDirDialogDefaultFolderStr,
  96                 const wxPoint& pos = wxDefaultPosition,
  97                 const wxSize& size = wxDefaultSize,
  98                 long style = wxDIRCTRL_3D_INTERNAL,
  99                 const wxString& filter = wxEmptyString, int defaultFilter = 0,
 100                 const wxString& name = wxTreeCtrlNameStr);
 101
 102     /**
 103         Tries to expand as much of the given @a path as possible, so that the
 104         filename or directory is visible in the tree control.
 105     */
 106     virtual bool ExpandPath(const wxString& path);
 107
 108     /**
 109         Gets the default path.
 110     */
 111     virtual wxString GetDefaultPath() const;
 112
 113     /**
 114         Gets selected filename path only (else empty string).
 115
 116         This function doesn't count a directory as a selection.
 117     */
 118     virtual wxString GetFilePath() const;
 119
 120     /**
 121         Returns the filter string.
 122     */
 123     virtual wxString GetFilter() const;
 124
 125     /**
 126         Returns the current filter index (zero-based).
 127     */
 128     virtual int GetFilterIndex() const;
 129
 130     /**
 131         Returns a pointer to the filter list control (if present).
 132     */
 133     virtual wxDirFilterListCtrl* GetFilterListCtrl() const;
 134
 135     /**
 136         Gets the currently-selected directory or filename.
 137     */
 138     virtual wxString GetPath() const;
 139
 140     /**
 141         Returns the root id for the tree control.
 142     */
 143     virtual wxTreeItemId GetRootId();
 144
 145     /**
 146         Returns a pointer to the tree control.
 147     */
 148     virtual wxTreeCtrl* GetTreeCtrl() const;
 149
 150     /**
 151         Initializes variables.
 152     */
 153     virtual void Init();
 154
 155     /**
 156         Collapse and expand the tree, thus re-creating it from scratch. May be
 157         used to update the displayed directory content.
 158     */
 159     virtual void ReCreateTree();
 160
 161     /**
 162         Sets the default path.
 163     */
 164     virtual void SetDefaultPath(const wxString& path);
 165
 166     /**
 167         Sets the filter string.
 168     */
 169     virtual void SetFilter(const wxString& filter);
 170
 171     /**
 172         Sets the current filter index (zero-based).
 173     */
 174     virtual void SetFilterIndex(int n);
 175
 176     /**
 177         Sets the current path.
 178     */
 179     virtual void SetPath(const wxString& path);
 180
 181     /**
 182         @param show
 183             If @true, hidden folders and files will be displayed by the
 184             control. If @false, they will not be displayed.
 185     */
 186     virtual void ShowHidden(bool show);
 187 };
 188