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

Type DropFilesEvent

object --+        
         |        
    Object --+    
             |    
         Event --+
                 |
                DropFilesEvent


This class is used for drop files events, that is, when files have been dropped onto the window. This functionality is only available under Windows. The window must have previously been enabled for dropping by calling wx.Window.DragAcceptFiles.

Important note: this is a separate implementation to the more general drag and drop implementation using wx.FileDropTarget, and etc. This implementation uses the older, Windows message-based approach of dropping files.

Use wx.EVT_DROP_FILES to bind an event handler to receive file drop events.


Method Summary
  __init__(self)
  __repr__(self)
PyObject GetFiles(self)
Returns a list of the filenames that were dropped.
int GetNumberOfFiles(self)
Returns the number of files dropped.
Point GetPosition(self)
Returns the position at which the files were dropped.
    Inherited from Event
  __del__(self)
Event Clone(self)
Object GetEventObject(self)
Returns the object (usually a window) associated with the event, if any.
wxEventType GetEventType(self)
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.
int GetId(self)
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped(self)
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp(self)
bool IsCommandEvent(self)
Returns true if the event is or is derived from wx.CommandEvent else it returns false.
  ResumePropagation(self, propagationLevel)
Resume the event propagation by restoring the propagation level.
  SetEventObject(self, obj)
Sets the originating object, or in other words, obj is normally the object that is sending the event.
  SetEventType(self, typ)
Sets the specific type of the event.
  SetId(self, Id)
Set's the ID for the event.
  SetTimestamp(self, ts)
bool ShouldPropagate(self)
Test if this event should be propagated to the parent window or not, i.e.
  Skip(self, skip)
Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns.
int StopPropagation(self)
Stop the event from propagating to its parent window.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    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)...

Method Details

GetFiles(self)

Returns a list of the filenames that were dropped.

Returns:
PyObject

GetNumberOfFiles(self)

Returns the number of files dropped.

Returns:
int

GetPosition(self)

Returns the position at which the files were dropped.

Returns:
Point

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