From b658de9cf3cb526f8492a54dab19e8238c9edb9b Mon Sep 17 00:00:00 2001
From: mike <michael.jmontcalm@gmail.com>
Date: Mon, 05 Oct 2009 15:42:07 +0000
Subject: LP 439980 : Adding missed actions in previous checkins

---
(limited to 'addons/timerevent.py')

diff --git a/addons/timerevent.py b/addons/timerevent.py
new file mode 100644
index 0000000..5bad416
--- /dev/null
+++ b/addons/timerevent.py
@@ -0,0 +1,74 @@
+# Copyright (C) 2009, Tutorius.org
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+from sugar.tutorius.filters import *
+from sugar.tutorius.properties import *
+import gobject
+import logging
+
+logger = logging.getLogger('filters')
+
+class TimerEvent(EventFilter):
+    timeout_s = TIntProperty("1000")
+    """
+    TimerEvent is a special EventFilter that uses gobject
+    timeouts to trigger a state change after a specified amount
+    of time. It must be used inside a gobject main loop to work.
+    """
+    def __init__(self,next_state,timeout_s):
+        """Constructor.
+
+        @param next_state default EventFilter param, passed on to EventFilter
+        @param timeout_s timeout in seconds
+        """
+        super(TimerEvent,self).__init__(next_state)
+        self.timeout_s = timeout_s
+        self._handler_id = None
+
+    def install_handlers(self, callback, **kwargs):
+        """install_handlers creates the timer and starts it"""
+        super(TimerEvent,self).install_handlers(callback, **kwargs)
+        #Create the timer
+        self._handler_id = gobject.timeout_add_seconds(self.timeout_s, self._timeout_cb)
+
+    def remove_handlers(self):
+        """remove handler removes the timer"""
+        super(TimerEvent,self).remove_handlers()
+        if self._handler_id:
+            try:
+                #XXX What happens if this was already triggered?
+                #remove the timer
+                gobject.source_remove(self._handler_id)
+            except:
+                pass
+
+    def _timeout_cb(self):
+        """
+        _timeout_cb triggers the eventfilter callback.
+
+        It is necessary because gobject timers only stop if the callback they
+        trigger returns False
+        """
+        self.do_callback()
+        return False #Stops timeout
+
+__event__ = {
+    "name" : "TimerEvent",
+    "display_name" : "Timed transition",
+    "icon" : "clock",
+    "class" : TimerEvent,
+    "mandatory_props" : ["next_state", "timeout_s"]
+}
--
cgit v0.9.1