# 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
"""
This addons aims to give the creator the means to fetch a widget address.
"""

from sugar.tutorius.filters import EventFilter
from sugar.tutorius.properties import TUAMProperty

class FetchWidget(EventFilter):
    """
    Property containter to be able to fetch TUamProperty from the tutorius
    service. Mandatory assignation will be done by the probe so we can
    inspect the application through DBUS.
    """
    # widget address property
    widaddr = TUAMProperty("0")

    def __init__(self, widaddr=None):
        """
        Constructor - Change a widget color
        @param widaddr: the widget address (UAM)
        """
        EventFilter.__init__(self)

        if widaddr:
            self.widaddr = widaddr

__event__ = {
    "name" : FetchWidget.__name__,
    "display_name" : "Fetch Widget",
    "icon" : "",
    "class" : FetchWidget,
    "mandatory_props" : ["widaddr"],
    "test" : True,
}