view src/plugin_wid_widget_selector.py @ 14:21a432afd06d

plugin system, first draft: - widgets are now handled with plugins, ContactList and WidgetSelector have been changed to be pluggins - everything in PLUGIN_INFO (including PLUGIN_INFO itself) is optional. Best guess is used if a value is missing - WidgetsHandler use default widget from plugins, which is WidgetSelector for now - PLUGIN_INFO is used in the same way as for backed plugins, with (for now) following possible keys: - "name": human readable name - "description": long description of what widget do - "import_name": unique short name used as reference for import - "main": main class name - "factory": callback used to instanciate a widget (see Cagou._defaultFactory) - "kv_file": path to the kv language file to load (same filename with ".kv" will be used if key is not found) other data should be added quickly, as a path to a file used as icon - host.getPluggedWidgets can be used to find loaded widgets. except_cls can be used to excluse a class (self.__class__ usually) - fixed host.switchWidget when old widget is already a CagouWidget - CagouWidget header new display the available widgets
author Goffi <goffi@goffi.org>
date Sat, 09 Jul 2016 16:02:44 +0200
parents src/widget_selector.py@30f6586f904b
children
line wrap: on
line source

#!/usr/bin/python
# -*- coding: utf-8 -*-

# Cagou: desktop/mobile frontend for Salut à Toi XMPP client
# Copyright (C) 2016 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


from sat.core import log as logging
log = logging.getLogger(__name__)
from sat.core.i18n import _
from constants import Const as C
from kivy.uix.boxlayout import BoxLayout
from kivy.uix.listview import ListView
from kivy.adapters.listadapter import ListAdapter
from kivy import properties
from kivy.uix.behaviors import ButtonBehavior
from cagou_widget import CagouWidget


PLUGIN_INFO = {
    "name": _(u"widget selector"),
    "import_name": C.WID_SELECTOR,
    "main": "WidgetSelector",
    "description": _(u"show available widgets and allow to select one"),
}


class WidgetSelItem(ButtonBehavior, BoxLayout):
    plugin_info = properties.DictProperty()

    def __init__(self, **kwargs):
        super(WidgetSelItem, self).__init__(**kwargs)
        self.host = kwargs['host']

    def select(self, *args):
        log.debug(u"widget selection: {}".format(self.plugin_info["name"]))
        factory = self.plugin_info["factory"]
        self.host.switchWidget(self, factory(self.host, self.plugin_info, None, None))

    def deselect(self, *args):
        pass


class WidgetSelector(CagouWidget):

    def __init__(self, host):
        super(WidgetSelector, self).__init__(host)
        self.host = host
        self.adapter = ListAdapter(
            data=host.getPluggedWidgets(except_cls=self.__class__),
            cls=WidgetSelItem,
            args_converter=self.dataConverter,
            selection_mode='single',
            allow_empty_selection=True,
           )
        self.add_widget(ListView(adapter=self.adapter))

    @classmethod
    def factory(cls, host, plugin_info, target, profiles):
        return cls(host)

    def dataConverter(self, idx, plugin_info):
        return {
            "host": self.host,
            "plugin_info": plugin_info,
            }


PLUGIN_INFO["factory"] = WidgetSelector.factory