libervia-backend: src/tools/xml

comparison src/tools/xml_tools.py @ 1472:c005c212b538

xmlui: minor docstring fixes

author	Goffi <goffi@goffi.org>
date	Tue, 18 Aug 2015 10:04:47 +0200
parents	a13be5c22334
children	675e0e9f1653

comparison

equal deleted inserted replaced

-:934e402c90bf
+:c005c212b538
 def _dataFormField2XMLUIData(field, read_only=False):
 """Get data needed to create an XMLUI's Widget from Wokkel's data_form's Field.
 The attribute field can be modified (if it's fixed and it has no value).
 @param field (data_form.Field): a field with attributes "value", "fieldType", "label" and "var"
 @param read_only (bool): if True and it makes sense, create a read only input widget
 @return: a tuple (widget_type, widget_args, widget_kwargs)
 """
 widget_args = [field.value]
 def tupleList2dataForm(values):
 """Convert a list of tuples (name, value) to a wokkel submit data form.
 @param values (list): list of tuples
 @return: data_form.Form
 """
 form = data_form.Form('submit')
 for value in values:
 field = data_form.Field(var=value[0], value=value[1])
 """
 @param parent: AdvancedListContainer instance
 @param name: name of the container
 @param label: label to be displayed in columns
 @param description: long descriptive text
 """
 assert(isinstance(parent, AdvancedListContainer))
 super(HeaderElement, self).__init__(parent.xmlui, parent)
 if name:
 self.elem.setAttribute('name', name)
 """ And Element which contains other ones and has a layout """
 type = None
 def __init__(self, xmlui, parent=None):
 """Create a container element
 @param xmlui: XMLUI instance
 @parent: parent element or None
 """
 self.elem = xmlui.doc.createElement('container')
 super(Container, self).__init__(xmlui, parent)
 self.elem.setAttribute('type', self.type)
 def getParentContainer(self):
 """ Return first parent container
 @return: parent container or None
 """
 current = self.parent
 while(not isinstance(current, (Container)) and
 current is not None):
 current = current.parent
 new_container = container(self.xmlui, tab_elt)
 self.xmlui.changeContainer(new_container)
 def end(self):
 """ Called when we have finished tabs
 change current container to first container parent
 """
 parent_container = self.getParentContainer()
 self.xmlui.changeContainer(parent_container)
 class AdvancedListContainer(Container):
+"""A list which can contain other widgets, headers, etc"""
 type = "advanced_list"
 def __init__(self, xmlui, callback_id=None, name=None, headers=None, items=None, columns=None, selectable='no', auto_index=False, parent=None):
 """Create an advanced list
 @param headers: optional headers information
 @param callback_id: id of the method to call when selection is done
 @param items: list of widgets to add (just the first row)
 @param columns: number of columns in this table, or None to autodetect
 @param selectable: one of:
 for item in items:
 self.append(item)
 def setRowIndex(self, idx):
 """ Set index for next row
 index are returned when a row is selected, in data's "index" key
 @param idx: string index to associate to the next row
 """
 self.next_row_idx = idx
 def append(self, child):
 if isinstance(child, RowElement):
 self.current_row.append(child)
 self._item_idx += 1
 def end(self):
 """ Called when we have finished list
 change current container to first container parent
 """
 if self._item_idx % self._columns != 0:
 raise exceptions.DataError(_("Incorrect number of items in list"))
 parent_container = self.getParentContainer()
 self.xmlui.changeContainer(parent_container)
 class Widget(Element):
 type = None
 def __init__(self, xmlui, name=None, parent=None):
 """Create an element
 @param xmlui: XMLUI instance
 @param name: name of the element or None
 @param parent: parent element or None
 """
 self.elem = xmlui.doc.createElement('widget')
 def setInternalCallback(self, callback, fields, data_elts=None):
 """Set an internal UI callback when the widget value is changed.
 The internal callbacks are NO callback ids, they are strings from
 a predefined set of actions that are running in the scope of XMLUI.
 @param callback (string): a value from:
 - 'copy': process the widgets given in 'fields' two by two, by
 copying the values of one widget to the other. Target widgets
 of type List do not accept the empty value.
 - 'move': same than copy but moves the values if the source widget
 value_elt.appendChild(text)
 self.elem.appendChild(value_elt)
 class LabelWidget(Widget):
-"""Used for one line blob of text,
+"""One line blob of text
-most of time to display the desciption or name of the next widget
+used most of time to display the desciption or name of the next widget
 """
 type = 'label'
 def __init__(self, xmlui, label, name=None, parent=None):
 super(LabelWidget, self).__init__(xmlui, name, parent)
 class DividerWidget(Widget):
 type = 'divider'
 def __init__(self, xmlui, style='line', name=None, parent=None):
 """ Create a divider
 @param xmlui: XMLUI instance
 @param style: one of:
 - line: a simple line
 - dot: a line of dots
 - dash: a line of dashes
 ### Inputs ###
 class InputWidget(Widget):
-"""Input widget are widget which can accept user inputs,
+"""Widget which can accept user inputs
 used mainly in forms
 """
 def __init__(self, xmlui, name=None, parent=None, read_only=False):
 super(InputWidget, self).__init__(xmlui, name, parent)
 if read_only:
 class ButtonWidget(Widget):
 type = 'button'
 def __init__(self, xmlui, callback_id, value=None, fields_back=None, name=None, parent=None):
 """Add a button
 @param callback_id: callback which will be called if button is pressed
 @param value: label of the button
 @fields_back: list of names of field to give back when pushing the button
 @param name: name
 @param parent: parent container
 except KeyError:
 pass
 def _createContainer(self, container, parent=None, **kwargs):
 """Create a container element
 @param type: container type (cf init doc)
 @parent: parent element or None
 """
 if container not in self._containers:
 raise exceptions.DataError(_("Unknown container type [%s]") % container)
 new_container = cls(self, parent=parent, **kwargs)
 return new_container
 def changeContainer(self, container, **kwargs):
 """Change the current container
 @param container: either container type (container it then created),
 or an Container instance"""
 if isinstance(container, basestring):
 self.current_container = self._createContainer(container, self.current_container.getParentContainer() or self.main_container, **kwargs)
 else:
 # Misc other funtions
 class ElementParser(object):
 """callable class to parse XML string into Element
 Found at http://stackoverflow.com/questions/2093400/how-to-create-twisted-words-xish-domish-element-entirely-from-raw-xml/2095942#2095942
-(c) Karl Anderson"""
+(c) Karl Anderson
+"""
 def __call__(self, raw_xml, force_spaces=False):
 """
 @param raw_xml(unicode): the raw XML
 @param force_spaces: if True, replace occurrences of '\n' and '\t' with ' '.

Mercurial > libervia-backend

comparison src/tools/xml_tools.py @ 1472:c005c212b538