.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 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.
- 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

Inheritance diagram for class
FileDirPickerEvent:
|
|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() -> None
FileDirPickerEvent(type : EventType, generator : Object, id : int, path
: str) -> None
This event class is used for the events generated by FilePickerCtrl
and by DirPickerCtrl.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
:rtype: `None`
:html:`
`
**__init__** `(self, type : EventType, generator : Object, id : int, path : str)`
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
:rtype: `None`
:html:`
`
.. method:: GetPath(self)
Retrieve the absolute path of the file/directory the user has just selected.
:rtype: `str`
.. method:: SetPath(self, path : str)
Set the absolute path of the file/directory associated with the event.
:param `path`:
:type `path`: string
:rtype: `None`
.. attribute:: Path
See :meth:`~wx.FileDirPickerEvent.GetPath` and :meth:`~wx.FileDirPickerEvent.SetPath`