1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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"]
}
|