1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.GenericDirCtrl:
==========================================================================================================================================
|phoenix_title| **wx.GenericDirCtrl**
==========================================================================================================================================
This control can be used to place a directory listing (with optional files) on an arbitrary window.
The control contains a :ref:`wx.TreeCtrl` window representing the directory hierarchy, and optionally, a :ref:`wx.Choice` window containing a list of filters.
.. _GenericDirCtrl-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.DIRCTRL_DIR_ONLY``: Only show directories, and not files.
- ``wx.DIRCTRL_3D_INTERNAL``: Use 3D borders for internal controls.
- ``wx.DIRCTRL_SELECT_FIRST``: When setting the default path, select the first file in the directory.
- ``wx.DIRCTRL_SHOW_FILTERS``: Show the drop-down filter list.
- ``wx.DIRCTRL_EDIT_LABELS``: Allow the folder and file labels to be editable.
- ``wx.DIRCTRL_MULTIPLE``: Allows multiple files and folders to be selected.
.. _GenericDirCtrl-events:
|events| Events Emitted by this Class
=====================================
Event macros for events emitted by this class:
- EVT_DIRCTRL_SELECTIONCHANGED: Selected directory has changed. Processes a ``wxEVT_DIRCTRL_SELECTIONCHANGED`` event type. Notice that this event is generated even for the changes done by the program itself and not only those done by the user. Available since wxWidgets 2.9.5.
- EVT_DIRCTRL_FILEACTIVATED: The user activated a file by double-clicking or pressing Enter. Available since wxWidgets 2.9.5.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>GenericDirCtrl</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.GenericDirCtrl_inheritance.png" alt="Inheritance diagram of GenericDirCtrl" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="wx.Control" alt="" coords="60,237,148,267"/> <area shape="rect" id="node6" href="wx.GenericDirCtrl.html" title="wx.GenericDirCtrl" alt="" coords="39,315,168,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.genericdirctrl.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.genericdirctrl.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.genericdirctrl.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.GenericDirCtrl.__init__` Default constructor.
:meth:`~wx.GenericDirCtrl.CollapsePath` Collapse the given `path`.
:meth:`~wx.GenericDirCtrl.CollapseTree` Collapses the entire tree.
:meth:`~wx.GenericDirCtrl.Create` Create function for two-step construction.
:meth:`~wx.GenericDirCtrl.ExpandPath` Tries to expand as much of the given `path` as possible, so that the filename or directory is visible in the tree control.
:meth:`~wx.GenericDirCtrl.GetDefaultPath` Gets the default path.
:meth:`~wx.GenericDirCtrl.GetFilePath` Gets selected filename path only (else empty string).
:meth:`~wx.GenericDirCtrl.GetFilePaths` Fills the array `paths` with the currently selected filepaths.
:meth:`~wx.GenericDirCtrl.GetFilter` Returns the filter string.
:meth:`~wx.GenericDirCtrl.GetFilterIndex` Returns the current filter index (zero-based).
:meth:`~wx.GenericDirCtrl.GetFilterListCtrl` Returns a pointer to the filter list control (if present).
:meth:`~wx.GenericDirCtrl.GetPath` Gets the currently-selected directory or filename.
:meth:`~wx.GenericDirCtrl.GetPaths` Fills the array `paths` with the selected directories and filenames.
:meth:`~wx.GenericDirCtrl.GetRootId` Returns the root id for the tree control.
:meth:`~wx.GenericDirCtrl.GetTreeCtrl` Returns a pointer to the tree control.
:meth:`~wx.GenericDirCtrl.Init` Initializes variables.
:meth:`~wx.GenericDirCtrl.ReCreateTree` Collapse and expand the tree, thus re-creating it from scratch.
:meth:`~wx.GenericDirCtrl.SelectPath` Selects the given item.
:meth:`~wx.GenericDirCtrl.SelectPaths` Selects only the specified paths, clearing any previous selection.
:meth:`~wx.GenericDirCtrl.SetDefaultPath` Sets the default path.
:meth:`~wx.GenericDirCtrl.SetFilter` Sets the filter string.
:meth:`~wx.GenericDirCtrl.SetFilterIndex` Sets the current filter index (zero-based).
:meth:`~wx.GenericDirCtrl.SetPath` Sets the current path.
:meth:`~wx.GenericDirCtrl.ShowHidden`
:meth:`~wx.GenericDirCtrl.UnselectAll` Removes the selection from all currently selected items.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.GenericDirCtrl.DefaultPath` See :meth:`~wx.GenericDirCtrl.GetDefaultPath` and :meth:`~wx.GenericDirCtrl.SetDefaultPath`
:attr:`~wx.GenericDirCtrl.FilePath` See :meth:`~wx.GenericDirCtrl.GetFilePath`
:attr:`~wx.GenericDirCtrl.Filter` See :meth:`~wx.GenericDirCtrl.GetFilter` and :meth:`~wx.GenericDirCtrl.SetFilter`
:attr:`~wx.GenericDirCtrl.FilterIndex` See :meth:`~wx.GenericDirCtrl.GetFilterIndex` and :meth:`~wx.GenericDirCtrl.SetFilterIndex`
:attr:`~wx.GenericDirCtrl.FilterListCtrl` See :meth:`~wx.GenericDirCtrl.GetFilterListCtrl`
:attr:`~wx.GenericDirCtrl.Path` See :meth:`~wx.GenericDirCtrl.GetPath` and :meth:`~wx.GenericDirCtrl.SetPath`
:attr:`~wx.GenericDirCtrl.RootId` See :meth:`~wx.GenericDirCtrl.GetRootId`
:attr:`~wx.GenericDirCtrl.TreeCtrl` See :meth:`~wx.GenericDirCtrl.GetTreeCtrl`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.GenericDirCtrl(Control)
**Possible constructors**::
GenericDirCtrl()
GenericDirCtrl(parent, id=ID_ANY, dir=DirDialogDefaultFolderStr,
pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL,
filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr)
This control can be used to place a directory listing (with optional
files) on an arbitrary window.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, dir=DirDialogDefaultFolderStr, pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL, filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr)`
Main constructor.
:param `parent`: Parent window.
:type `parent`: wx.Window
:param `id`: Window identifier.
:type `id`: wx.WindowID
:param `dir`: Initial folder.
:type `dir`: string
:param `pos`: Position.
:type `pos`: wx.Point
:param `size`: Size.
:type `size`: wx.Size
:param `style`: Window style. Please see :ref:`wx.GenericDirCtrl` for a list of possible styles.
:type `style`: long
:param `filter`: A filter string, using the same syntax as that for :ref:`wx.FileDialog`. This may be empty if filters are not being used. Example: ``"All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"``
:type `filter`: string
:param `defaultFilter`: The zero-indexed default filter setting.
:type `defaultFilter`: int
:param `name`: The window name.
:type `name`: string
**~~~**
.. method:: CollapsePath(self, path)
Collapse the given `path`.
:param `path`:
:type `path`: string
:rtype: `bool`
.. method:: CollapseTree(self)
Collapses the entire tree.
.. method:: Create(self, parent, id=ID_ANY, dir=DirDialogDefaultFolderStr, pos=DefaultPosition, size=DefaultSize, style=DIRCTRL_3D_INTERNAL, filter=EmptyString, defaultFilter=0, name=TreeCtrlNameStr)
Create function for two-step construction.
See :ref:`wx.GenericDirCtrl` for details.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `dir`:
:type `dir`: string
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `filter`:
:type `filter`: string
:param `defaultFilter`:
:type `defaultFilter`: int
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: ExpandPath(self, path)
Tries to expand as much of the given `path` as possible, so that the filename or directory is visible in the tree control.
:param `path`:
:type `path`: string
:rtype: `bool`
.. method:: GetDefaultPath(self)
Gets the default path.
:rtype: `string`
.. method:: GetFilePath(self)
Gets selected filename path only (else empty string).
This function doesn't count a directory as a selection.
:rtype: `string`
.. method:: GetFilePaths(self, paths)
Fills the array `paths` with the currently selected filepaths.
This function doesn't count a directory as a selection.
:param `paths`:
:type `paths`: list of strings
.. method:: GetFilter(self)
Returns the filter string.
:rtype: `string`
.. method:: GetFilterIndex(self)
Returns the current filter index (zero-based).
:rtype: `int`
.. method:: GetFilterListCtrl(self)
Returns a pointer to the filter list control (if present).
:rtype: :ref:`wx.DirFilterListCtrl`
.. method:: GetPath(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**GetPath** `(self)`
Gets the currently-selected directory or filename.
:rtype: `string`
**~~~**
**GetPath** `(self, itemId)`
Gets the path corresponding to the given tree control item.
:param `itemId`:
:type `itemId`: wx.TreeItemId
:rtype: `string`
.. versionadded:: 2.9.5
**~~~**
.. method:: GetPaths(self, paths)
Fills the array `paths` with the selected directories and filenames.
:param `paths`:
:type `paths`: list of strings
.. method:: GetRootId(self)
Returns the root id for the tree control.
:rtype: :ref:`wx.TreeItemId`
.. method:: GetTreeCtrl(self)
Returns a pointer to the tree control.
:rtype: :ref:`wx.TreeCtrl`
.. method:: Init(self)
Initializes variables.
.. method:: ReCreateTree(self)
Collapse and expand the tree, thus re-creating it from scratch.
May be used to update the displayed directory content.
.. method:: SelectPath(self, path, select=True)
Selects the given item.
In multiple selection controls, can be also used to deselect a currently selected item if the value of `select` is ``False``. Existing selections are not changed. Only visible items can be (de)selected, otherwise use :meth:`ExpandPath` .
:param `path`:
:type `path`: string
:param `select`:
:type `select`: bool
.. method:: SelectPaths(self, paths)
Selects only the specified paths, clearing any previous selection.
Only supported when ``wx.DIRCTRL_MULTIPLE`` is set.
:param `paths`:
:type `paths`: list of strings
.. method:: SetDefaultPath(self, path)
Sets the default path.
:param `path`:
:type `path`: string
.. method:: SetFilter(self, filter)
Sets the filter string.
:param `filter`:
:type `filter`: string
.. method:: SetFilterIndex(self, n)
Sets the current filter index (zero-based).
:param `n`:
:type `n`: int
.. method:: SetPath(self, path)
Sets the current path.
:param `path`:
:type `path`: string
.. method:: ShowHidden(self, show)
:param `show`: If ``True``, hidden folders and files will be displayed by the control. If ``False``, they will not be displayed.
:type `show`: bool
.. method:: UnselectAll(self)
Removes the selection from all currently selected items.
.. attribute:: DefaultPath
See :meth:`~wx.GenericDirCtrl.GetDefaultPath` and :meth:`~wx.GenericDirCtrl.SetDefaultPath`
.. attribute:: FilePath
See :meth:`~wx.GenericDirCtrl.GetFilePath`
.. attribute:: Filter
See :meth:`~wx.GenericDirCtrl.GetFilter` and :meth:`~wx.GenericDirCtrl.SetFilter`
.. attribute:: FilterIndex
See :meth:`~wx.GenericDirCtrl.GetFilterIndex` and :meth:`~wx.GenericDirCtrl.SetFilterIndex`
.. attribute:: FilterListCtrl
See :meth:`~wx.GenericDirCtrl.GetFilterListCtrl`
.. attribute:: Path
See :meth:`~wx.GenericDirCtrl.GetPath` and :meth:`~wx.GenericDirCtrl.SetPath`
.. attribute:: RootId
See :meth:`~wx.GenericDirCtrl.GetRootId`
.. attribute:: TreeCtrl
See :meth:`~wx.GenericDirCtrl.GetTreeCtrl`
|
