Package wx :: Class FileDataObject
[frames | no frames]

Type FileDataObject

  object --+        
           |        
  DataObject --+    
               |    
DataObjectSimple --+
                   |
                  FileDataObject


wx.FileDataObject is a specialization of wx.DataObjectSimple 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.


Method Summary
DataObjectSimple __init__(self, format)
Constructor accepts the supported format (none by default) which may also be set later with SetFormat.
  __repr__(self)
  AddFile(self, filename)
Adds a file to the list of files represented by this data object.
[names] GetFilenames(self)
Returns a list of file names.
    Inherited from DataObjectSimple
String GetDataHere(self)
Returns the data bytes from the data object as a string, returns None on failure.
size_t GetDataSize(self)
Get the size of our data.
DataFormat GetFormat(self)
Returns the (one and only one) format supported by this object.
bool SetData(self, data)
Copy the data value to the data object.
  SetFormat(self, format)
Sets the supported format.
    Inherited from DataObject
  __del__(self)
[formats] GetAllFormats(self, dir)
Returns a list of all the wx.DataFormats that this dataobject supports in the given direction.
size_t GetFormatCount(self, dir)
Returns the number of available formats for rendering or setting the data.
DataFormat GetPreferredFormat(self, dir)
Returns the preferred format for either rendering the data (if dir is Get, its default value) or for setting it.
bool IsSupported(self, format, dir)
Returns True if this format is supported.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Class Variable Summary
    Inherited from DataObject
int Both = 3                                                                     
int Get = 1                                                                     
int Set = 2                                                                     

Method Details

__init__(self)
(Constructor)

Constructor accepts the supported format (none by default) which may also be set later with SetFormat.

Parameters:
format
           (type=DataFormat)

Returns:
DataObjectSimple
Overrides:
wx.DataObjectSimple.__init__ (inherited documentation)

AddFile(self, filename)

Adds a file to the list of files represented by this data object.

Parameters:
filename
           (type=String)

GetFilenames(self)

Returns a list of file names.

Returns:
[names]

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 17:04:57 2007 http://epydoc.sf.net