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
|
.. 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.FileDirPickerEvent:
==========================================================================================================================================
|phoenix_title| **wx.FileDirPickerEvent**
==========================================================================================================================================
This event class is used for the events generated by :ref:`wx.FilePickerCtrl` and by :ref:`wx.DirPickerCtrl`.
.. _FileDirPickerEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.FileDirPickerEvent` parameter.
Event macros:
- EVT_FILEPICKER_CHANGED: Generated whenever the selected file changes.
- EVT_DIRPICKER_CHANGED: Generated whenever the selected directory changes.
.. seealso:: :ref:`wx.FilePickerCtrl`, :ref:`wx.DirPickerCtrl`
|
|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>FileDirPickerEvent</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.FileDirPickerEvent_inheritance.png" alt="Inheritance diagram of FileDirPickerEvent" 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.Event.html" title="wx.Event" alt="" coords="42,83,120,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="9,160,153,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="40,5,121,35"/> <area shape="rect" id="node4" href="wx.FileDirPickerEvent.html" title="wx.FileDirPickerEvent" alt="" coords="4,237,157,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileDirPickerEvent.__init__`
:meth:`~wx.FileDirPickerEvent.GetPath` Retrieve the absolute path of the file/directory the user has just selected.
:meth:`~wx.FileDirPickerEvent.SetPath` Set the absolute path of the file/directory associated with the event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileDirPickerEvent.Path` See :meth:`~wx.FileDirPickerEvent.GetPath` and :meth:`~wx.FileDirPickerEvent.SetPath`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileDirPickerEvent(CommandEvent)
**Possible constructors**::
FileDirPickerEvent()
FileDirPickerEvent(type, generator, id, path)
This event class is used for the events generated by FilePickerCtrl
and by DirPickerCtrl.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, type, generator, id, path)`
The constructor is not normally used by the user code.
:param `type`:
:type `type`: wx.EventType
:param `generator`:
:type `generator`: wx.Object
:param `id`:
:type `id`: int
:param `path`:
:type `path`: string
**~~~**
.. method:: GetPath(self)
Retrieve the absolute path of the file/directory the user has just selected.
:rtype: `string`
.. method:: SetPath(self, path)
Set the absolute path of the file/directory associated with the event.
:param `path`:
:type `path`: string
.. attribute:: Path
See :meth:`~wx.FileDirPickerEvent.GetPath` and :meth:`~wx.FileDirPickerEvent.SetPath`
|