Mercurial > libervia-desktop-kivy
annotate src/cagou/core/menu.py @ 86:c711be670ecd
core, chat: upload plugin system:
- extented plugin system so it's not only used with main widget. It is also used for upload widgets and can be extended more
- plugin file name is used to detect the type: plugin_wid_* for main widgets, plugin_upload_* for upload widget plugins
- a new UploadMenu class allows to easily add an upload button which will use loaded plugins
- plugin_info can now specify a list of allowed platforms in "platforms" key
- file upload in chat has been moved to a plugin
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 25 Dec 2016 16:41:21 +0100 |
| parents | c2a7234d13d2 |
| children | 3dc526bb4a5a |
| rev | line source |
|---|---|
| 51 | 1 #!/usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # Cagou: desktop/mobile frontend for Salut à Toi XMPP client | |
| 5 # Copyright (C) 2016 Jérôme Poisson (goffi@goffi.org) | |
| 6 | |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
| 20 | |
| 21 from sat.core.i18n import _ | |
| 22 from sat.core import log as logging | |
| 23 log = logging.getLogger(__name__) | |
| 24 from cagou.core.constants import Const as C | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
25 from kivy.uix.boxlayout import BoxLayout |
| 51 | 26 from kivy.uix.label import Label |
| 27 from kivy.uix.popup import Popup | |
| 28 from kivy import properties | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
29 from kivy.garden import contextmenu |
| 51 | 30 from sat_frontends.quick_frontend import quick_menus |
| 31 from cagou import G | |
| 32 import webbrowser | |
| 33 | |
| 34 ABOUT_TITLE = _(u"About {}".format(C.APP_NAME)) | |
| 35 ABOUT_CONTENT = _(u"""Cagou (Salut à Toi) v{} | |
| 36 | |
| 37 Cagou is a libre communication tool based on libre standard XMPP. | |
| 38 | |
| 39 Cagou is part of the "Salut à Toi" project | |
| 40 more informations at [color=5500ff][ref=website]salut-a-toi.org[/ref][/color] | |
| 41 """).format(C.APP_VERSION) | |
| 42 | |
| 43 | |
| 44 class AboutContent(Label): | |
| 45 | |
| 46 def on_ref_press(self, value): | |
| 47 if value == "website": | |
| 48 webbrowser.open("https://salut-a-toi.org") | |
| 49 | |
| 50 | |
| 51 class AboutPopup(Popup): | |
| 52 | |
| 53 def on_touch_down(self, touch): | |
| 54 if self.collide_point(*touch.pos): | |
| 55 self.dismiss() | |
| 56 return super(AboutPopup, self).on_touch_down(touch) | |
| 57 | |
| 58 | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
59 class MainMenu(contextmenu.AppMenu): |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
60 pass |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
61 |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
62 |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
63 class MenuItem(contextmenu.ContextMenuTextItem): |
| 51 | 64 item = properties.ObjectProperty() |
| 65 | |
| 66 def on_item(self, instance, item): | |
| 67 self.text = item.name | |
| 68 | |
| 69 def on_release(self): | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
70 super(MenuItem, self).on_release() |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
71 self.parent.hide() |
| 51 | 72 selected = G.host.selected_widget |
| 73 profile = None | |
| 74 if selected is not None: | |
| 75 try: | |
| 76 profile = selected.profile | |
| 77 except AttributeError: | |
| 78 pass | |
| 79 | |
| 80 if profile is None: | |
| 81 try: | |
| 82 profile = list(selected.profiles)[0] | |
| 83 except (AttributeError, IndexError): | |
| 84 try: | |
| 85 profile = list(G.host.profiles)[0] | |
| 86 except IndexError: | |
| 87 log.warning(u"Can't find profile") | |
| 88 self.item.call(selected, profile) | |
| 89 | |
| 90 | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
91 class MenuSeparator(contextmenu.ContextMenuDivider): |
| 51 | 92 pass |
| 93 | |
| 94 | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
95 class RootMenuContainer(contextmenu.AppMenuTextItem): |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
96 pass |
| 51 | 97 |
| 98 | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
99 class MenuContainer(contextmenu.ContextMenuTextItem): |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
100 pass |
| 51 | 101 |
| 102 | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
103 class MenusWidget(BoxLayout): |
| 51 | 104 |
| 105 def update(self, type_, caller=None): | |
| 106 """Method to call when menus have changed | |
| 107 | |
| 108 @param type_(unicode): menu type like in sat.core.sat_main.importMenu | |
| 109 @param caller(Widget): instance linked to the menus | |
| 110 """ | |
| 111 self.menus_container = G.host.menus.getMainContainer(type_) | |
| 112 self.createMenus(caller) | |
| 113 | |
| 114 def _buildMenus(self, container, caller=None): | |
| 115 """Recursively build menus of the container | |
| 116 | |
| 117 @param container(quick_menus.MenuContainer): menu container | |
| 118 @param caller(Widget): instance linked to the menus | |
| 119 """ | |
| 120 if caller is None: | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
121 main_menu = MainMenu() |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
122 self.add_widget(main_menu) |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
123 caller = main_menu |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
124 else: |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
125 context_menu = contextmenu.ContextMenu() |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
126 caller.add_widget(context_menu) |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
127 # FIXME: next line is needed after parent is set to avoid a display bug in contextmenu |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
128 # TODO: fix this upstream |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
129 context_menu._on_visible(False) |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
130 |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
131 caller = context_menu |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
132 |
| 51 | 133 for child in container.getActiveMenus(): |
| 134 if isinstance(child, quick_menus.MenuContainer): | |
|
85
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
135 if isinstance(caller, MainMenu): |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
136 menu_container = RootMenuContainer() |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
137 else: |
|
c2a7234d13d2
menu: use of garden's contextmenu for menus
Goffi <goffi@goffi.org>
parents:
53
diff
changeset
|
138 menu_container = MenuContainer() |
| 51 | 139 menu_container.text = child.name |
| 140 caller.add_widget(menu_container) | |
| 141 self._buildMenus(child, caller=menu_container) | |
| 142 elif isinstance(child, quick_menus.MenuSeparator): | |
| 143 wid = MenuSeparator() | |
| 144 caller.add_widget(wid) | |
| 145 elif isinstance(child, quick_menus.MenuItem): | |
| 146 wid = MenuItem(item=child) | |
| 147 caller.add_widget(wid) | |
| 148 else: | |
| 149 log.error(u"Unknown child type: {}".format(child)) | |
| 150 | |
| 151 def createMenus(self, caller): | |
| 152 self.clear_widgets() | |
| 153 self._buildMenus(self.menus_container, caller) | |
| 154 | |
| 155 def onAbout(self): | |
| 156 about = AboutPopup() | |
| 157 about.title = ABOUT_TITLE | |
| 158 about.content = AboutContent(text=ABOUT_CONTENT, markup=True) | |
| 159 about.open() | |
| 86 | 160 |
| 161 | |
| 162 class UploadMenu(contextmenu.ContextMenu): | |
| 163 # callback will be called with path to file to upload | |
| 164 callback = properties.ObjectProperty() | |
| 165 # cancel callback need to remove the widget for UI | |
| 166 # will be called with the widget to remove as argument | |
| 167 cancel_cb = properties.ObjectProperty() | |
| 168 # profiles if set will be sent to upload widget, may be used to get specific files | |
| 169 profiles = properties.ObjectProperty() | |
| 170 | |
| 171 def __init__(self, **kwargs): | |
| 172 super(UploadMenu, self).__init__(**kwargs) | |
| 173 if self.cancel_cb is None: | |
| 174 self.cancel_cb = self.onUploadCancelled | |
| 175 if self.profiles is None: | |
| 176 self.profiles = iter(G.host.profiles) | |
| 177 for plug_info in G.host.getPluggedWidgets(type_=C.PLUG_TYPE_UPLOAD): | |
| 178 item = contextmenu.ContextMenuTextItem( | |
| 179 text = plug_info['name'], | |
| 180 on_release = lambda dummy, plug_info=plug_info: self.do_callback(plug_info) | |
| 181 ) | |
| 182 self.add_widget(item) | |
| 183 | |
| 184 def show(self, caller_wid=None): | |
| 185 if caller_wid is not None: | |
| 186 pos = caller_wid.x, caller_wid.top + self.get_height() | |
| 187 else: | |
| 188 pos = G.host.app.root_window.mouse_pos | |
| 189 super(UploadMenu, self).show(*pos) | |
| 190 | |
| 191 def _closeUI(self, wid): | |
| 192 G.host.closeUI() | |
| 193 | |
| 194 def onUploadCancelled(self, wid): | |
| 195 self._closeUI(wid) | |
| 196 | |
| 197 def do_callback(self, plug_info): | |
| 198 self.hide() | |
| 199 if self.callback is None: | |
| 200 log.warning(u"UploadMenu callback is not set") | |
| 201 else: | |
| 202 wid = None | |
| 203 def onUploadCb(file_path): | |
| 204 self._closeUI(wid) | |
| 205 self.callback(file_path) | |
| 206 wid = plug_info['factory'](plug_info, onUploadCb, self.cancel_cb, self.profiles) | |
| 207 G.host.showExtraUI(wid) |