.. include:: headings.inc



.. _FileCtrlEvent:

==========================================================================================================================================
|phoenix_title|  **FileCtrlEvent**
==========================================================================================================================================

A file control event holds information about events associated with :ref:`FileCtrl`  objects.          





.. _FileCtrlEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`FileCtrlEvent` parameter.

- EVT_FILECTRL_FILEACTIVATED: The user activated a file(by double-clicking or pressing Enter)  
- EVT_FILECTRL_SELECTIONCHANGED: The user changed the current selection(by selecting or deselecting a file)  
- EVT_FILECTRL_FOLDERCHANGED: The current folder of the file control has been changed  
- EVT_FILECTRL_FILTERCHANGED: The current file filter of the file control has been changed  










|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **FileCtrlEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/FileCtrlEvent_inheritance.png" alt="Inheritance diagram of FileCtrlEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="245,5,381,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> <area shape="rect" id="node6" href="FileCtrlEvent.html" title="A file control event holds information about events associated with FileCtrl  objects." alt="" coords="431,5,543,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~FileCtrlEvent.__init__`                                                  Constructor.
:meth:`~FileCtrlEvent.GetDirectory`                                              Returns the current directory.
:meth:`~FileCtrlEvent.GetFile`                                                   Returns the file selected (assuming it is only one file).
:meth:`~FileCtrlEvent.GetFiles`                                                  Returns the files selected.
:meth:`~FileCtrlEvent.GetFilterIndex`                                            Returns the current file filter index.
:meth:`~FileCtrlEvent.SetDirectory`                                              Sets the directory of this event.
:meth:`~FileCtrlEvent.SetFiles`                                                  Sets the files changed by this event.
:meth:`~FileCtrlEvent.SetFilterIndex`                                            Sets the filter index changed by this event.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~FileCtrlEvent.Directory`                                                 See :meth:`~FileCtrlEvent.GetDirectory` and :meth:`~FileCtrlEvent.SetDirectory`
:attr:`~FileCtrlEvent.File`                                                      See :meth:`~FileCtrlEvent.GetFile`
:attr:`~FileCtrlEvent.Files`                                                     See :meth:`~FileCtrlEvent.GetFiles` and :meth:`~FileCtrlEvent.SetFiles`
:attr:`~FileCtrlEvent.FilterIndex`                                               See :meth:`~FileCtrlEvent.GetFilterIndex` and :meth:`~FileCtrlEvent.SetFilterIndex`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: FileCtrlEvent(CommandEvent)

   A file control event holds information about events associated with FileCtrl objects.
   
   **Possible constructors**::

       FileCtrlEvent(type, evtObject, id)
       



   .. method:: __init__(self, type, evtObject, id)

      Constructor.                  


      :param `type`: 
      :type `type`: EventType
      :param `evtObject`: 
      :type `evtObject`: Object
      :param `id`: 
      :type `id`: int







   .. method:: GetDirectory(self)

      Returns the current directory.                  

      In case of a **``EVT_FILECTRL_FOLDERCHANGED``**, this method returns the new directory.                  

      :rtype: `string`








   .. method:: GetFile(self)

      Returns the file selected (assuming it is only one file).                  

      :rtype: `string`








   .. method:: GetFiles(self)

      Returns the files selected.                  

      In case of a **``EVT_FILECTRL_SELECTIONCHANGED``**, this method returns the files selected after the event.                  

      :rtype: `list of strings`








   .. method:: GetFilterIndex(self)

      Returns the current file filter index.                  

      For a **``EVT_FILECTRL_FILTERCHANGED``**  event, this method returns the new file filter index. 

                

      :rtype: `int`







      .. versionadded:: 2.9.1 
     








   .. method:: SetDirectory(self, directory)

      Sets the directory of this event.                  


      :param `directory`: 
      :type `directory`: string







   .. method:: SetFiles(self, files)

      Sets the files changed by this event.                  


      :param `files`: 
      :type `files`: list of strings







   .. method:: SetFilterIndex(self, index)

      Sets the filter index changed by this event.                  

                


      :param `index`: 
      :type `index`: int






      .. versionadded:: 2.9.1 
     








   .. attribute:: Directory

      See :meth:`~FileCtrlEvent.GetDirectory` and :meth:`~FileCtrlEvent.SetDirectory`


   .. attribute:: File

      See :meth:`~FileCtrlEvent.GetFile`


   .. attribute:: Files

      See :meth:`~FileCtrlEvent.GetFiles` and :meth:`~FileCtrlEvent.SetFiles`


   .. attribute:: FilterIndex

      See :meth:`~FileCtrlEvent.GetFilterIndex` and :meth:`~FileCtrlEvent.SetFilterIndex`