Mercurial > libervia-backend
annotate src/tools/common/template_xmlui.py @ 2455:7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Mon, 04 Dec 2017 00:45:07 +0100 |
| parents | 49884c579266 |
| children | 0046283a285d |
| rev | line source |
|---|---|
| 2362 | 1 #!/usr/bin/env python2 |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SAT: a jabber client | |
|
2414
8b37a62336c3
misc: date update (yes it's a bit late :p )
Goffi <goffi@goffi.org>
parents:
2400
diff
changeset
|
5 # Copyright (C) 2009-2017 Jérôme Poisson (goffi@goffi.org) |
| 2362 | 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 |
|
2455
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
56 @property |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
57 def labels(self): |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
58 # helper property, there is not label for ValueWidget |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
59 # but using labels make rendering more easy (one single method to call) |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
60 # values are actually returned |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
61 return [self.value] |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
62 |
| 2362 | 63 |
| 64 class InputWidget(ValueWidget): | |
| 65 | |
| 66 def __init__(self, xmlui_parent, value, read_only=False): | |
| 67 super(InputWidget, self).__init__(xmlui_parent, value) | |
| 68 self.read_only = read_only | |
| 69 | |
| 70 | |
| 71 class OptionsWidget(Widget): | |
| 72 | |
| 73 def __init__(self, xmlui_parent, options, selected, style): | |
| 74 super(OptionsWidget, self).__init__(xmlui_parent) | |
| 75 self.options = options | |
| 76 self.selected = selected | |
| 77 self.style = style | |
| 78 | |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
79 @property |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
80 def values(self): |
|
2455
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
81 for value, label in self.items: |
|
7b02372f8734
template (xmlui): added labels property in ValueWidget (actually return values) and values property in OptionsWidget
Goffi <goffi@goffi.org>
parents:
2435
diff
changeset
|
82 yield value |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
83 |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
84 @property |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
85 def labels(self): |
|
2400
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
86 """return only labels from self.items""" |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
87 for value, label in self.items: |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
88 yield label |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
89 |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
90 @property |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
91 def items(self): |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
92 """return suitable items, according to style""" |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
93 no_select = self.no_select |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
94 for value,label in self.options: |
|
2400
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
95 if no_select or value in self.selected: |
|
8253ea069781
template(XMLUI): added items property to ListWidget:
Goffi <goffi@goffi.org>
parents:
2397
diff
changeset
|
96 yield value,label |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
97 |
|
2397
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
98 @property |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
99 def inline(self): |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
100 return u'inline' in self.style |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
101 |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
102 @property |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
103 def no_select(self): |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
104 return u'noselect' in self.style |
|
7fff98d64ab5
core (XMLUI), template(XMLUI): added flags to ListWidget:
Goffi <goffi@goffi.org>
parents:
2379
diff
changeset
|
105 |
| 2362 | 106 |
| 107 class EmptyWidget(xmlui.EmptyWidget, Widget): | |
| 108 | |
| 109 def __init__(self, _xmlui_parent): | |
| 110 Widget.__init__(self) | |
| 111 | |
| 112 | |
| 113 class TextWidget(xmlui.TextWidget, ValueWidget): | |
| 114 type = u"text" | |
| 115 | |
| 116 | |
| 117 class LabelWidget(xmlui.LabelWidget, ValueWidget): | |
| 118 type = u"label" | |
| 119 | |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
120 @property |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
121 def for_name(self): |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
122 try: |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
123 return self._xmlui_for_name |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
124 except AttributeError: |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
125 return None |
| 2362 | 126 |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
127 |
|
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
128 class StringWidget(xmlui.StringWidget, InputWidget): |
| 2362 | 129 type = u"string" |
| 130 | |
| 131 | |
|
2435
49884c579266
template (XMLUI): added JidInputWidget
Goffi <goffi@goffi.org>
parents:
2419
diff
changeset
|
132 class JidInputWidget(xmlui.JidInputWidget, StringWidget): |
|
49884c579266
template (XMLUI): added JidInputWidget
Goffi <goffi@goffi.org>
parents:
2419
diff
changeset
|
133 type = u"jid" |
|
49884c579266
template (XMLUI): added JidInputWidget
Goffi <goffi@goffi.org>
parents:
2419
diff
changeset
|
134 |
|
49884c579266
template (XMLUI): added JidInputWidget
Goffi <goffi@goffi.org>
parents:
2419
diff
changeset
|
135 |
|
2379
42a54cbc1872
template (xmlui): new properties + inheritance fix:
Goffi <goffi@goffi.org>
parents:
2367
diff
changeset
|
136 class TextBoxWidget(xmlui.TextWidget, InputWidget): |
| 2362 | 137 type = u"textbox" |
| 138 | |
| 139 | |
| 140 class ListWidget(xmlui.ListWidget, OptionsWidget): | |
| 141 type = u"list" | |
| 142 | |
| 143 | |
| 144 ## Containers ## | |
| 145 | |
| 146 class Container(object): | |
| 147 category = u'container' | |
| 148 type = None | |
| 149 | |
| 150 def __init__(self, xmlui_parent): | |
| 151 self.xmlui_parent = xmlui_parent | |
| 152 self.children = [] | |
| 153 | |
| 154 def __iter__(self): | |
| 155 return iter(self.children) | |
| 156 | |
| 157 def _xmluiAppend(self, widget): | |
| 158 self.children.append(widget) | |
| 159 | |
|
2419
c38c54c47e16
frontends (xmlui): added an attribute to ignore some widgets (and their label) in create
Goffi <goffi@goffi.org>
parents:
2414
diff
changeset
|
160 def _xmluiRemove(self, widget): |
|
c38c54c47e16
frontends (xmlui): added an attribute to ignore some widgets (and their label) in create
Goffi <goffi@goffi.org>
parents:
2414
diff
changeset
|
161 self.children.remove(widget) |
|
c38c54c47e16
frontends (xmlui): added an attribute to ignore some widgets (and their label) in create
Goffi <goffi@goffi.org>
parents:
2414
diff
changeset
|
162 |
| 2362 | 163 |
| 164 class VerticalContainer(xmlui.VerticalContainer, Container): | |
| 165 type = u'vertical' | |
| 166 | |
| 167 | |
| 168 class PairsContainer(xmlui.PairsContainer, Container): | |
| 169 type = u'pairs' | |
| 170 | |
| 171 | |
| 172 class LabelContainer(xmlui.PairsContainer, Container): | |
| 173 type = u'label' | |
| 174 | |
| 175 | |
| 176 ## Factory ## | |
| 177 | |
| 178 class WidgetFactory(object): | |
| 179 | |
| 180 def __getattr__(self, attr): | |
| 181 if attr.startswith("create"): | |
| 182 cls = globals()[attr[6:]] | |
| 183 return cls | |
| 184 | |
| 185 ## Core ## | |
| 186 | |
| 187 | |
| 188 class XMLUIPanel(xmlui.XMLUIPanel): | |
| 189 widget_factory = WidgetFactory() | |
| 190 | |
| 191 def show(self, *args, **kwargs): | |
| 192 raise NotImplementedError | |
| 193 | |
| 194 | |
| 195 class XMLUIDialog(xmlui.XMLUIDialog): | |
| 196 dialog_factory = WidgetFactory() | |
| 197 | |
| 198 def __init__(*args, **kwargs): | |
| 199 raise NotImplementedError | |
| 200 | |
| 201 | |
| 202 xmlui.registerClass(xmlui.CLASS_PANEL, XMLUIPanel) | |
| 203 xmlui.registerClass(xmlui.CLASS_DIALOG, XMLUIDialog) | |
| 204 create = xmlui.create |