.. include:: headings.inc



.. _FileDataObject:

==========================================================================================================================================
|phoenix_title|  **FileDataObject**
==========================================================================================================================================

:ref:`FileDataObject`  is a specialization of :ref:`DataObject`  for file names.          

The program works with it just as if it were a list of absolute file names, but internally it uses the same format as Explorer and other compatible programs under Windows or GNOME/KDE filemanager under Unix which makes it possible to receive files from them using this class. 







         



.. warning:: Under all non-Windows platforms this class is currently "input-only", i.e. you can receive the files from another application, but copying (or dragging) file(s) from a wxWidgets application is not currently supported. ``PS``: GTK2 should work as well.  







.. seealso:: :ref:`DataObject`, :ref:`DataObjectSimple`, :ref:`TextDataObject`, :ref:`BitmapDataObject`, :ref:`DataObject`    







|

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

Inheritance diagram for class **FileDataObject**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/FileDataObject_inheritance.png" alt="Inheritance diagram of FileDataObject" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="DataObjectSimple.html" title="This is the simplest possible implementation of the DataObject  class." alt="" coords="143,5,268,35"/> <area shape="rect" id="node4" href="FileDataObject.html" title="FileDataObject  is a specialization of DataObject  for file names." alt="" coords="319,5,425,35"/> <area shape="rect" id="node2" href="DataObject.html" title="A DataObject  represents data that can be copied to or from the clipboard, or dragged and dropped." alt="" coords="7,5,92,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~FileDataObject.__init__`                                                 Constructor.
:meth:`~FileDataObject.AddFile`                                                  Adds a file to the file list represented by this data object (Windows only).
:meth:`~FileDataObject.GetFilenames`                                             Returns the array of file names.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~FileDataObject.Filenames`                                                See :meth:`~FileDataObject.GetFilenames`
================================================================================ ================================================================================


|


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

.. class:: FileDataObject(DataObjectSimple)

   FileDataObject is a specialization of DataObject for file names.
   
   **Possible constructors**::

       FileDataObject()
       



   .. method:: __init__(self)

      Constructor.                   





   .. method:: AddFile(self, file)

      Adds a file to the file list represented by this data object (Windows only).                  


      :param `file`: 
      :type `file`: string







   .. method:: GetFilenames(self)

      Returns the array of file names.                  

      :rtype: `list of strings`








   .. attribute:: Filenames

      See :meth:`~FileDataObject.GetFilenames`