annotate cagou/plugins/plugin_wid_widget_selector.py @ 353:19422bbd9c8e

core (widgets handler): refactoring: - CagouWidget now has class properties (to be overridden when needed) which indicate how if the widget handle must add a wrapping ScreenManager (global_screen_manager) or show all instances of the class in a Carousel (collection_carousel). If none of those options is used, a ScrollView will be wrapping the widget, to be sure that the widget will be resized correctly when necessary (without it, the widget could still be drawn in the backround when the size is too small and overflow on the WidgetWrapper, this would be the case with WidgetSelector) - some helper methods/properties have been added to CagouWidget. Check docstrings for details - better handling of (in)visible widget in WidgetsHandler - thanks to the new wrapping ScrollView, WidgetSelect will show scroll bars if the available space is too small. - bugs fixes
author Goffi <goffi@goffi.org>
date Fri, 17 Jan 2020 18:44:35 +0100
parents 772c170b47a9
children 4d3a0c4f2430
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
353
19422bbd9c8e core (widgets handler): refactoring:
Goffi <goffi@goffi.org>
parents: 312
diff changeset
1 #!/usr/bin/env python3
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
2
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 # Cagou: desktop/mobile frontend for Salut à Toi XMPP client
282
1b835bcfa663 date update
Goffi <goffi@goffi.org>
parents: 267
diff changeset
4 # Copyright (C) 2016-2019 Jérôme Poisson (goffi@goffi.org)
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
5
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
6 # This program is free software: you can redistribute it and/or modify
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # (at your option) any later version.
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
10
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 # This program is distributed in the hope that it will be useful,
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # GNU Affero General Public License for more details.
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
18
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
19
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 from sat.core import log as logging
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 log = logging.getLogger(__name__)
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
22 from sat.core.i18n import _
15
56838ad5c84b files reorganisation, cagou is now launched with python2 cagou.py in src/
Goffi <goffi@goffi.org>
parents: 14
diff changeset
23 from cagou.core.constants import Const as C
169
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
24 from kivy.uix.widget import Widget
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from kivy.uix.boxlayout import BoxLayout
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 from kivy import properties
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
27 from kivy.uix.behaviors import ButtonBehavior
15
56838ad5c84b files reorganisation, cagou is now launched with python2 cagou.py in src/
Goffi <goffi@goffi.org>
parents: 14
diff changeset
28 from cagou.core import cagou_widget
16
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
29 from cagou import G
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
30
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
31
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
32 PLUGIN_INFO = {
312
772c170b47a9 Python3 port:
Goffi <goffi@goffi.org>
parents: 282
diff changeset
33 "name": _("widget selector"),
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
34 "import_name": C.WID_SELECTOR,
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
35 "main": "WidgetSelector",
312
772c170b47a9 Python3 port:
Goffi <goffi@goffi.org>
parents: 282
diff changeset
36 "description": _("show available widgets and allow to select one"),
772c170b47a9 Python3 port:
Goffi <goffi@goffi.org>
parents: 282
diff changeset
37 "icon_medium": "{media}/icons/muchoslava/png/selector_no_border_blue_44.png"
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
38 }
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
39
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
40
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 class WidgetSelItem(ButtonBehavior, BoxLayout):
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
42 plugin_info = properties.DictProperty()
169
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
43 item = properties.ObjectProperty()
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
44
169
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
45 def on_release(self, *args):
312
772c170b47a9 Python3 port:
Goffi <goffi@goffi.org>
parents: 282
diff changeset
46 log.debug("widget selection: {}".format(self.plugin_info["name"]))
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
47 factory = self.plugin_info["factory"]
18
790dbc5c4e89 plugin widget selector: display improvment + host profiles are now used by default
Goffi <goffi@goffi.org>
parents: 16
diff changeset
48 G.host.switchWidget(self, factory(self.plugin_info, None, profiles=iter(G.host.profiles)))
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
49
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
50
15
56838ad5c84b files reorganisation, cagou is now launched with python2 cagou.py in src/
Goffi <goffi@goffi.org>
parents: 14
diff changeset
51 class WidgetSelector(cagou_widget.CagouWidget):
267
896f78760b63 core: fixed crash when calling deleteUnusedWidgetInstances on widgets not inheriting from QuickWidget
Goffi <goffi@goffi.org>
parents: 180
diff changeset
52 # TODO: should inherit from QuickWidget
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
53
16
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
54 def __init__(self):
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
55 super(WidgetSelector, self).__init__()
169
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
56 self.items = []
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
57 for plugin_info in G.host.getPluggedWidgets(except_cls=self.__class__):
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
58 item = WidgetSelItem(plugin_info=plugin_info)
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
59 self.items.append(item.item)
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
60 item.item.bind(minimum_width=self.adjust_width)
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
61 self.add_widget(item)
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
62 self.add_widget(Widget())
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
63
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
64 def adjust_width(self, label, texture_size):
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
65 width = max([i.minimum_width for i in self.items])
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
66 for i in self.items:
6a288d4a493f widget selector: replaced deprecated ListView by BoxLayout
Goffi <goffi@goffi.org>
parents: 126
diff changeset
67 i.width = width
12
30f6586f904b widget selector:
Goffi <goffi@goffi.org>
parents:
diff changeset
68
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
69 @classmethod
16
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
70 def factory(cls, plugin_info, target, profiles):
ba14b596b90e host can now be get as a global value:
Goffi <goffi@goffi.org>
parents: 15
diff changeset
71 return cls()
14
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
72
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
73
21a432afd06d plugin system, first draft:
Goffi <goffi@goffi.org>
parents: 12
diff changeset
74 PLUGIN_INFO["factory"] = WidgetSelector.factory