Mercurial > libervia-backend
annotate src/tools/common/template_xmlui.py @ 2379:42a54cbc1872
template (xmlui): new properties + inheritance fix:
- "values" property in OptionsWidget return selected values.
- "labels" property in OptionsWidget return list of labels
- "for_name" property in LabelWidget return name of associated widget if set, else None
- fixed inheritance for StringWidget and TextBoxWidget
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 16 Oct 2017 07:28:36 +0200 |
| parents | 9878635586f3 |
| children | 7fff98d64ab5 |
| rev | line source |
|---|---|
| 2362 | 1 #!/usr/bin/env python2 |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SAT: a jabber client | |
| 5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) | |
| 6 | |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
| 20 """ template XMLUI parsing | |
| 21 | |
| 22 XMLUI classes from this modules can then be iterated to create the template | |
| 23 """ | |
| 24 | |
| 25 from sat.core.log import getLogger | |
| 26 log = getLogger(__name__) | |
| 27 from sat_frontends.tools import xmlui | |
| 28 | |
| 29 | |
| 30 ## Widgets ## | |
| 31 | |
| 32 class Widget(object): | |
| 33 category = u'widget' | |
| 34 type = None | |
| 35 enabled = True | |
| 36 read_only = True | |
| 37 | |
| 38 def __init__(self, xmlui_parent): | |
| 39 self.xmlui_parent = xmlui_parent | |
| 40 | |
| 41 @property | |
| 42 def name(self): | |
| 43 return self._xmlui_name | |
| 44 | |
| 45 | |
| 46 class ValueWidget(Widget): | |
| 47 | |
| 48 def __init__(self, xmlui_parent, value): | |
| 49 super(ValueWidget, self).__init__(xmlui_parent) | |
| 50 self.value = value | |
| 51 | |
|
2367
9878635586f3
template (xmlui): added values property to be able to use always values even when there is only one value
Goffi <goffi@goffi.org>
parents:
2362
diff
changeset
|
52 @property |
|
9878635586f3
template (xmlui): added values property to be able to use always values even when there is only one value
Goffi <goffi@goffi.org>
parents:
2362
diff
changeset
|
53 def values(self): |
|
9878635586f3
template (xmlui): added values property to be able to use always values even when there is only one value
Goffi <goffi@goffi.org>
parents:
2362
diff
changeset
|
54 return [self.value] |
|
9878635586f3
template (xmlui): added values property to be able to use always values even when there is only one value
Goffi <goffi@goffi.org>
parents:
2362
diff
changeset
|
55 |
| 2362 | 56 |
| 57 class InputWidget(ValueWidget): | |
| 58 | |
| 59 def __init__(self, xmlui_parent, value, read_only=False): | |
| 60 super(InputWidget, self).__init__(xmlui_parent, value) | |
| 61 self.read_only = read_only | |
| 62 | |
| 63 | |
| 64 class OptionsWidget(Widget): | |
| 65 | |
| 66 def __init__(self, xmlui_parent, options, selected, style): | |
| 67 super(OptionsWidget, self).__init__(xmlui_parent) | |
| 68 self.options = options | |
| 69 self.selected = selected | |
| 70 self.style = style | |
| 71 | |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
72 @property |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
73 def values(self): |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
74 return self.selected |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
75 |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
76 @property |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
77 def labels(self): |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
78 ret = [] |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
79 for value,label in self.options: |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
80 if value in self.selected: |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
81 ret.append(label) |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
82 return ret |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
83 |
| 2362 | 84 |
| 85 class EmptyWidget(xmlui.EmptyWidget, Widget): | |
| 86 | |
| 87 def __init__(self, _xmlui_parent): | |
| 88 Widget.__init__(self) | |
| 89 | |
| 90 | |
| 91 class TextWidget(xmlui.TextWidget, ValueWidget): | |
| 92 type = u"text" | |
| 93 | |
| 94 | |
| 95 class LabelWidget(xmlui.LabelWidget, ValueWidget): | |
| 96 type = u"label" | |
| 97 | |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
98 @property |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
99 def for_name(self): |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
100 try: |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
101 return self._xmlui_for_name |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
102 except AttributeError: |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
103 return None |
| 2362 | 104 |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
105 |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
106 class StringWidget(xmlui.StringWidget, InputWidget): |
| 2362 | 107 type = u"string" |
| 108 | |
| 109 | |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
110 class TextBoxWidget(xmlui.TextWidget, InputWidget): |
| 2362 | 111 type = u"textbox" |
| 112 | |
| 113 | |
| 114 class ListWidget(xmlui.ListWidget, OptionsWidget): | |
| 115 type = u"list" | |
| 116 | |
| 117 | |
| 118 ## Containers ## | |
| 119 | |
| 120 class Container(object): | |
| 121 category = u'container' | |
| 122 type = None | |
| 123 | |
| 124 def __init__(self, xmlui_parent): | |
| 125 self.xmlui_parent = xmlui_parent | |
| 126 self.children = [] | |
| 127 | |
| 128 def __iter__(self): | |
| 129 return iter(self.children) | |
| 130 | |
| 131 def _xmluiAppend(self, widget): | |
| 132 self.children.append(widget) | |
| 133 | |
| 134 | |
| 135 class VerticalContainer(xmlui.VerticalContainer, Container): | |
| 136 type = u'vertical' | |
| 137 | |
| 138 | |
| 139 class PairsContainer(xmlui.PairsContainer, Container): | |
| 140 type = u'pairs' | |
| 141 | |
| 142 | |
| 143 class LabelContainer(xmlui.PairsContainer, Container): | |
| 144 type = u'label' | |
| 145 | |
| 146 | |
| 147 ## Factory ## | |
| 148 | |
| 149 class WidgetFactory(object): | |
| 150 | |
| 151 def __getattr__(self, attr): | |
| 152 if attr.startswith("create"): | |
| 153 cls = globals()[attr[6:]] | |
| 154 return cls | |
| 155 | |
| 156 ## Core ## | |
| 157 | |
| 158 | |
| 159 class XMLUIPanel(xmlui.XMLUIPanel): | |
| 160 widget_factory = WidgetFactory() | |
| 161 | |
| 162 def show(self, *args, **kwargs): | |
| 163 raise NotImplementedError | |
| 164 | |
| 165 | |
| 166 class XMLUIDialog(xmlui.XMLUIDialog): | |
| 167 dialog_factory = WidgetFactory() | |
| 168 | |
| 169 def __init__(*args, **kwargs): | |
| 170 raise NotImplementedError | |
| 171 | |
| 172 | |
| 173 xmlui.registerClass(xmlui.CLASS_PANEL, XMLUIPanel) | |
| 174 xmlui.registerClass(xmlui.CLASS_DIALOG, XMLUIDialog) | |
| 175 create = xmlui.create |