Revision: 289
http://fclient.svn.sourceforge.net/fclient/?rev=289&view=rev
Author: jurner
Date: 2008-02-27 04:06:38 -0800 (Wed, 27 Feb 2008)
Log Message:
-----------
combed over docs
Modified Paths:
--------------
trunk/sandbox/fcp2/events.py
Modified: trunk/sandbox/fcp2/events.py
===================================================================
--- trunk/sandbox/fcp2/events.py 2008-02-27 12:06:22 UTC (rev 288)
+++ trunk/sandbox/fcp2/events.py 2008-02-27 12:06:38 UTC (rev 289)
@@ -13,6 +13,7 @@
def __del__(self): sys.path.pop(0)
hack = _RelImportHack(2)
+from fcp2 import consts
from fcp2 import types
from fcp2.fcp_lib import events
@@ -98,11 +99,25 @@
"""A request failed"""
class RequestFetchable(events.Event):
- """An upload is fetchable"""
+ """An upload is fetchable
+ The upload is not yet completed but it should be alreay fetchable
+ """
+
class RequestModified(events.Event):
- """A request has been modified"""
+ """A request has been modified
+ The 'FcModified' member of the request will contain
+ a dict indicating wich aspect of the request was modified.
+
+ The dict is a mapping of one or more [L{consts.RequestModified}] flag to the modified value.
+ Modified value will always be None, except when the aspect is [L{consts.RequestModified.Identifier}]
+ or [L{consts.RequestModified.Filename}]
+
+ @note: due to internal reasons the [L{consts.RequestModified.PersistentUserData}] member will
+ always be present
+ """
+
class RequestProgress(events.Event):
"""A request has made some progress"""
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
