# 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 ..filters import *
from ..properties import *

class TriggerEventFilter(EventFilter):
    """
    This event filter can be triggered by simply calling its do_callback function.
    
    Used to fake events and see the effect on the FSM.
    """
    def __init__(self):
        EventFilter.__init__(self)
        self.toggle_on_callback = False
    
    def install_handlers(self, callback, **kwargs):
        """
        Forsakes the incoming callback function and just set the inner one.
        """
        self._callback = self._inner_cb
    
    def _inner_cb(self, event_filter):
        self.toggle_on_callback = not self.toggle_on_callback

__event__ = {
    'name' : 'TriggerEventFilter',
    'display_name' : 'Triggerable event filter (test only)',
    'icon' : '',
    'class' : TriggerEventFilter,
    'mandatory_props' : [],
    'test' : True
}