libervia-backend: sat/tools/xml

annotate sat/tools/xml_tools.py @ 2923:1fd3ecb3351a

plugin XEP-0329: use local part of jid for components: when used by a component, local part can now be used to specify owner of the file. Local part is escaped using XEP-0106, then: - if the unescaped text contain a "@", it is used as a jid - else, a jid is build by using this text and host of the component

author	Goffi <goffi@goffi.org>
date	Fri, 26 Apr 2019 11:57:26 +0200
parents	777a582d9641
children	48985ef7682f

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1903 diff changeset	1 #!/usr/bin/env python2
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	4 # SAT: a jabber client
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2762 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	10 # (at your option) any later version.
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	15 # GNU Affero General Public License for more details.
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 590 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 762 diff changeset	20 from sat.core.i18n import _
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	21 from sat.core.constants import Const as C
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 981 diff changeset	22 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	23
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 981 diff changeset	24 log = getLogger(__name__)
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	25
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	26 from xml.dom import minidom, NotFoundErr
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 35 diff changeset	27 from wokkel import data_form
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	28 from twisted.words.xish import domish
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	29 from twisted.words.protocols.jabber import jid
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	30 from twisted.internet import defer
645 17bd09cd1001 core: misc bug fixes Goffi <goffi@goffi.org> parents: 630 diff changeset	31 from sat.core import exceptions
1500 c7c872a40e56 tools (xml_tools): keeps data form result headers sorted souliane <souliane@mailoo.org> parents: 1499 diff changeset	32 from collections import OrderedDict
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	33 from copy import deepcopy
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	34 import htmlentitydefs
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	35 import re
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	36
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	37 """This library help manage XML used in SàT (parameters, registration, etc)"""
33 b9bb5d8e0cc7 In-band-registration: data form 2 xml conversion Goffi <goffi@goffi.org> parents: diff changeset	38
796 46aa5ada61bf core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	39 SAT_FORM_PREFIX = "SAT_FORM_"
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	40 SAT_PARAM_SEPARATOR = "_XMLUI_PARAM_" # used to have unique elements names
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	41 html_entity_re = re.compile(r"&([a-zA-Z]+?);")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	42 XML_ENTITIES = ("quot", "amp", "apos", "lt", "gt")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	43
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	44 # method to clean XHTML, receive raw unsecure XML or HTML, must return cleaned raw XHTML
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	45 # this method must be set during runtime
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	46 cleanXHTML = None
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	47
1903 29564cec913f plugin XEP-0060: service, node and uri are added to metadata when doing a getItems Goffi <goffi@goffi.org> parents: 1819 diff changeset	48 # TODO: move XMLUI stuff in a separate module
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	49 # TODO: rewrite this with lxml or ElementTree or domish.Element: it's complicated and difficult to maintain with current minidom implementation
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	50
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	51 # Helper functions
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	52
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	53
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	54 def _dataFormField2XMLUIData(field, read_only=False):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	55 """Get data needed to create an XMLUI's Widget from Wokkel's data_form's Field.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	56
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	57 The attribute field can be modified (if it's fixed and it has no value).
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	58 @param field (data_form.Field): a field with attributes "value", "fieldType",
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	59 "label" and "var"
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	60 @param read_only (bool): if True and it makes sense, create a read only input widget
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	61 @return: a tuple (widget_type, widget_args, widget_kwargs)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	62 """
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	63 widget_args = [field.value]
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	64 widget_kwargs = {}
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	65 if field.fieldType is None and field.ext_type is not None:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	66 # we have an extended field
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	67 if field.ext_type == u"xml":
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	68 element = field.value
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	69 if element.uri == C.NS_XHTML:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	70 widget_type = "xhtmlbox"
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	71 widget_args[0] = element.toXml()
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	72 widget_kwargs["read_only"] = read_only
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	73 else:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	74 log.warning(u"unknown XML element, falling back to textbox")
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	75 widget_type = "textbox"
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	76 widget_args[0] = element.toXml()
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	77 widget_kwargs["read_only"] = read_only
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	78 else:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	79 raise exceptions.DataError(u"unknown extended type {ext_type}".format(
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	80 ext_type = field.ext_type))
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	81
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	82 elif field.fieldType == "fixed" or field.fieldType is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	83 widget_type = "text"
863 97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	84 if field.value is None:
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	85 if field.label is None:
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	86 log.warning(_(u"Fixed field has neither value nor label, ignoring it"))
863 97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	87 field.value = ""
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	88 else:
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	89 field.value = field.label
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	90 field.label = None
97ee7594c788 core (xmlui): fixed types with empty value are now correctly managed in _dataFormField2XMLUIData Goffi <goffi@goffi.org> parents: 820 diff changeset	91 widget_args[0] = field.value
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	92 elif field.fieldType == "text-single":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	93 widget_type = "string"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	94 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	95 elif field.fieldType == "jid-single":
1473 675e0e9f1653 core , privmitivus (xmlui): add jidInput handling, with a simple String for now Goffi <goffi@goffi.org> parents: 1472 diff changeset	96 widget_type = "jid_input"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	97 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	98 elif field.fieldType == "text-multi":
1078 bb4517e69957 tools (xmlui): data form 'text-multi' element must be converted to xmlui 'textbox' (not 'text') souliane <souliane@mailoo.org> parents: 1070 diff changeset	99 widget_type = "textbox"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	100 widget_args[0] = u"\n".join(field.values)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	101 widget_kwargs["read_only"] = read_only
2668 c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	102 elif field.fieldType == "hidden":
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	103 widget_type = "hidden"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	104 elif field.fieldType == "text-private":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	105 widget_type = "password"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	106 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	107 elif field.fieldType == "boolean":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	108 widget_type = "bool"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	109 if widget_args[0] is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	110 widget_args[0] = "false"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	111 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	112 elif field.fieldType == "integer":
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	113 widget_type = "integer"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	114 widget_kwargs["read_only"] = read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	115 elif field.fieldType == "list-single":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	116 widget_type = "list"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	117 widget_kwargs["options"] = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	118 (option.value, option.label or option.value) for option in field.options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	119 ]
1067 f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	120 widget_kwargs["selected"] = widget_args
f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	121 widget_args = []
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	122 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	123 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	124 u"FIXME FIXME FIXME: Type [%s] is not managed yet by SàT" % field.fieldType
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	125 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	126 widget_type = "string"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	127 widget_kwargs["read_only"] = read_only
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	128
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	129 if field.var:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	130 widget_kwargs["name"] = field.var
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	131
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	132 return widget_type, widget_args, widget_kwargs
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	133
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	134 def dataForm2Widgets(form_ui, form, read_only=False, prepend=None, filters=None):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	135 """Complete an existing XMLUI with widget converted from XEP-0004 data forms.
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	136
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	137 @param form_ui (XMLUI): XMLUI instance
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	138 @param form (data_form.Form): Wokkel's implementation of data form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	139 @param read_only (bool): if True and it makes sense, create a read only input widget
2380 59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	140 @param prepend(iterable, None): widgets to prepend to main LabelContainer
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	141 if not None, must be an iterable of *args for addWidget. Those widgets will
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	142 be added first to the container.
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	143 @param filters(dict, None): if not None, a dictionary of callable:
3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	144 key is the name of the widget to filter
2429 941fdf81958c core (XMLUI): form's XMLUI is use as first arguments for filters in dataForm2Widgets Goffi <goffi@goffi.org> parents: 2428 diff changeset	145 the value is a callable, it will get form's XMLUI, widget's type, args and kwargs
941fdf81958c core (XMLUI): form's XMLUI is use as first arguments for filters in dataForm2Widgets Goffi <goffi@goffi.org> parents: 2428 diff changeset	146 and must return widget's type, args and kwargs (which can be modified)
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	147 This is especially useful to modify well known fields
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	148 @return: the completed XMLUI instance
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	149 """
2405 f4b6176eb65f core (xmlui): fixed data_form => XMLUI conversion when filters is None Goffi <goffi@goffi.org> parents: 2398 diff changeset	150 if filters is None:
f4b6176eb65f core (xmlui): fixed data_form => XMLUI conversion when filters is None Goffi <goffi@goffi.org> parents: 2398 diff changeset	151 filters = {}
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	152 if form.instructions:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	153 form_ui.addText("\n".join(form.instructions), "instructions")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	154
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	155 form_ui.changeContainer("label")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	156
2380 59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	157 if prepend is not None:
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	158 for widget_args in prepend:
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	159 form_ui.addWidget(*widget_args)
59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	160
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	161 for field in form.fieldList:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	162 widget_type, widget_args, widget_kwargs = _dataFormField2XMLUIData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	163 field, read_only
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	164 )
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	165 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	166 widget_filter = filters[widget_kwargs["name"]]
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	167 except KeyError:
3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	168 pass
3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	169 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	170 widget_type, widget_args, widget_kwargs = widget_filter(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	171 form_ui, widget_type, widget_args, widget_kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	172 )
2668 c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	173 if widget_type != "hidden":
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	174 label = field.label or field.var
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	175 if label:
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	176 form_ui.addLabel(label)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	177 else:
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	178 form_ui.addEmpty()
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	179
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	180 form_ui.addWidget(widget_type, widget_args, *widget_kwargs)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	181
761 2f8d72226bc0 core (xml_tools): dataForm2XML renamed to dataForm2XMLUI and now return XMLUI instead of raw XML + submit_id is managed, and session_id is returned if present Goffi <goffi@goffi.org> parents: 760 diff changeset	182 return form_ui
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 35 diff changeset	183
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	184
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	185 def dataForm2XMLUI(form, submit_id, session_id=None, read_only=False):
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	186 """Take a data form (Wokkel's XEP-0004 implementation) and convert it to a SàT XMLUI.
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	187
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	188 @param form (data_form.Form): a Form instance
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	189 @param submit_id (unicode): callback id to call when submitting form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	190 @param session_id (unicode): session id to return with the data
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	191 @param read_only (bool): if True and it makes sense, create a read only input widget
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	192 @return: XMLUI instance
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	193 """
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	194 form_ui = XMLUI("form", "vertical", submit_id=submit_id, session_id=session_id)
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	195 return dataForm2Widgets(form_ui, form, read_only=read_only)
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	196
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	197
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	198 def dataFormEltResult2XMLUIData(form_xml):
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	199 """Parse a data form result (not parsed by Wokkel's XEP-0004 implementation).
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	200
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	201 The raw data form is used because Wokkel doesn't manage result items parsing yet.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	202 @param form_xml (domish.Element): element of the data form
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	203 @return: a couple (headers, result_list):
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	204 - headers (dict{unicode: unicode}): form headers (field labels and types)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	205 - xmlui_data (list[tuple]): list of (widget_type, widget_args, widget_kwargs)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	206 """
1500 c7c872a40e56 tools (xml_tools): keeps data form result headers sorted souliane <souliane@mailoo.org> parents: 1499 diff changeset	207 headers = OrderedDict()
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	208 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	209 reported_elt = form_xml.elements("jabber:x:data", "reported").next()
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	210 except StopIteration:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	211 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	212 "Couldn't find expected <reported> tag in %s" % form_xml.toXml()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	213 )
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	214
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 655 diff changeset	215 for elt in reported_elt.elements():
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	216 if elt.name != "field":
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	217 raise exceptions.DataError("Unexpected tag")
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	218 name = elt["var"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	219 label = elt.attributes.get("label", "")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	220 type_ = elt.attributes.get("type")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	221 headers[name] = (label, type_)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	222
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	223 if not headers:
684 969562c4761b core (tools): small fix in using imported methods souliane <souliane@mailoo.org> parents: 660 diff changeset	224 raise exceptions.DataError("No reported fields (see XEP-0004 §3.4)")
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	225
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	226 xmlui_data = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	227 item_elts = form_xml.elements("jabber:x:data", "item")
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	228
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	229 for item_elt in item_elts:
660 69a8bfd266a5 core, plugins: fixed bad use of children instead of elements() for domish.Element instances. Goffi <goffi@goffi.org> parents: 655 diff changeset	230 for elt in item_elt.elements():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	231 if elt.name != "field":
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	232 log.warning(u"Unexpected tag (%s)" % elt.name)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	233 continue
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	234 field = data_form.Field.fromElement(elt)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	235
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	236 xmlui_data.append(_dataFormField2XMLUIData(field))
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	237
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	238 return headers, xmlui_data
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	239
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	240
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	241 def XMLUIData2AdvancedList(xmlui, headers, xmlui_data):
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	242 """Take a raw data form result (not parsed by Wokkel's XEP-0004 implementation) and convert it to an advanced list.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	243
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	244 The raw data form is used because Wokkel doesn't manage result items parsing yet.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	245 @param xmlui (XMLUI): the XMLUI where the AdvancedList will be added
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	246 @param headers (dict{unicode: unicode}): form headers (field labels and types)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	247 @param xmlui_data (list[tuple]): list of (widget_type, widget_args, widget_kwargs)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	248 @return: the completed XMLUI instance
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	249 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	250 adv_list = AdvancedListContainer(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	251 xmlui, headers=headers, columns=len(headers), parent=xmlui.current_container
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	252 )
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	253 xmlui.changeContainer(adv_list)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	254
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	255 for widget_type, widget_args, widget_kwargs in xmlui_data:
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	256 xmlui.addWidget(widget_type, widget_args, *widget_kwargs)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	257
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	258 return xmlui
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	259
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	260
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	261 def dataFormResult2AdvancedList(xmlui, form_xml):
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	262 """Take a raw data form result (not parsed by Wokkel's XEP-0004 implementation) and convert it to an advanced list.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	263
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	264 The raw data form is used because Wokkel doesn't manage result items parsing yet.
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	265 @param xmlui (XMLUI): the XMLUI where the AdvancedList will be added
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	266 @param form_xml (domish.Element): element of the data form
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	267 @return: the completed XMLUI instance
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	268 """
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	269 headers, xmlui_data = dataFormEltResult2XMLUIData(form_xml)
1507 84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	270 XMLUIData2AdvancedList(xmlui, headers, xmlui_data)
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	271
84250128e425 tools (xml_tools): split dataFormResult2AdvancedList in dataFormResult2XMLUIData and XMLUIData2AdvancedList souliane <souliane@mailoo.org> parents: 1504 diff changeset	272
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	273 def dataFormEltResult2XMLUI(form_elt, session_id=None):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	274 """Take a raw data form (not parsed by XEP-0004) and convert it to a SàT XMLUI.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	275
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	276 The raw data form is used because Wokkel doesn't manage result items parsing yet.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	277 @param form_elt (domish.Element): element of the data form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	278 @param session_id (unicode): session id to return with the data
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	279 @return: XMLUI instance
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	280 """
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	281 xml_ui = XMLUI("window", "vertical", session_id=session_id)
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	282 try:
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	283 dataFormResult2AdvancedList(xml_ui, form_elt)
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	284 except exceptions.DataError:
8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	285 parsed_form = data_form.Form.fromElement(form_elt)
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	286 dataForm2Widgets(xml_ui, parsed_form, read_only=True)
1069 8e1f30aa3975 core (XMLUI): data form result now manage generic data set Goffi <goffi@goffi.org> parents: 1067 diff changeset	287 return xml_ui
590 56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	288
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	289
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	290 def dataFormResult2XMLUI(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	291 result_form, base_form, session_id=None, prepend=None, filters=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	292 ):
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	293 """Convert data form result to SàT XMLUI.
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	294
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	295 @param result_form (data_form.Form): result form to convert
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	296 @param base_form (data_form.Form): initial form (i.e. of form type "form")
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	297 this one is necessary to reconstruct options when needed (e.g. list elements)
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	298 @param session_id (unicode): session id to return with the data
2380 59636c4db2d0 core (xmlui): new "prepend" argument for dataForm2Widgets and dataFormResult2XMLUI: Goffi <goffi@goffi.org> parents: 2365 diff changeset	299 @param prepend: same as for [dataForm2Widgets]
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	300 @param filters: same as for [dataForm2Widgets]
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	301 @return: XMLUI instance
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	302 """
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	303 # we deepcopy the form because _dataFormField2XMLUIData can modify the value
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	304 # FIXME: check if it's really important, the only modified value seems to be
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	305 # the replacement of None by "" on fixed fields
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	306 form = deepcopy(result_form)
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	307 form = result_form
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	308 for name, field in form.fields.iteritems():
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	309 try:
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	310 base_field = base_form.fields[name]
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	311 except KeyError:
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	312 continue
2386 2e05921df16a plugin schema, core(xmlui): deep copy base form when reused to avoid accidental modification Goffi <goffi@goffi.org> parents: 2380 diff changeset	313 field.options = base_field.options[:]
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	314 xml_ui = XMLUI("window", "vertical", session_id=session_id)
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	315 dataForm2Widgets(xml_ui, form, read_only=True, prepend=prepend, filters=filters)
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	316 return xml_ui
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	317
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	318
981 58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	319 def _cleanValue(value):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	320 """Workaround method to avoid DBus types with D-Bus bridge.
981 58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	321
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	322 @param value: value to clean
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	323 @return: value in a non DBus type (only clean string yet)
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	324 """
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	325 # XXX: must be removed when DBus types will no cause problems anymore
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	326 # FIXME: should be cleaned inside D-Bus bridge itself
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	327 if isinstance(value, basestring):
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	328 return unicode(value)
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	329 return value
58a57ce5932a core (XMLUI): _cleanValue method to avoid issues with DBus types (must be deleted in the future) Goffi <goffi@goffi.org> parents: 977 diff changeset	330
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	331
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	332 def XMLUIResult2DataFormResult(xmlui_data):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	333 """ Extract form data from a XMLUI return.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	334
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	335 @param xmlui_data (dict): data returned by frontends for XMLUI form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	336 @return: dict of data usable by Wokkel's data form
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	337 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	338 return {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	339 key[len(SAT_FORM_PREFIX) :]: _cleanValue(value)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	340 for key, value in xmlui_data.iteritems()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	341 if key.startswith(SAT_FORM_PREFIX)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	342 }
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	343
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	344
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	345 def formEscape(name):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	346 """Return escaped name for forms.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	347
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	348 @param name (unicode): form name
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	349 @return: unicode
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	350 """
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	351 return u"%s%s" % (SAT_FORM_PREFIX, name)
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	352
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	353
2741 1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	354 def isXMLUICancelled(raw_xmlui):
1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	355 """Tell if an XMLUI has been cancelled by checking raw XML"""
1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	356 return C.bool(raw_xmlui.get(u'cancelled', C.BOOL_FALSE))
1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	357
1797671827b9 tools (xml_tools): isXMLUICancelled helper function to check if an XMLUI has been cancelled from raw XML. Goffi <goffi@goffi.org> parents: 2737 diff changeset	358
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	359 def XMLUIResultToElt(xmlui_data):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	360 """Construct result domish.Element from XMLUI result.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	361
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	362 @param xmlui_data (dict): data returned by frontends for XMLUI form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	363 @return: domish.Element
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	364 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	365 form = data_form.Form("submit")
762 aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	366 form.makeFields(XMLUIResult2DataFormResult(xmlui_data))
aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	367 return form.toElement()
aed7d99276b8 core (xml_tools), frontends: added a prefix to XMLUI form names in result data, to avoid name conflicts (e.g.: if a form has name "submit", and this name is also used internally by SàT) Goffi <goffi@goffi.org> parents: 761 diff changeset	368
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	369
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	370 def tupleList2dataForm(values):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	371 """Convert a list of tuples (name, value) to a wokkel submit data form.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	372
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	373 @param values (list): list of tuples
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	374 @return: data_form.Form
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	375 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	376 form = data_form.Form("submit")
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	377 for value in values:
94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	378 field = data_form.Field(var=value[0], value=value[1])
94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	379 form.addField(field)
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 35 diff changeset	380
102 94011f553cd0 misc bugfixes Goffi <goffi@goffi.org> parents: 95 diff changeset	381 return form
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	382
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	383
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	384 def paramsXML2XMLUI(xml):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	385 """Convert the XML for parameter to a SàT XML User Interface.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	386
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	387 @param xml (unicode)
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	388 @return: XMLUI
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	389 """
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	390 # TODO: refactor params and use Twisted directly to parse XML
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	391 params_doc = minidom.parseString(xml.encode("utf-8"))
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	392 top = params_doc.documentElement
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	393 if top.nodeName != "params":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	394 raise exceptions.DataError(_("INTERNAL ERROR: parameters xml not valid"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	395
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	396 param_ui = XMLUI("param", "tabs")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	397 tabs_cont = param_ui.current_container
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	398
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	399 for category in top.getElementsByTagName("category"):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	400 category_name = category.getAttribute("name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	401 label = category.getAttribute("label")
796 46aa5ada61bf core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	402 if not category_name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	403 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	404 _("INTERNAL ERROR: params categories must have a name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	405 )
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	406 tabs_cont.addTab(category_name, label=label, container=LabelContainer)
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	407 for param in category.getElementsByTagName("param"):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	408 widget_kwargs = {}
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	409
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	410 param_name = param.getAttribute("name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	411 param_label = param.getAttribute("label")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	412 type_ = param.getAttribute("type")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	413 if not param_name and type_ != "text":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	414 raise exceptions.DataError(_("INTERNAL ERROR: params must have a name"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	415
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	416 value = param.getAttribute("value") or None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	417 callback_id = param.getAttribute("callback_id") or None
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	418
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	419 if type_ == "list":
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	420 options, selected = _paramsGetListOptions(param)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	421 widget_kwargs["options"] = options
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	422 widget_kwargs["selected"] = selected
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	423 widget_kwargs["styles"] = ["extensible"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	424 elif type_ == "jids_list":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	425 widget_kwargs["jids"] = _paramsGetListJids(param)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	426
865 3ee2ec7ec010 core (xmlui), frontends: handling of "text" type in params xml + bug fixes Goffi <goffi@goffi.org> parents: 863 diff changeset	427 if type_ in ("button", "text"):
106 138d82f64b6f plugin CS: friends parsing Goffi <goffi@goffi.org> parents: 105 diff changeset	428 param_ui.addEmpty()
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	429 value = param_label
106 138d82f64b6f plugin CS: friends parsing Goffi <goffi@goffi.org> parents: 105 diff changeset	430 else:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	431 param_ui.addLabel(param_label or param_name)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	432
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	433 if value:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	434 widget_kwargs["value"] = value
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	435
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	436 if callback_id:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	437 widget_kwargs["callback_id"] = callback_id
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	438 others = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	439 "%s%s%s"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	440 % (category_name, SAT_PARAM_SEPARATOR, other.getAttribute("name"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	441 for other in category.getElementsByTagName("param")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	442 if other.getAttribute("type") != "button"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	443 ]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	444 widget_kwargs["fields_back"] = others
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	445
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	446 widget_kwargs["name"] = "%s%s%s" % (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	447 category_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	448 SAT_PARAM_SEPARATOR,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	449 param_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	450 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	451
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	452 param_ui.addWidget(type_, **widget_kwargs)
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	453
d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	454 return param_ui.toXml()
d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	455
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	456
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	457 def _paramsGetListOptions(param):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	458 """Retrieve the options for list element.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	459
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	460 The <option/> tags must be direct children of <param/>.
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	461 @param param (domish.Element): element
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	462 @return: a tuple (options, selected_value)
8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	463 """
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	464 if len(param.getElementsByTagName("options")) > 0:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	465 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	466 _("The 'options' tag is not allowed in parameter of type 'list'!")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	467 )
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	468 elems = param.getElementsByTagName("option")
655 56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	469 if len(elems) == 0:
56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	470 return []
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	471 options = [elem.getAttribute("value") for elem in elems]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	472 selected = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	473 elem.getAttribute("value")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	474 for elem in elems
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	475 if elem.getAttribute("selected") == "true"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	476 ]
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	477 return (options, selected)
655 56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	478
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	479
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	480 def _paramsGetListJids(param):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	481 """Retrive jids from a jids_list element.
655 56f8a9c99194 core, primitivus: better support for parameter of type list souliane <souliane@mailoo.org> parents: 645 diff changeset	482
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	483 the <jid/> tags must be direct children of <param/>
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	484 @param param (domish.Element): element
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	485 @return: a list of jids
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	486 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	487 elems = param.getElementsByTagName("jid")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	488 jids = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	489 elem.firstChild.data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	490 for elem in elems
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	491 if elem.firstChild is not None and elem.firstChild.nodeType == elem.TEXT_NODE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	492 ]
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	493 return jids
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	494
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	495
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	496 ### XMLUI Elements ###
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	497
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	498
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	499 class Element(object):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	500 """ Base XMLUI element """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	501
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	502 type = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	503
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	504 def __init__(self, xmlui, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	505 """Create a container element
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	506
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	507 @param xmlui: XMLUI instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	508 @parent: parent element
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	509 """
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	510 assert self.type is not None
2365 318f0434d830 core (xmlui): container now keep a list of children Goffi <goffi@goffi.org> parents: 2364 diff changeset	511 self.children = []
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	512 if not hasattr(self, "elem"):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	513 self.elem = parent.xmlui.doc.createElement(self.type)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	514 self.xmlui = xmlui
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	515 if parent is not None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	516 parent.append(self)
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	517 self.parent = parent
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	518
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	519 def append(self, child):
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	520 """Append a child to this element.
1490 55cff13b1f10 core (xmlui): reverted change from 039d96e131be: we should be able to recreate the same container with changeContainer Goffi <goffi@goffi.org> parents: 1487 diff changeset	521
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	522 @param child (Element): child element
0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	523 @return: the added child Element
0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	524 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	525 self.elem.appendChild(child.elem)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	526 child.parent = self
2365 318f0434d830 core (xmlui): container now keep a list of children Goffi <goffi@goffi.org> parents: 2364 diff changeset	527 self.children.append(child)
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	528 return child
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	529
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	530
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	531 class TopElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	532 """ Main XML Element """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	533
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	534 type = "top"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	535
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	536 def __init__(self, xmlui):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	537 self.elem = xmlui.doc.documentElement
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	538 super(TopElement, self).__init__(xmlui)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	539
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	540
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	541 class TabElement(Element):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	542 """ Used by TabsContainer to give name and label to tabs."""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	543
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	544 type = "tab"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	545
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	546 def __init__(self, parent, name, label, selected=False):
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	547 """
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	548
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	549 @param parent (TabsContainer): parent container
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	550 @param name (unicode): tab name
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	551 @param label (unicode): tab label
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	552 @param selected (bool): set to True to select this tab
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	553 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	554 if not isinstance(parent, TabsContainer):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	555 raise exceptions.DataError(_("TabElement must be a child of TabsContainer"))
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	556 super(TabElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	557 self.elem.setAttribute("name", name)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	558 self.elem.setAttribute("label", label)
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	559 if selected:
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	560 self.setSelected(selected)
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	561
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	562 def setSelected(self, selected=False):
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	563 """Set the tab selected.
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	564
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	565 @param selected (bool): set to True to select this tab
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	566 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	567 self.elem.setAttribute("selected", "true" if selected else "false")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	568
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	569
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	570 class FieldBackElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	571 """ Used by ButtonWidget to indicate which field have to be sent back """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	572
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	573 type = "field_back"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	574
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	575 def __init__(self, parent, name):
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	576 assert isinstance(parent, ButtonWidget)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	577 super(FieldBackElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	578 self.elem.setAttribute("name", name)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	579
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	580
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	581 class InternalFieldElement(Element):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	582 """ Used by internal callbacks to indicate which fields are manipulated """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	583
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	584 type = "internal_field"
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	585
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	586 def __init__(self, parent, name):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	587 super(InternalFieldElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	588 self.elem.setAttribute("name", name)
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	589
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	590
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	591 class InternalDataElement(Element):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	592 """ Used by internal callbacks to retrieve extra data """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	593
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	594 type = "internal_data"
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	595
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	596 def __init__(self, parent, children):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	597 super(InternalDataElement, self).__init__(parent.xmlui, parent)
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	598 assert isinstance(children, list)
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	599 for child in children:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	600 self.elem.childNodes.append(child)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	601
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	602
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	603 class OptionElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	604 """" Used by ListWidget to specify options """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	605
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	606 type = "option"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	607
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	608 def __init__(self, parent, option, selected=False):
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	609 """
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	610
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	611 @param parent
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	612 @param option (string, tuple)
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	613 @param selected (boolean)
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	614 """
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	615 assert isinstance(parent, ListWidget)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	616 super(OptionElement, self).__init__(parent.xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	617 if isinstance(option, basestring):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	618 value, label = option, option
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	619 elif isinstance(option, tuple):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	620 value, label = option
1067 f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	621 else:
f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	622 raise NotImplementedError
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	623 self.elem.setAttribute("value", value)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	624 self.elem.setAttribute("label", label)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	625 if selected:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	626 self.elem.setAttribute("selected", "true")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	627
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	628
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	629 class JidElement(Element):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	630 """" Used by JidsListWidget to specify jids"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	631
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	632 type = "jid"
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	633
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	634 def __init__(self, parent, jid_):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	635 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	636 @param jid_(jid.JID, unicode): jid to append
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	637 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	638 assert isinstance(parent, JidsListWidget)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	639 super(JidElement, self).__init__(parent.xmlui, parent)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	640 if isinstance(jid_, jid.JID):
1499 adc72c39f032 tools (xml_tools): fixes JidElement.__init__ souliane <souliane@mailoo.org> parents: 1490 diff changeset	641 value = jid_.full()
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	642 elif isinstance(jid_, basestring):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	643 value = unicode(jid_)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	644 else:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	645 raise NotImplementedError
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	646 jid_txt = self.xmlui.doc.createTextNode(value)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	647 self.elem.appendChild(jid_txt)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	648
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	649
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	650 class RowElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	651 """" Used by AdvancedListContainer """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	652
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	653 type = "row"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	654
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	655 def __init__(self, parent):
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	656 assert isinstance(parent, AdvancedListContainer)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	657 super(RowElement, self).__init__(parent.xmlui, parent)
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	658 if parent.next_row_idx is not None:
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	659 if parent.auto_index:
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	660 raise exceptions.DataError(_("Can't set row index if auto_index is True"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	661 self.elem.setAttribute("index", parent.next_row_idx)
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	662 parent.next_row_idx = None
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	663
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	664
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	665 class HeaderElement(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	666 """" Used by AdvancedListContainer """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	667
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	668 type = "header"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	669
876 65bf1bc70f6b tools, plugin XEP-0077: small fixes souliane <souliane@mailoo.org> parents: 865 diff changeset	670 def __init__(self, parent, name=None, label=None, description=None):
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	671 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	672 @param parent: AdvancedListContainer instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	673 @param name: name of the container
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	674 @param label: label to be displayed in columns
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	675 @param description: long descriptive text
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	676 """
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	677 assert isinstance(parent, AdvancedListContainer)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	678 super(HeaderElement, self).__init__(parent.xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	679 if name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	680 self.elem.setAttribute("name", name)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	681 if label:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	682 self.elem.setAttribute("label", label)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	683 if description:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	684 self.elem.setAttribute("description", description)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	685
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	686
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	687 ## Containers ##
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	688
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	689
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	690 class Container(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	691 """ And Element which contains other ones and has a layout """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	692
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	693 type = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	694
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	695 def __init__(self, xmlui, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	696 """Create a container element
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	697
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	698 @param xmlui: XMLUI instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	699 @parent: parent element or None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	700 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	701 self.elem = xmlui.doc.createElement("container")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	702 super(Container, self).__init__(xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	703 self.elem.setAttribute("type", self.type)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	704
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	705 def getParentContainer(self):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	706 """ Return first parent container
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	707
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	708 @return: parent container or None
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	709 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	710 current = self.parent
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	711 while not isinstance(current, (Container)) and current is not None:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	712 current = current.parent
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	713 return current
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	714
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	715
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	716 class VerticalContainer(Container):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	717 type = "vertical"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	718
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	719
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	720 class HorizontalContainer(Container):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	721 type = "horizontal"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	722
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	723
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	724 class PairsContainer(Container):
2737 5c2ed8a5ae22 frontends (XMLUI): TabsContainer can now be the main container (Primitivus keep the old behaviour and always use VerticalContainer as main container) Goffi <goffi@goffi.org> parents: 2668 diff changeset	725 """Container with series of 2 elements"""
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	726 type = "pairs"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	727
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	728
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	729 class LabelContainer(Container):
2737 5c2ed8a5ae22 frontends (XMLUI): TabsContainer can now be the main container (Primitivus keep the old behaviour and always use VerticalContainer as main container) Goffi <goffi@goffi.org> parents: 2668 diff changeset	730 """Like PairsContainer, but first element can only be a label"""
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	731 type = "label"
5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	732
5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	733
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	734 class TabsContainer(Container):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	735 type = "tabs"
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	736
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	737 def addTab(self, name, label=None, selected=None, container=VerticalContainer):
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	738 """Add a tab.
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	739
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	740 @param name (unicode): tab name
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	741 @param label (unicode): tab label
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	742 @param selected (bool): set to True to select this tab
1490 55cff13b1f10 core (xmlui): reverted change from 039d96e131be: we should be able to recreate the same container with changeContainer Goffi <goffi@goffi.org> parents: 1487 diff changeset	743 @param container (class): container class, inheriting from Container
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	744 @return: the container for the new tab
a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	745 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	746 if not label:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	747 label = name
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	748 tab_elt = TabElement(self, name, label, selected)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	749 new_container = container(self.xmlui, tab_elt)
1486 a77217511afd tools, frontends (xmlui): allow to select a tab when adding it souliane <souliane@mailoo.org> parents: 1476 diff changeset	750 return self.xmlui.changeContainer(new_container)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	751
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	752 def end(self):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	753 """ Called when we have finished tabs
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	754
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	755 change current container to first container parent
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	756 """
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	757 parent_container = self.getParentContainer()
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	758 self.xmlui.changeContainer(parent_container)
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	759
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	760
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	761 class AdvancedListContainer(Container):
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	762 """A list which can contain other widgets, headers, etc"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	763
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	764 type = "advanced_list"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	765
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	766 def __init__(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	767 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	768 xmlui,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	769 callback_id=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	770 name=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	771 headers=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	772 items=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	773 columns=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	774 selectable="no",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	775 auto_index=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	776 parent=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	777 ):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	778 """Create an advanced list
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	779
1199 96fb74a4714d misc: fixed some typos Matteo Cypriani <mcy@lm7.fr> parents: 1142 diff changeset	780 @param headers: optional headers information
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	781 @param callback_id: id of the method to call when selection is done
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	782 @param items: list of widgets to add (just the first row)
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	783 @param columns: number of columns in this table, or None to autodetect
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	784 @param selectable: one of:
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	785 'no': nothing is done
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	786 'single': one row can be selected
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	787 @param auto_index: if True, indexes will be generated by frontends,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	788 starting from 0
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	789 @return: created element
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	790 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	791 assert selectable in ("no", "single")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	792 if not items and columns is None:
876 65bf1bc70f6b tools, plugin XEP-0077: small fixes souliane <souliane@mailoo.org> parents: 865 diff changeset	793 raise exceptions.DataError(_("either items or columns need do be filled"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	794 if headers is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	795 headers = []
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	796 if items is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	797 items = []
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	798 super(AdvancedListContainer, self).__init__(xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	799 if columns is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	800 columns = len(items[0])
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	801 self._columns = columns
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	802 self._item_idx = 0
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	803 self.current_row = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	804 if headers:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	805 if len(headers) != self._columns:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	806 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	807 _("Headers lenght doesn't correspond to columns")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	808 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	809 self.addHeaders(headers)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	810 if items:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	811 self.addItems(items)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	812 self.elem.setAttribute("columns", str(self._columns))
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	813 if callback_id is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	814 self.elem.setAttribute("callback", callback_id)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	815 self.elem.setAttribute("selectable", selectable)
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	816 self.auto_index = auto_index
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	817 if auto_index:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	818 self.elem.setAttribute("auto_index", "true")
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	819 self.next_row_idx = None
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	820
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	821 def addHeaders(self, headers):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	822 for header in headers:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	823 self.addHeader(header)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	824
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	825 def addHeader(self, header):
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	826 pass # TODO
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	827
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	828 def addItems(self, items):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	829 for item in items:
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	830 self.append(item)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	831
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	832 def setRowIndex(self, idx):
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	833 """ Set index for next row
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	834
805 7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	835 index are returned when a row is selected, in data's "index" key
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	836 @param idx: string index to associate to the next row
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	837 """
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	838 self.next_row_idx = idx
7c05c39156a2 core (XMLUI), frontends: advancedListContainer part 2: Goffi <goffi@goffi.org> parents: 804 diff changeset	839
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	840 def append(self, child):
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	841 if isinstance(child, RowElement):
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	842 return super(AdvancedListContainer, self).append(child)
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	843 if self._item_idx % self._columns == 0:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	844 self.current_row = RowElement(self)
803 f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	845 self.current_row.append(child)
f100fd8d279f core, frontends: implementation of AdvancedListContainer first draft + misc: Goffi <goffi@goffi.org> parents: 802 diff changeset	846 self._item_idx += 1
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	847
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	848 def end(self):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	849 """ Called when we have finished list
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	850
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	851 change current container to first container parent
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	852 """
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	853 if self._item_idx % self._columns != 0:
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	854 raise exceptions.DataError(_("Incorrect number of items in list"))
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	855 parent_container = self.getParentContainer()
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	856 self.xmlui.changeContainer(parent_container)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	857
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	858
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	859 ## Widgets ##
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	860
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	861
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	862 class Widget(Element):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	863 type = None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	864
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	865 def __init__(self, xmlui, name=None, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	866 """Create an element
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	867
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	868 @param xmlui: XMLUI instance
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	869 @param name: name of the element or None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	870 @param parent: parent element or None
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	871 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	872 self.elem = xmlui.doc.createElement("widget")
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	873 super(Widget, self).__init__(xmlui, parent)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	874 if name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	875 self.elem.setAttribute("name", name)
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	876 if name in xmlui.named_widgets:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	877 raise exceptions.ConflictError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	878 _(u'A widget with the name "{name}" already exists.').format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	879 name=name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	880 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	881 )
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	882 xmlui.named_widgets[name] = self
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	883 self.elem.setAttribute("type", self.type)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	884
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	885 def setInternalCallback(self, callback, fields, data_elts=None):
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	886 """Set an internal UI callback when the widget value is changed.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	887
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	888 The internal callbacks are NO callback ids, they are strings from
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	889 a predefined set of actions that are running in the scope of XMLUI.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	890 @param callback (string): a value from:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	891 - 'copy': process the widgets given in 'fields' two by two, by
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	892 copying the values of one widget to the other. Target widgets
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	893 of type List do not accept the empty value.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	894 - 'move': same than copy but moves the values if the source widget
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	895 is not a List.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	896 - 'groups_of_contact': process the widgets two by two, assume A is
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	897 is a list of JID and B a list of groups, select in B the groups
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	898 to which the JID selected in A belongs.
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	899 - more operation to be added when necessary...
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	900 @param fields (list): a list of widget names (string)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	901 @param data_elts (list[Element]): extra data elements
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	902 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	903 self.elem.setAttribute("internal_callback", callback)
977 d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	904 if fields:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	905 for field in fields:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	906 InternalFieldElement(self, field)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	907 if data_elts:
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	908 InternalDataElement(self, data_elts)
d2e612a45e76 tools, frontends (xmlui): add Widget.setInternalCallback: souliane <souliane@mailoo.org> parents: 975 diff changeset	909
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	910
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	911 class EmptyWidget(Widget):
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	912 """Place holder widget"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	913
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	914 type = "empty"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	915
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	916
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	917 class TextWidget(Widget):
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	918 """Used for blob of text"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	919
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	920 type = "text"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	921
865 3ee2ec7ec010 core (xmlui), frontends: handling of "text" type in params xml + bug fixes Goffi <goffi@goffi.org> parents: 863 diff changeset	922 def __init__(self, xmlui, value, name=None, parent=None):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	923 super(TextWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	924 value_elt = self.xmlui.doc.createElement("value")
865 3ee2ec7ec010 core (xmlui), frontends: handling of "text" type in params xml + bug fixes Goffi <goffi@goffi.org> parents: 863 diff changeset	925 text = self.xmlui.doc.createTextNode(value)
1086 2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	926 value_elt.appendChild(text)
2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	927 self.elem.appendChild(value_elt)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	928
2428 c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	929 @property
c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	930 def value(self):
c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	931 return self.elem.firstChild.firstChild.wholeText
c2d88fe05303 core (XMLUI): added a "value" property in TextWidget Goffi <goffi@goffi.org> parents: 2414 diff changeset	932
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	933
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	934 class LabelWidget(Widget):
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	935 """One line blob of text
c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	936
c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	937 used most of time to display the desciption or name of the next widget
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	938 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	939 type = "label"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	940
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	941 def __init__(self, xmlui, label, name=None, parent=None):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	942 super(LabelWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	943 self.elem.setAttribute("value", label)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	944
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	945
2668 c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	946 class HiddenWidget(Widget):
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	947 """Not displayed widget, frontends will just copy the value(s)"""
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	948 type = "hidden"
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	949
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	950 def __init__(self, xmlui, value, name, parent=None):
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	951 super(HiddenWidget, self).__init__(xmlui, name, parent)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	952 value_elt = self.xmlui.doc.createElement("value")
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	953 text = self.xmlui.doc.createTextNode(value)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	954 value_elt.appendChild(text)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	955 self.elem.appendChild(value_elt)
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	956
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	957 @property
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	958 def value(self):
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	959 return self.elem.firstChild.firstChild.wholeText
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	960
c274201cea94 core, frontends (xmlui): added "hidden" widget, to specify a value to be returned unmodified Goffi <goffi@goffi.org> parents: 2625 diff changeset	961
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	962 class JidWidget(Widget):
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	963 """Used to display a Jabber ID, some specific methods can be added"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	964
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	965 type = "jid"
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	966
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	967 def __init__(self, xmlui, jid, name=None, parent=None):
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	968 super(JidWidget, self).__init__(xmlui, name, parent)
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	969 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	970 self.elem.setAttribute("value", jid.full())
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	971 except AttributeError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	972 self.elem.setAttribute("value", unicode(jid))
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	973
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	974
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	975 class DividerWidget(Widget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	976 type = "divider"
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	977
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	978 def __init__(self, xmlui, style="line", name=None, parent=None):
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	979 """ Create a divider
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	980
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	981 @param xmlui: XMLUI instance
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	982 @param style: one of:
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	983 - line: a simple line
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	984 - dot: a line of dots
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	985 - dash: a line of dashes
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	986 - plain: a full thick line
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	987 - blank: a blank line/space
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	988 @param name: name of the widget
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	989 @param parent: parent container
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	990
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	991 """
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	992 super(DividerWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	993 self.elem.setAttribute("style", style)
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	994
5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	995
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	996 ### Inputs ###
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	997
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	998
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	999 class InputWidget(Widget):
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1000 """Widget which can accept user inputs
c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1001
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1002 used mainly in forms
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1003 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1004
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1005 def __init__(self, xmlui, name=None, parent=None, read_only=False):
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1006 super(InputWidget, self).__init__(xmlui, name, parent)
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1007 if read_only:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1008 self.elem.setAttribute("read_only", "true")
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1009
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1010
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1011 class StringWidget(InputWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1012 type = "string"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1013
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1014 def __init__(self, xmlui, value=None, name=None, parent=None, read_only=False):
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1015 super(StringWidget, self).__init__(xmlui, name, parent, read_only=read_only)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1016 if value:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1017 value_elt = self.xmlui.doc.createElement("value")
1086 2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1018 text = self.xmlui.doc.createTextNode(value)
2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1019 value_elt.appendChild(text)
2cb30f46e560 core/frontends (XMLUI): value can now be inserted as a <value/> element, if not present value attribute is tested, else empty string is used. Goffi <goffi@goffi.org> parents: 1084 diff changeset	1020 self.elem.appendChild(value_elt)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1021
2446 bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1022 @property
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1023 def value(self):
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1024 return self.elem.firstChild.firstChild.wholeText
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1025
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1026
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1027 class PasswordWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1028 type = "password"
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1029
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1030
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1031 class TextBoxWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1032 type = "textbox"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1033
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1034
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1035 class XHTMLBoxWidget(StringWidget):
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1036 """Specialized textbox to manipulate XHTML"""
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1037 type = "xhtmlbox"
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1038
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1039 def __init__(self, xmlui, value, name=None, parent=None, read_only=False, clean=True):
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1040 """
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1041 @param clean(bool): if True, the XHTML is considered insecure and will be cleaned
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1042 Only set to False if you are absolutely sure that the XHTML is safe (in other
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1043 word, set to False only if you made the XHTML yourself)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1044 """
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1045 if clean:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1046 if cleanXHTML is None:
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1047 raise exceptions.NotFound(
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1048 u"No cleaning method set, can't clean the XHTML")
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1049 value = cleanXHTML(value)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1050
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1051 super(XHTMLBoxWidget, self).__init__(
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1052 xmlui, value=value, name=name, parent=parent, read_only=read_only)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1053
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1054
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1055 class JidInputWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1056 type = "jid_input"
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1057
03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1058
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1059 # TODO handle min and max values
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1060 class IntWidget(StringWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1061 type = "int"
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1062
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1063 def __init__(self, xmlui, value=0, name=None, parent=None, read_only=False):
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1064 try:
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1065 int(value)
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1066 except ValueError:
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1067 raise exceptions.DataError(_("Value must be an integer"))
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1068 super(IntWidget, self).__init__(xmlui, value, name, parent, read_only=read_only)
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1069
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1199 diff changeset	1070
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1071 class BoolWidget(InputWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1072 type = "bool"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1073
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1074 def __init__(self, xmlui, value="false", name=None, parent=None, read_only=False):
910 9754c0ebadba core (XMLUI): BoolWidget now accept real boolean for value Goffi <goffi@goffi.org> parents: 905 diff changeset	1075 if isinstance(value, bool):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1076 value = "true" if value else "false"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1077 elif value == "0":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1078 value = "false"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1079 elif value == "1":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1080 value = "true"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1081 if value not in ("true", "false"):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1082 raise exceptions.DataError(_("Value must be 0, 1, false or true"))
1084 03dcb6ca7e49 core (XMLUI): created a read_only attribute for InputWidget + new JidInputWidget Goffi <goffi@goffi.org> parents: 1078 diff changeset	1083 super(BoolWidget, self).__init__(xmlui, name, parent, read_only=read_only)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1084 self.elem.setAttribute("value", value)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1085
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1086
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1087 class ButtonWidget(Widget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1088 type = "button"
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1089
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1090 def __init__(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1091 self, xmlui, callback_id, value=None, fields_back=None, name=None, parent=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1092 ):
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1093 """Add a button
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1094
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1095 @param callback_id: callback which will be called if button is pressed
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1096 @param value: label of the button
1487 0df627d0b4ca tools (xmlui): changeContainer do not create a new one when the current one already fits souliane <souliane@mailoo.org> parents: 1486 diff changeset	1097 @param fields_back: list of names of field to give back when pushing the button
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1098 @param name: name
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1099 @param parent: parent container
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1100 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1101 if fields_back is None:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1102 fields_back = []
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1103 super(ButtonWidget, self).__init__(xmlui, name, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1104 self.elem.setAttribute("callback", callback_id)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1105 if value:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1106 self.elem.setAttribute("value", value)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1107 for field in fields_back:
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1108 FieldBackElement(self, field)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1109
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1110
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1111 class ListWidget(InputWidget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1112 type = "list"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1113 STYLES = (u"multi", u"noselect", u"extensible", u"reducible", u"inline")
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1114
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1115 def __init__(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1116 self, xmlui, options, selected=None, styles=None, name=None, parent=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1117 ):
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1118 """
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1119
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1120 @param xmlui
1141 7fcafc3206b1 plugin OTR: authentication management + fixed a bug in setState (due to a wrong docstring in potr.context.getCurrentTrust) Goffi <goffi@goffi.org> parents: 1105 diff changeset	1121 @param options (list[option]): each option can be given as:
7fcafc3206b1 plugin OTR: authentication management + fixed a bug in setState (due to a wrong docstring in potr.context.getCurrentTrust) Goffi <goffi@goffi.org> parents: 1105 diff changeset	1122 - a single string if the label and the value are the same
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1123 - a tuple with a couple of string (value,label) if the label and the
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1124 value differ
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1125 @param selected (list[string]): list of the selected values
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1126 @param styles (iterable[string]): flags to set the behaviour of the list
2071 c2fdee1bd908 core (stdui): fixed cancellation of ContactList forms Goffi <goffi@goffi.org> parents: 2044 diff changeset	1127 can be:
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1128 - multi: multiple selection is allowed
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1129 - noselect: no selection is allowed
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1130 useful when only the list itself is needed
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1131 - extensible: can be extended by user (i.e. new options can be added)
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1132 - reducible: can be reduced by user (i.e. options can be removed)
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1133 - inline: hint that this list should be displayed on a single line
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1134 (e.g. list of labels)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1135 @param name (string)
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1136 @param parent
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1137 """
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1138 styles = set() if styles is None else set(styles)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1139 if styles is None:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1140 styles = set()
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1141 else:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1142 styles = set(styles)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1143 if u"noselect" in styles and (u"multi" in styles or selected):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1144 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1145 _(
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1146 u'"multi" flag and "selected" option are not compatible with '
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1147 u'"noselect" flag'
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1148 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1149 )
820 462f2052af26 core(XMLUI): empty options in ListWidget now just show a warning message, no more assert Goffi <goffi@goffi.org> parents: 811 diff changeset	1150 if not options:
2364 918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	1151 # we can have no options if we get a submitted data form
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	1152 # but we can't use submitted values directly,
918e38622a48 core (xmlui): added method to convert data form result to XMLUI: Goffi <goffi@goffi.org> parents: 2361 diff changeset	1153 # because we would not have the labels
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 981 diff changeset	1154 log.warning(_('empty "options" list'))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1155 super(ListWidget, self).__init__(xmlui, name, parent)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1156 self.addOptions(options, selected)
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1157 self.setStyles(styles)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1158
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1159 def addOptions(self, options, selected=None):
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1160 """Add options to a multi-values element (e.g. list) """
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1161 if selected:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1162 if isinstance(selected, basestring):
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1163 selected = [selected]
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1164 else:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 910 diff changeset	1165 selected = []
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1166 for option in options:
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	1167 assert isinstance(option, basestring) or isinstance(option, tuple)
1067 f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	1168 value = option if isinstance(option, basestring) else option[0]
f7f15d44fdfa tools (xml_tools): dataForm2XMLUI handles the default value for "list-single" fields souliane <souliane@mailoo.org> parents: 1036 diff changeset	1169 OptionElement(self, option, value in selected)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1170
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1171 def setStyles(self, styles):
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1172 if not styles.issubset(self.STYLES):
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1173 raise exceptions.DataError(_(u"invalid styles"))
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1174 for style in styles:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1175 self.elem.setAttribute(style, "yes")
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1176 # TODO: check flags incompatibily (noselect and multi) like in __init__
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1177
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1178 def setStyle(self, style):
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1179 self.setStyles([style])
7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1180
2446 bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1181 @property
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1182 def value(self):
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1183 """Return the value of first selected option"""
bfd1e9d737c4 core (XMLUI): added value property for StringWidget and ListWidget Goffi <goffi@goffi.org> parents: 2429 diff changeset	1184 for child in self.elem.childNodes:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1185 if child.tagName == u"option" and child.getAttribute(u"selected") == u"true":
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1186 return child.getAttribute(u"value")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1187 return u""
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1188
2397 7fff98d64ab5 core (XMLUI), template(XMLUI): added flags to ListWidget: Goffi <goffi@goffi.org> parents: 2386 diff changeset	1189
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1190 class JidsListWidget(InputWidget):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1191 """A list of text or jids where elements can be added/removed or modified"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1192
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1193 type = "jids_list"
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1194
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1195 def __init__(self, xmlui, jids, styles=None, name=None, parent=None):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1196 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1197
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1198 @param xmlui
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1199 @param jids (list[jid.JID]): base jids
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1200 @param styles (iterable[string]): flags to set the behaviour of the list
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1201 @param name (string)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1202 @param parent
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1203 """
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1204 super(JidsListWidget, self).__init__(xmlui, name, parent)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1205 styles = set() if styles is None else set(styles)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1206 if not styles.issubset([]): # TODO
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1207 raise exceptions.DataError(_("invalid styles"))
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1208 for style in styles:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1209 self.elem.setAttribute(style, "yes")
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1210 if not jids:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1211 log.debug("empty jids list")
1476 48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1212 else:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1213 self.addJids(jids)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1214
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1215 def addJids(self, jids):
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1216 for jid_ in jids:
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1217 JidElement(self, jid_)
48706f4ff19c core (xmlui): added JidsListWidget to manage editable list of jids: Goffi <goffi@goffi.org> parents: 1475 diff changeset	1218
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1219
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1220 ## Dialog Elements ##
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1221
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1222
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1223 class DialogElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1224 """Main dialog element """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1225
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1226 type = "dialog"
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1227
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1228 def __init__(self, parent, type_, level=None):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1229 if not isinstance(parent, TopElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1230 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1231 _("DialogElement must be a direct child of TopElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1232 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1233 super(DialogElement, self).__init__(parent.xmlui, parent)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1234 self.elem.setAttribute(C.XMLUI_DATA_TYPE, type_)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1235 self.elem.setAttribute(C.XMLUI_DATA_LVL, level or C.XMLUI_DATA_LVL_DEFAULT)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1236
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1237
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1238 class MessageElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1239 """Element with the instruction message"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1240
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1241 type = C.XMLUI_DATA_MESS
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1242
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1243 def __init__(self, parent, message):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1244 if not isinstance(parent, DialogElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1245 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1246 _("MessageElement must be a direct child of DialogElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1247 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1248 super(MessageElement, self).__init__(parent.xmlui, parent)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1249 message_txt = self.xmlui.doc.createTextNode(message)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1250 self.elem.appendChild(message_txt)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1251
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1252
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1253 class ButtonsElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1254 """Buttons element which indicate which set to use"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1255
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1256 type = "buttons"
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1257
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1258 def __init__(self, parent, set_):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1259 if not isinstance(parent, DialogElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1260 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1261 _("ButtonsElement must be a direct child of DialogElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1262 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1263 super(ButtonsElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1264 self.elem.setAttribute("set", set_)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1265
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1266
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1267 class FileElement(Element):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1268 """File element used for FileDialog"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1269
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1270 type = "file"
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1271
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1272 def __init__(self, parent, type_):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1273 if not isinstance(parent, DialogElement):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1274 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1275 _("FileElement must be a direct child of DialogElement")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1276 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1277 super(FileElement, self).__init__(parent.xmlui, parent)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1278 self.elem.setAttribute("type", type_)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1279
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1280
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1281 ## XMLUI main class
630 0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1282
0b914394e74f core: added advanced list to XMLUI (need improvment, very basic so far) Goffi <goffi@goffi.org> parents: 615 diff changeset	1283
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1284 class XMLUI(object):
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1285 """This class is used to create a user interface (form/window/parameters/etc) using SàT XML"""
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1286
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1287 def __init__(self, panel_type="window", container="vertical", dialog_opt=None,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1288 title=None, submit_id=None, session_id=None):
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1289 """Init SàT XML Panel
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1290
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1291 @param panel_type: one of
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1292 - C.XMLUI_WINDOW (new window)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1293 - C.XMLUI_POPUP
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1294 - C.XMLUI_FORM (form, depend of the frontend, usually a panel with
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1295 cancel/submit buttons)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1296 - C.XMLUI_PARAM (parameters, presentation depend of the frontend)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1297 - C.XMLUI_DIALOG (one common dialog, presentation depend of frontend)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1298 @param container: disposition of elements, one of:
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1299 - vertical: elements are disposed up to bottom
5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1300 - horizontal: elements are disposed left to right
5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1301 - pairs: elements come on two aligned columns
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1302 (usually one for a label, the next for the element)
2361 5defafc8ede6 core, frontends (xmlui): new LabelContainer: Goffi <goffi@goffi.org> parents: 2108 diff changeset	1303 - label: associations of one LabelWidget or EmptyWidget with an other widget
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1304 similar to pairs but specialized in LabelWidget,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1305 and not necessarily arranged in 2 columns
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1306 - tabs: elemens are in categories with tabs (notebook)
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1307 @param dialog_opt: only used if panel_type == C.XMLUI_DIALOG.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1308 Dictionnary (string/string) where key can be:
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1309 - C.XMLUI_DATA_TYPE: type of dialog, value can be:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1310 - C.XMLUI_DIALOG_MESSAGE (default): an information/error message.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1311 Action of user is necessary to close the dialog.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1312 Usually the frontend display a classic popup.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1313 - C.XMLUI_DIALOG_NOTE: like a C.XMLUI_DIALOG_MESSAGE, but action of user
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1314 is not necessary to close, at frontend choice (it can be closed after
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1315 a timeout). Usually the frontend display as a timed out notification
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1316 - C.XMLUI_DIALOG_CONFIRM: dialog with 2 choices (usualy "Ok"/"Cancel").
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1317 returned data can contain:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1318 - "answer": "true" if answer is "ok", "yes" or equivalent,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1319 "false" else
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1320 - C.XLMUI_DIALOG_FILE: a file selection dialog
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1321 returned data can contain:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1322 - "cancelled": "true" if dialog has been cancelled, not present
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1323 or "false" else
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1324 - "path": path of the choosed file/dir
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1325 - C.XMLUI_DATA_MESS: message shown in dialog
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1326 - C.XMLUI_DATA_LVL: one of:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1327 - C.XMLUI_DATA_LVL_INFO (default): normal message
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1328 - C.XMLUI_DATA_LVL_WARNING: attention of user is important
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1329 - C.XMLUI_DATA_LVL_ERROR: something went wrong
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1330 - C.XMLUI_DATA_BTNS_SET: one of:
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1331 - C.XMLUI_DATA_BTNS_SET_OKCANCEL (default): classical "OK" and "Cancel"
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1332 set
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1333 - C.XMLUI_DATA_BTNS_SET_YESNO: a translated "yes" for OK, and "no" for
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1334 Cancel
1521 d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1335 - C.XMLUI_DATA_FILETYPE: only used for file dialogs, one of:
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1336 - C.XMLUI_DATA_FILETYPE_FILE: a file path is requested
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1337 - C.XMLUI_DATA_FILETYPE_DIR: a dir path is requested
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1338 - C.XMLUI_DATA_FILETYPE_DEFAULT: same as C.XMLUI_DATA_FILETYPE_FILE
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1339
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1340 @param title: title or default if None
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1341 @param submit_id: callback id to call for panel_type we can submit (form, param,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1342 dialog)
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1343 @param session_id: use to keep a session attached to the dialog, must be
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1344 returned by frontends
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	1345 @attribute named_widgets(dict): map from name to widget
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1346 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1347 if panel_type not in [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1348 C.XMLUI_WINDOW,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1349 C.XMLUI_FORM,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1350 C.XMLUI_PARAM,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1351 C.XMLUI_POPUP,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1352 C.XMLUI_DIALOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1353 ]:
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1354 raise exceptions.DataError(_("Unknown panel type [%s]") % panel_type)
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1355 if panel_type == C.XMLUI_FORM and submit_id is None:
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1356 raise exceptions.DataError(_("form XMLUI need a submit_id"))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1357 if not isinstance(container, basestring):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1358 raise exceptions.DataError(_("container argument must be a string"))
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1359 if dialog_opt is not None and panel_type != C.XMLUI_DIALOG:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1360 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1361 _("dialog_opt can only be used with dialog panels")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1362 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1363 self.type = panel_type
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1364 impl = minidom.getDOMImplementation()
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1365
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1366 self.doc = impl.createDocument(None, "sat_xmlui", None)
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1367 top_element = self.doc.documentElement
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1368 top_element.setAttribute("type", panel_type)
107 5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1369 if title:
5ae370c71803 CS: message sending is now working Goffi <goffi@goffi.org> parents: 106 diff changeset	1370 top_element.setAttribute("title", title)
1530 94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1371 self.submit_id = submit_id
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1372 self.session_id = session_id
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1373 if panel_type == C.XMLUI_DIALOG:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1374 if dialog_opt is None:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1375 dialog_opt = {}
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1376 self._createDialog(dialog_opt)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1377 return
1444 8ce9924fa92c tools (xml_tools): better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1409 diff changeset	1378 self.main_container = self._createContainer(container, TopElement(self))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1379 self.current_container = self.main_container
2398 3ff9d7a7fe71 core (XMLUI): filters can now be used when converting data form to XMLUI: Goffi <goffi@goffi.org> parents: 2397 diff changeset	1380 self.named_widgets = {}
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1381
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1382 @staticmethod
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1383 def creatorWrapper(widget_cls, is_input):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1384 # TODO: once moved to Python 3, use functools.partialmethod and
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1385 # remove the creatorWrapper
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1386 def createWidget(self, args, *kwargs):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1387 if self.type == C.XMLUI_DIALOG:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1388 raise exceptions.InternalError(_(
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1389 "createWidget can't be used with dialogs"))
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1390 if "parent" not in kwargs:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1391 kwargs["parent"] = self.current_container
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1392 if "name" not in kwargs and is_input:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1393 # name can be given as first argument or in keyword
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1394 # arguments for InputWidgets
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1395 args = list(args)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1396 kwargs["name"] = args.pop(0)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1397 return widget_cls(self, args, *kwargs)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1398 return createWidget
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1399
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1400 @classmethod
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1401 def _introspect(cls):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1402 """ Introspect module to find Widgets and Containers, and create addXXX methods"""
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1403 # FIXME: we can't log anything because this file is used
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1404 # in bin/sat script then evaluated
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1405 # bin/sat should be refactored
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1406 # log.debug(u'introspecting XMLUI widgets and containers')
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1407 cls._containers = {}
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1408 cls._widgets = {}
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1409 for obj in globals().values():
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1410 try:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1411 if issubclass(obj, Widget):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1412 if obj.__name__ == "Widget":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1413 continue
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1414 cls._widgets[obj.type] = obj
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1415 creator_name = u"add" + obj.__name__
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1416 if creator_name.endswith('Widget'):
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1417 creator_name = creator_name[:-6]
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1418 is_input = issubclass(obj, InputWidget)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1419 # FIXME: cf. above comment
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1420 # log.debug(u"Adding {creator_name} creator (is_input={is_input}))"
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1421 # .format(creator_name=creator_name, is_input=is_input))
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1422
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1423 assert not hasattr(cls, creator_name)
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1424 # XXX: we need to use creatorWrapper because we are in a loop
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1425 # and Python 2 doesn't support default values in kwargs
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1426 # when using args, *kwargs
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1427 setattr(cls, creator_name, cls.creatorWrapper(obj, is_input))
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1428
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1429 elif issubclass(obj, Container):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1430 if obj.__name__ == "Container":
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1431 continue
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1432 cls._containers[obj.type] = obj
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1433 except TypeError:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1434 pass
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1435
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1436 def __del__(self):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1437 self.doc.unlink()
952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1438
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1439 @property
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1440 def submit_id(self):
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1441 top_element = self.doc.documentElement
1530 94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1442 if not top_element.hasAttribute("submit"):
94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1443 # getAttribute never return None (it return empty string it attribute doesn't exists)
94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1444 # so we have to manage None here
94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1445 return None
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1446 value = top_element.getAttribute("submit")
1530 94cd4d242dc5 core (XMLUI): restorer submit_id: Goffi <goffi@goffi.org> parents: 1521 diff changeset	1447 return value
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1448
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1449 @submit_id.setter
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1450 def submit_id(self, value):
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1451 top_element = self.doc.documentElement
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1452 if value is None:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1453 try:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1454 top_element.removeAttribute("submit")
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1455 except NotFoundErr:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1456 pass
1531 51dec65ec62c core (xmlui): fixed submit_id returning None when its value is '' Goffi <goffi@goffi.org> parents: 1530 diff changeset	1457 else: # submit_id can be the empty string to bypass form restriction
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1458 top_element.setAttribute("submit", value)
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1459
798 8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1460 @property
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1461 def session_id(self):
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1462 top_element = self.doc.documentElement
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1463 value = top_element.getAttribute("session_id")
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1464 return value or None
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1465
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1466 @session_id.setter
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1467 def session_id(self, value):
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1468 top_element = self.doc.documentElement
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1469 if value is None:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1470 try:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1471 top_element.removeAttribute("session_id")
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1472 except NotFoundErr:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1473 pass
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1474 elif value:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1475 top_element.setAttribute("session_id", value)
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1476 else:
8f5479f8709a core: XMLUI now use @property for session_id and submit Goffi <goffi@goffi.org> parents: 796 diff changeset	1477 raise exceptions.DataError("session_id can't be empty")
760 73a0077f80cc backend, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	1478
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1479 def _createDialog(self, dialog_opt):
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1480 dialog_type = dialog_opt.setdefault(C.XMLUI_DATA_TYPE, C.XMLUI_DIALOG_MESSAGE)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1481 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1482 dialog_type in [C.XMLUI_DIALOG_CONFIRM, C.XMLUI_DIALOG_FILE]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1483 and self.submit_id is None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1484 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1485 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1486 _("Submit ID must be filled for this kind of dialog")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1487 )
1105 018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1488 top_element = TopElement(self)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1489 level = dialog_opt.get(C.XMLUI_DATA_LVL)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1490 dialog_elt = DialogElement(top_element, dialog_type, level)
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1491
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1492 try:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1493 MessageElement(dialog_elt, dialog_opt[C.XMLUI_DATA_MESS])
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1494 except KeyError:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1495 pass
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1496
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1497 try:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1498 ButtonsElement(dialog_elt, dialog_opt[C.XMLUI_DATA_BTNS_SET])
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1499 except KeyError:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1500 pass
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1501
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1502 try:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1503 FileElement(dialog_elt, dialog_opt[C.XMLUI_DATA_FILETYPE])
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1504 except KeyError:
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1505 pass
018bdd687747 core (XMLUI): Dialogs are now managemed in XMLUI: Goffi <goffi@goffi.org> parents: 1086 diff changeset	1506
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1507 def _createContainer(self, container, parent=None, **kwargs):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1508 """Create a container element
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1509
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1510 @param type: container type (cf init doc)
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1511 @parent: parent element or None
6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1512 """
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1513 if container not in self._containers:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1514 raise exceptions.DataError(_("Unknown container type [%s]") % container)
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1515 cls = self._containers[container]
804 5174657b3378 XMLUI (core, frontends): added JidWidget and DividerWidget + popup type + some bugfixes: Goffi <goffi@goffi.org> parents: 803 diff changeset	1516 new_container = cls(self, parent=parent, **kwargs)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1517 return new_container
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 104 diff changeset	1518
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1519 def changeContainer(self, container, **kwargs):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1520 """Change the current container
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1521
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1522 @param container: either container type (container it then created),
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1523 or an Container instance"""
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1524 if isinstance(container, basestring):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1525 self.current_container = self._createContainer(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1526 container,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1527 self.current_container.getParentContainer() or self.main_container,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1528 **kwargs
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1529 )
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1530 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1531 self.current_container = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1532 self.main_container if container is None else container
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1533 )
1475 7ac073d2e7e0 core(xmlui): removed useless parenthesis around assert Goffi <goffi@goffi.org> parents: 1473 diff changeset	1534 assert isinstance(self.current_container, Container)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1535 return self.current_container
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1536
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1537 def addWidget(self, type_, args, *kwargs):
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1538 """Convenience method to add an element"""
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1539 if "parent" not in kwargs:
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1540 kwargs["parent"] = self.current_container
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1541 try:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1542 cls = self._widgets[type_]
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1543 except KeyError:
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1544 raise exceptions.DataError(_("Invalid type [{type_}]").format(type_=type_))
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1545 return cls(self, args, *kwargs)
104 5458ac1380cc XMLUI: added tabs layout Goffi <goffi@goffi.org> parents: 103 diff changeset	1546
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1547 def toXml(self):
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1548 """return the XML representation of the panel"""
103 6be927a465ed XMLUI refactoring, step 1 Goffi <goffi@goffi.org> parents: 102 diff changeset	1549 return self.doc.toxml()
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1550
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1551
2762 5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1552 # we call this to have automatic discovery of containers and widgets
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1553 XMLUI._introspect()
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1554
5a51c7fc74a5 core (XMLUI): small optimisation: introspection is done once at module loading instead of on each XMLUI instantiation Goffi <goffi@goffi.org> parents: 2741 diff changeset	1555
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1556 # Some sugar for XMLUI dialogs
2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1557
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1558
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1559 def note(message, title="", level=C.XMLUI_DATA_LVL_INFO):
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1560 """sugar to easily create a Note Dialog
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1561
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1562 @param message(unicode): body of the note
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1563 @param title(unicode): title of the note
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1564 @param level(unicode): one of C.XMLUI_DATA_LVL_*
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1565 @return(XMLUI): instance of XMLUI
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1566 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1567 note_xmlui = XMLUI(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1568 C.XMLUI_DIALOG,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1569 dialog_opt={
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1570 C.XMLUI_DATA_TYPE: C.XMLUI_DIALOG_NOTE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1571 C.XMLUI_DATA_MESS: message,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1572 C.XMLUI_DATA_LVL: level,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1573 },
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1574 title=title,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1575 )
1142 2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1576 return note_xmlui
2f9f735334da core (XMLUI): sugar method "note" allow to easily create a XMLUI note dialog (more methods for other dialogs should follow) Goffi <goffi@goffi.org> parents: 1141 diff changeset	1577
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1578
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1579 def quickNote(host, client, message, title="", level=C.XMLUI_DATA_LVL_INFO):
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1580 """more sugar to do the whole note process"""
4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1581 note_ui = note(message, title, level)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1582 host.actionNew({"xmlui": note_ui.toXml()}, profile=client.profile)
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1583
4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1584
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1585 def deferredUI(host, xmlui, chained=False):
2044 4de202bdde05 core (xmlui): added a quickNote method to easily send notes Goffi <goffi@goffi.org> parents: 1934 diff changeset	1586 """create a deferred linked to XMLUI
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1587
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1588 @param xmlui(XMLUI): instance of the XMLUI
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1589 Must be an XMLUI that you can submit, with submit_id set to ''
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1590 @param chained(bool): True if the Deferred result must be returned to the frontend
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1591 useful when backend is in a series of dialogs with an ui
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1592 @return (D(data)): a deferred which fire the data
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1593 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1594 assert xmlui.submit_id == ""
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1595 xmlui_d = defer.Deferred()
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1596
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1597 def onSubmit(data, profile):
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1598 xmlui_d.callback(data)
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1599 return xmlui_d if chained else {}
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1600
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1601 xmlui.submit_id = host.registerCallback(onSubmit, with_data=True, one_shot=True)
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1602 return xmlui_d
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1603
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1604
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1605 def deferXMLUI(host, xmlui, action_extra=None, security_limit=C.NO_SECURITY_LIMIT,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1606 chained=False, profile=C.PROF_KEY_NONE):
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1607 """Create a deferred linked to XMLUI
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1608
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1609 @param xmlui(XMLUI): instance of the XMLUI
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1610 Must be an XMLUI that you can submit, with submit_id set to ''
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1611 @param profile: %(doc_profile)s
1601 e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1612 @param action_extra(None, dict): extra action to merge with xmlui
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1613 mainly used to add meta informations (see actionNew doc)
1599 e2ed8009e66e backend, bridge, frontends: actionNew has now a security_limit argument + added some docstring to explain data argument Goffi <goffi@goffi.org> parents: 1531 diff changeset	1614 @param security_limit: %(doc_security_limit)s
1692 0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1615 @param chained(bool): True if the Deferred result must be returned to the frontend
0fdd8fe34fbf core (xmlui): new deferredUI method allows to manage XMLUI with a Deferred insteand of manual submit_id handling: Goffi <goffi@goffi.org> parents: 1645 diff changeset	1616 useful when backend is in a series of dialogs with an ui
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1617 @return (data): a deferred which fire the data
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1618 """
1736 3739f7779f17 core (xmlui): fixed bad call of deferredUI in deferXMLUI Goffi <goffi@goffi.org> parents: 1735 diff changeset	1619 xmlui_d = deferredUI(host, xmlui, chained)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1620 action_data = {"xmlui": xmlui.toXml()}
1601 e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1621 if action_extra is not None:
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1622 action_data.update(action_extra)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1623 host.actionNew(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1624 action_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1625 security_limit=security_limit,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1626 keep_id=xmlui.submit_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1627 profile=profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1628 )
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1629 return xmlui_d
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1630
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1631
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1632 def deferDialog(host, message, title=u"Please confirm", type_=C.XMLUI_DIALOG_CONFIRM,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1633 options=None, action_extra=None, security_limit=C.NO_SECURITY_LIMIT, chained=False,
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1634 profile=C.PROF_KEY_NONE):
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1635 """Create a submitable dialog and manage it with a deferred
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1636
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1637 @param message(unicode): message to display
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1638 @param title(unicode): title of the dialog
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1639 @param type(unicode): dialog type (C.XMLUI_DIALOG_*)
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1640 @param options(None, dict): if not None, will be used to update (extend) dialog_opt
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1641 arguments of XMLUI
1601 e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1642 @param action_extra(None, dict): extra action to merge with xmlui
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1643 mainly used to add meta informations (see actionNew doc)
e0a152f2cf6d core (xmlui), plugin file: added action_extra param to deferXMLUI/deferDialog which is merged to the action data dict when actionNew is called Goffi <goffi@goffi.org> parents: 1599 diff changeset	1644 @param security_limit: %(doc_security_limit)s
1737 ad5da569ecf4 core (xmlui): fixed deferConfirm Goffi <goffi@goffi.org> parents: 1736 diff changeset	1645 @param chained(bool): True if the Deferred result must be returned to the frontend
ad5da569ecf4 core (xmlui): fixed deferConfirm Goffi <goffi@goffi.org> parents: 1736 diff changeset	1646 useful when backend is in a series of dialogs with an ui
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1647 @param profile: %(doc_profile)s
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1648 @return (dict): Deferred dict
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1649 """
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1650 assert profile is not None
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1651 dialog_opt = {"type": type_, "message": message}
1521 d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1652 if options is not None:
d2ab9c62ac3a core (xmlui): deferDialog can now manage additional dialog options through the "options" argument Goffi <goffi@goffi.org> parents: 1507 diff changeset	1653 dialog_opt.update(options)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1654 dialog = XMLUI(C.XMLUI_DIALOG, title=title, dialog_opt=dialog_opt, submit_id="")
1737 ad5da569ecf4 core (xmlui): fixed deferConfirm Goffi <goffi@goffi.org> parents: 1736 diff changeset	1655 return deferXMLUI(host, dialog, action_extra, security_limit, chained, profile)
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1656
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1657
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1658 def deferConfirm(args, *kwargs):
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1659 """call deferDialog and return a boolean instead of the whole data dict"""
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1660 d = deferDialog(args, *kwargs)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1661 d.addCallback(lambda data: C.bool(data["answer"]))
1504 a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1662 return d
a2e4b976e707 core (xmlui): added helper method to easily manage dialogs with a deferred Goffi <goffi@goffi.org> parents: 1500 diff changeset	1663
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1664
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1665 # Misc other funtions
9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 800 diff changeset	1666
2814 777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1667 def elementCopy(element):
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1668 """Make a copy of a domish.Element
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1669
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1670 The copy will have its own children list, so other elements
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1671 can be added as direct children without modifying orignal one.
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1672 Children are not deeply copied, so if an element is added to a child or grandchild,
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1673 it will also affect original element.
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1674 @param element(domish.Element): Element to clone
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1675 """
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1676 new_elt = domish.Element(
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1677 (element.uri, element.name),
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1678 defaultUri = element.defaultUri,
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1679 attribs = element.attributes,
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1680 localPrefixes = element.localPrefixes)
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1681 new_elt.parent = element.parent
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1682 new_elt.children = element.children[:]
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1683 return new_elt
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1684
777a582d9641 core (xml_tools): new elementCopy method to shallow copy a domish.Element Goffi <goffi@goffi.org> parents: 2782 diff changeset	1685
2782 b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1686 def isXHTMLField(field):
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1687 """Check if a data_form.Field is an XHTML one"""
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1688 return (field.fieldType is None and field.ext_type == u"xml" and
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1689 field.value.uri == C.NS_XHTML)
b17e6fa1e607 core (XMLUI): new XHTMLBox widget: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1690
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1691
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1692 class ElementParser(object):
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1693 """callable class to parse XML string into Element"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1694
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1695 # XXX: Found at http://stackoverflow.com/questions/2093400/how-to-create-twisted-words-xish-domish-element-entirely-from-raw-xml/2095942#2095942
1472 c005c212b538 xmlui: minor docstring fixes Goffi <goffi@goffi.org> parents: 1456 diff changeset	1696
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1697 def _escapeHTML(self, matchobj):
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1698 entity = matchobj.group(1)
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1699 if entity in XML_ENTITIES:
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1700 # we don't escape XML entities
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1701 return matchobj.group(0)
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1702 else:
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1703 try:
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1704 return unichr(htmlentitydefs.name2codepoint[entity])
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1705 except KeyError:
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1706 log.warning(u"removing unknown entity {}".format(entity))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1707 return u""
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1708
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1709 def __call__(self, raw_xml, force_spaces=False, namespace=None):
905 cad8e52bb2e6 tools: xml_tools.ElementParser do not replace '\n' and '\t' with ' ' by default souliane <souliane@mailoo.org> parents: 876 diff changeset	1710 """
1456 a13be5c22334 xml_tools: minor attribute renaming Goffi <goffi@goffi.org> parents: 1444 diff changeset	1711 @param raw_xml(unicode): the raw XML
2625 a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1712 @param force_spaces (bool): if True, replace occurrences of '\n' and '\t'
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1713 with ' '.
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1714 @param namespace(unicode, None): if set, use this namespace for the wrapping
a55a14c3cbf4 plugin XEP-0070: use a confirm dialog instead of a form + simplified a bit the code Goffi <goffi@goffi.org> parents: 2624 diff changeset	1715 element
905 cad8e52bb2e6 tools: xml_tools.ElementParser do not replace '\n' and '\t' with ' ' by default souliane <souliane@mailoo.org> parents: 876 diff changeset	1716 """
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1717 # we need to wrap element in case
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1718 # there is not a unique one on the top
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1719 if namespace is not None:
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1720 raw_xml = u"<div xmlns='{}'>{}</div>".format(namespace, raw_xml)
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1721 else:
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1722 raw_xml = u"<div>{}</div>".format(raw_xml)
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1723
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1724 # avoid ParserError on HTML escaped chars
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1725 raw_xml = html_entity_re.sub(self._escapeHTML, raw_xml)
7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1726
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1727 self.result = None
590 56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1728
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1729 def onStart(elem):
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1730 self.result = elem
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1731
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1732 def onEnd():
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1733 pass
590 56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1734
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1735 def onElement(elem):
56531f9e9ac7 Fix pep8 support in src/tools. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1736 self.result.addChild(elem)
289 0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1737
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1738 parser = domish.elementStream()
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1739 parser.DocumentStartEvent = onStart
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1740 parser.ElementEvent = onElement
0e54b1b0a8c8 xml_tools: added ElementParser for raw xml -> domish.Element conversion Goffi <goffi@goffi.org> parents: 228 diff changeset	1741 parser.DocumentEndEvent = onEnd
536 a31abb97310d core, plugins: fixed bad namespace in stanza creation Goffi <goffi@goffi.org> parents: 480 diff changeset	1742 tmp = domish.Element((None, "s"))
905 cad8e52bb2e6 tools: xml_tools.ElementParser do not replace '\n' and '\t' with ' ' by default souliane <souliane@mailoo.org> parents: 876 diff changeset	1743 if force_spaces:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1744 raw_xml = raw_xml.replace("\n", " ").replace("\t", " ")
1456 a13be5c22334 xml_tools: minor attribute renaming Goffi <goffi@goffi.org> parents: 1444 diff changeset	1745 tmp.addRawXml(raw_xml)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1746 parser.parse(tmp.toXml().encode("utf-8"))
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1747 top_elt = self.result.firstChildElement()
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1748 # we now can check if there was a unique element on the top
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1749 # and remove our wrapping <div/> is this was the case
1818 7e6342de71fb core (xml_tools): unescape HTML sequences to avoid parsing error in ElementParser Goffi <goffi@goffi.org> parents: 1817 diff changeset	1750 if len(top_elt.children) == 1 and domish.IElement.providedBy(top_elt.children[0]):
1817 7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1751 top_elt = top_elt.firstChildElement()
7ef0f5f90862 core (xml_tools), plugin XEP-0277: ElementParser element now manage automatically the wrapping with <div/> element when needed + fixed content_xhtml/title_xhtml in XEP-0277 Goffi <goffi@goffi.org> parents: 1792 diff changeset	1752 return top_elt
1732 cf11cfc87ef9 xml_tools, plugin XEP-0071, XEP-0277: add method expandNewLinesToXHTML: souliane <souliane@mailoo.org> parents: 1692 diff changeset	1753
cf11cfc87ef9 xml_tools, plugin XEP-0071, XEP-0277: add method expandNewLinesToXHTML: souliane <souliane@mailoo.org> parents: 1692 diff changeset	1754
1740 681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1755 # FIXME: this method is duplicated from frontends.tools.xmlui.getText
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1756 def getText(node):
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1757 """Get child text nodes of a domish.Element.
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1758
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1759 @param node (domish.Element)
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1760 @return: joined unicode text of all nodes
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1761 """
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1762 data = []
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1763 for child in node.childNodes:
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1764 if child.nodeType == child.TEXT_NODE:
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1765 data.append(child.wholeText)
681fe91abcc0 memory (params): parameter jids_list values are specified with <jid>...</jid> souliane <souliane@mailoo.org> parents: 1737 diff changeset	1766 return u"".join(data)
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1767
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1768
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1769 def findAll(elt, namespaces=None, names=None):
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1770 """Find child element at any depth matching criteria
c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1771
c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1772 @param elt(domish.Element): top parent of the elements to find
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1773 @param names(iterable[unicode], basestring, None): names to match
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1774 None to accept every names
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1775 @param namespace(iterable[unicode], basestring, None): URIs to match
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1776 None to accept every namespaces
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1777 @return ((G)domish.Element): found elements
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1778 """
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1779 if isinstance(namespaces, basestring):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1780 namespaces = tuple((namespaces,))
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1781 if isinstance(names, basestring):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1782 names = tuple((names,))
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1783
c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1784 for child in elt.elements():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1785 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1786 domish.IElement.providedBy(child)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1787 and (not names or child.name in names)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1788 and (not namespaces or child.uri in namespaces)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1789 ):
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1790 yield child
2108 70f23bc7859b core (xml_tools): fixed findAll Goffi <goffi@goffi.org> parents: 2071 diff changeset	1791 for found in findAll(child, namespaces, names):
1819 c271087d2020 core (xml_tools): added a method to find all elements corresponding to criteria Goffi <goffi@goffi.org> parents: 1818 diff changeset	1792 yield found

Mercurial > libervia-backend

annotate sat/tools/xml_tools.py @ 2923:1fd3ecb3351a