root/branches/gajim_0.11/src/dataforms_widget.py

Revision 7677, 17.0 kB (checked in by jim++, 21 months ago)

Pyflakes spoted undefined name, 80 chars
Line 
1##      dataforms.py
2##
3## Copyright (C) 2003-2006 Yann Le Boulanger <asterix@lagaule.org>
4## Copyright (C) 2005-2006 Nikos Kouremenos <nkour@jabber.org>
5## Copyright (C) 2005 Dimitur Kirov <dkirov@gmail.com>
6## Copyright (C) 2003-2005 Vincent Hanquez <tab@snarc.org>
7##
8## This program is free software; you can redistribute it and/or modify
9## it under the terms of the GNU General Public License as published
10## by the Free Software Foundation; version 2 only.
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 General Public License for more details.
16##
17""" This module contains widget that can display data form (JEP-0004).
18Words single and multiple refers here to types of data forms:
19single means these with one record of data (without <recorded/> element),
20multiple - these which may contain more data (with <recorded/> element)."""
21
22import gtk
23
24import gtkgui_helpers
25
26import common.dataforms as dataforms
27
28import itertools
29
30class DataFormWidget(gtk.Alignment, object):
31# "public" interface
32        """ Data Form widget. Use like any other widget. """
33        def __init__(self, dataformnode=None):
34                """ Create a widget. """
35                gtk.Alignment.__init__(self, xscale=1.0, yscale=1.0)
36
37                self._data_form = None
38
39                self.xml=gtkgui_helpers.get_glade('data_form_window.glade', 'data_form_vbox')
40                self.xml.signal_autoconnect(self)
41                for name in ('instructions_label', 'instructions_hseparator',
42                                'single_form_viewport', 'data_form_types_notebook',
43                                'single_form_scrolledwindow', 'multiple_form_hbox',
44                                'records_treeview', 'add_button', 'remove_button',
45                                'edit_button', 'up_button', 'down_button', 'clear_button'):
46                        self.__dict__[name] = self.xml.get_widget(name)
47
48                self.add(self.xml.get_widget('data_form_vbox'))
49
50                if dataformnode is not None:
51                        self.set_data_form(dataformnode)
52
53                selection = self.records_treeview.get_selection()
54                selection.connect('changed', self.on_records_selection_changed)
55                selection.set_mode(gtk.SELECTION_MULTIPLE)
56
57        def set_data_form(self, dataform):
58                """ Set the data form (xmpp.DataForm) displayed in widget. """
59                assert isinstance(dataform, dataforms.DataForm)
60
61                self.del_data_form()
62                self._data_form = dataform
63                if isinstance(dataform, dataforms.SimpleDataForm):
64                        self.build_single_data_form()
65                else:
66                        self.build_multiple_data_form()
67
68                # create appropriate description for instructions field if there isn't any
69                if dataform.instructions=='':
70                        self.instructions_label.set_no_show_all(True)
71                        self.instructions_label.hide()
72                else:
73                        self.instructions_label.set_text(dataform.instructions)
74
75        def get_data_form(self):
76                """ Data form displayed in the widget or None if no form. """
77                return self._data_form
78
79        def del_data_form(self):
80                self.clean_data_form()
81                self._data_form = None
82
83        data_form = property(get_data_form, set_data_form, del_data_form,
84                "Data form presented in a widget")
85
86        def get_title(self):
87                """ Get the title of data form, as a unicode object. If no
88                title or no form, returns u''. Useful for setting window title. """
89                if self._data_form is not None:
90                        if self._data_form.title is not None:
91                                return self._data_form.title
92                return u''
93
94        title = property(get_title, None, None, "Data form title")
95
96        def show(self):
97                """ Treat 'us' as one widget. """
98                self.show_all()
99
100# "private" methods
101
102# we have actually two different kinds of data forms: one is a simple form to fill,
103# second is a table with several records;
104
105        def empty_method(self):
106                pass
107
108        def clean_data_form(self):
109                '''Remove data about existing form. This metod is empty, because
110                it is rewritten by build_*_data_form, according to type of form
111                which is actually displayed.'''
112                pass
113
114        def build_single_data_form(self):
115                '''Invoked when new single form is to be created.'''
116                assert isinstance(self._data_form, dataforms.SimpleDataForm)
117
118                self.clean_data_form()
119
120                self.singleform = SingleForm(self._data_form)
121                self.singleform.show()
122                self.single_form_viewport.add(self.singleform)
123                self.data_form_types_notebook.set_current_page(
124                        self.data_form_types_notebook.page_num(
125                                self.single_form_scrolledwindow))
126
127                self.clean_data_form = self.clean_single_data_form
128
129        def clean_single_data_form(self):
130                '''(Called as clean_data_form, read the docs of clean_data_form()).
131                Remove form from widget.'''
132                self.singleform.destroy()
133                self.clean_data_form = self.empty_method        # we won't call it twice
134                del self.singleform
135
136        def build_multiple_data_form(self):
137                '''Invoked when new multiple form is to be created.'''
138                assert isinstance(self._data_form, dataforms.MultipleDataForm)
139
140                self.clean_data_form()
141
142                # creating model for form...
143                fieldtypes = []
144                for field in self._data_form.recorded.iter_fields():
145                        # note: we store also text-private and hidden fields,
146                        # we just do not display them.
147                        # TODO: boolean fields
148                        #elif field.type=='boolean': fieldtypes.append(bool)
149                        fieldtypes.append(str)
150
151                self.multiplemodel = gtk.ListStore(*fieldtypes)
152
153                # moving all data to model
154                for item in self._data_form.iter_records():
155                        # TODO: probably wrong... (.value[s]?, fields not in the same order?)
156                        # not checking multiple-item forms...
157                        self.multiplemodel.append([field.value for field in item.iter_fields()])
158
159                # constructing columns...
160                for field, counter in zip(self._data_form.iter_fields(), itertools.count()):
161                        print repr(field), repr(counter)
162                        self.records_treeview.append_column(
163                                gtk.TreeViewColumn(field.label, gtk.CellRendererText(),
164                                        text=counter))
165
166                self.records_treeview.set_model(self.multiplemodel)
167                self.records_treeview.show_all()
168
169                self.data_form_types_notebook.set_current_page(
170                        self.data_form_types_notebook.page_num(
171                                self.multiple_form_hbox))
172
173                self.clean_data_form = self.clean_multiple_data_form
174
175                # refresh list look
176                self.refresh_multiple_buttons()
177
178        def clean_multiple_data_form(self):
179                '''(Called as clean_data_form, read the docs of clean_data_form()).
180                Remove form from widget.'''
181                self.clean_data_form = self.empty_method        # we won't call it twice
182                del self.multiplemodel
183
184        def refresh_multiple_buttons(self):
185                ''' Checks for treeview state and makes control buttons sensitive.'''
186                selection = self.records_treeview.get_selection()
187                model = self.records_treeview.get_model()
188                count = selection.count_selected_rows()
189                if count==0:
190                        self.remove_button.set_sensitive(False)
191                        self.edit_button.set_sensitive(False)
192                        self.up_button.set_sensitive(False)
193                        self.down_button.set_sensitive(False)
194                elif count==1:
195                        self.remove_button.set_sensitive(True)
196                        self.edit_button.set_sensitive(True)
197                        _, (path,) = selection.get_selected_rows()
198                        iter = model.get_iter(path)
199                        if model.iter_next(iter) is None:
200                                self.up_button.set_sensitive(True)
201                                self.down_button.set_sensitive(False)
202                        elif path==(0,):
203                                self.up_button.set_sensitive(False)
204                                self.down_button.set_sensitive(True)
205                        else:
206                                self.up_button.set_sensitive(True)
207                                self.down_button.set_sensitive(True)
208                else:
209                        self.remove_button.set_sensitive(True)
210                        self.edit_button.set_sensitive(True)
211                        self.up_button.set_sensitive(False)
212                        self.down_button.set_sensitive(False)
213
214                if len(model)==0:
215                        self.clear_button.set_sensitive(False)
216                else:
217                        self.clear_button.set_sensitive(True)
218
219        def on_clear_button_clicked(self, widget):
220                self.records_treeview.get_model().clear()
221
222        def on_remove_button_clicked(self, widget):
223                selection = self.records_treeview.get_selection()
224                model, rowrefs = selection.get_selected_rows()  # rowref is a list of paths
225                for i in xrange(len(rowrefs)):
226                        rowrefs[i] = gtk.TreeRowReference(model, rowrefs[i])
227                # rowref is a list of row references; need to convert because we will modify the model,
228                # paths would change
229                for rowref in rowrefs:
230                        del model[rowref.get_path()]
231       
232        def on_up_button_clicked(self, widget):
233                selection = self.records_treeview.get_selection()
234                model, (path,) = selection.get_selected_rows()
235                iter = model.get_iter(path)
236                previter = model.get_iter((path[0]-1,)) # constructing path for previous iter
237                model.swap(iter, previter)
238
239                self.refresh_multiple_buttons()
240
241        def on_down_button_clicked(self, widget):
242                selection = self.records_treeview.get_selection()
243                model, (path,) = selection.get_selected_rows()
244                iter = model.get_iter(path)
245                nextiter = model.iter_next(iter)
246                model.swap(iter, nextiter)
247
248                self.refresh_multiple_buttons()
249
250        def on_records_selection_changed(self, widget):
251                self.refresh_multiple_buttons()
252
253class SingleForm(gtk.Table, object):
254        """ Widget that represent DATAFORM_SINGLE mode form. Because this is used
255        not only to display single forms, but to form input windows of multiple-type
256        forms, it is in another class."""
257        def __init__(self, dataform):
258                assert isinstance(dataform, dataforms.SimpleDataForm)
259
260                gtk.Table.__init__(self)
261                self.set_col_spacings(12)
262                self.set_row_spacings(6)
263
264                self.tooltips = gtk.Tooltips()
265
266                def decorate_with_tooltip(widget, field):
267                        """ Adds a tooltip containing field's description to a widget.
268                        Creates EventBox if widget doesn't have its own gdk window.
269                        Returns decorated widget. """
270                        if field.description!='':
271                                if widget.flags()&gtk.NO_WINDOW:
272                                        evbox = gtk.EventBox()
273                                        evbox.add(widget)
274                                        widget = evbox
275                                self.tooltips.set_tip(widget, field.description)
276                        return widget
277
278                self._data_form = dataform
279
280                # building widget
281                linecounter = 0
282
283                # is the form changeable?
284                readwrite = dataform.type != 'result'
285
286                # for each field...
287                for field in self._data_form.iter_fields():
288                        if field.type=='hidden': continue
289
290                        commonlabel = True
291                        commonlabelcenter = False
292                        commonwidget = True
293                        widget = None
294
295                        if field.type=='boolean':
296                                commonlabelcenter = True
297                                widget = gtk.CheckButton()
298                                widget.connect('toggled', self.on_boolean_checkbutton_toggled, field)
299                                widget.set_active(field.value)
300
301                        elif field.type=='fixed':
302                                leftattach = 1
303                                rightattach = 2
304                                if field.label is None:
305                                        commonlabel = False
306                                        leftattach = 0
307                               
308                                commonwidget=False
309                                widget = gtk.Label(field.value)
310                                widget.set_line_wrap(True)
311                                self.attach(widget, leftattach, rightattach, linecounter, linecounter+1,
312                                        xoptions=gtk.FILL, yoptions=gtk.FILL)
313
314                        elif field.type == 'list-single':
315                                # TODO: When more than few choices, make a list
316                                # TODO: Think of moving that to another function (it could be used
317                                # TODO: in stage2 of adhoc commands too).
318                                # TODO: What if we have radio buttons and non-required field?
319                                # TODO: We cannot deactivate them all...
320                                widget = gtk.VBox()
321                                first_radio = None
322                                for value, label in field.iter_options():
323                                        radio = gtk.RadioButton(first_radio, label=label)
324                                        radio.connect('toggled', self.on_list_single_radiobutton_toggled,
325                                                field, value)
326                                        if first_radio is None:
327                                                first_radio = radio
328                                                if field.value=='':     # TODO: is None when done
329                                                        field.value = value
330                                        if value == field.value:
331                                                radio.set_active(True)
332                                        widget.set_sensitive(readwrite)
333                                        widget.pack_start(radio, expand=False)
334
335                        elif field.type == 'list-multi':
336                                # TODO: When more than few choices, make a list
337                                widget = gtk.VBox()
338                                for value, label in field.iter_options():
339                                        check = gtk.CheckButton(label, use_underline=False)
340                                        check.set_active(value in field.values)
341                                        check.connect('toggled', self.on_list_multi_checkbutton_toggled,
342                                                field, value)
343                                        widget.set_sensitive(readwrite)
344                                        widget.pack_start(check, expand=False)
345
346                        elif field.type == 'jid-single':
347                                widget = gtk.Entry()
348                                widget.connect('changed', self.on_text_single_entry_changed, field)
349                                widget.set_text(field.value)
350
351                        elif field.type == 'jid-multi':
352                                commonwidget = False
353
354                                xml = gtkgui_helpers.get_glade('data_form_window.glade', 'item_list_table')
355                                widget = xml.get_widget('item_list_table')
356                                treeview = xml.get_widget('item_treeview')
357
358                                listmodel = gtk.ListStore(str)
359                                for value in field.iter_values():
360                                        # nobody will create several megabytes long stanza
361                                        listmodel.insert(999999, (value,))
362
363                                treeview.set_model(listmodel)
364
365                                renderer = gtk.CellRendererText()
366                                renderer.set_property('editable', True)
367                                renderer.connect('edited',
368                                        self.on_jid_multi_cellrenderertext_edited, listmodel, field)
369
370                                treeview.append_column(gtk.TreeViewColumn(None, renderer,
371                                        text=0))
372
373                                decorate_with_tooltip(treeview, field)
374
375                                add_button=xml.get_widget('add_button')
376                                add_button.connect('clicked',
377                                        self.on_jid_multi_add_button_clicked, treeview, listmodel, field)
378                                edit_button=xml.get_widget('edit_button')
379                                edit_button.connect('clicked',
380                                        self.on_jid_multi_edit_button_clicked, treeview)
381                                remove_button=xml.get_widget('remove_button')
382                                remove_button.connect('clicked',
383                                        self.on_jid_multi_remove_button_clicked, treeview, field)
384                                clear_button=xml.get_widget('clear_button')
385                                clear_button.connect('clicked',
386                                        self.on_jid_multi_clean_button_clicked, listmodel, field)
387                                if not readwrite:
388                                        add_button.set_no_show_all(True)
389                                        edit_button.set_no_show_all(True)
390                                        remove_button.set_no_show_all(True)
391                                        clear_button.set_no_show_all(True)
392
393                                widget.set_sensitive(readwrite)
394                                self.attach(widget, 1, 2, linecounter, linecounter+1)
395
396                                del xml
397
398                        elif field.type == 'text-private':
399                                commonlabelcenter = True
400                                widget = gtk.Entry()
401                                widget.connect('changed', self.on_text_single_entry_changed, field)
402                                widget.set_visibility(False)
403                                widget.set_text(field.value)
404
405                        elif field.type == 'text-multi':
406                                # TODO: bigger text view
407                                commonwidget = False
408
409                                textwidget = gtk.TextView()
410                                textwidget.set_wrap_mode(gtk.WRAP_WORD)
411                                textwidget.get_buffer().connect('changed', self.on_text_multi_textbuffer_changed,
412                                        field)
413                                textwidget.get_buffer().set_text(field.value)
414                               
415                                widget = gtk.ScrolledWindow()
416                                widget.add(textwidget)
417
418                                widget.set_sensitive(readwrite)
419                                widget=decorate_with_tooltip(widget, field)
420                                self.attach(widget, 1, 2, linecounter, linecounter+1)
421
422                        else:# field.type == 'text-single' or field.type is nonstandard:
423                                # JEP says that if we don't understand some type, we
424                                # should handle it as text-single
425                                commonlabelcenter = True
426                                if readwrite:
427                                        widget = gtk.Entry()
428                                        widget.connect('changed', self.on_text_single_entry_changed, field)
429                                        widget.set_sensitive(readwrite)
430                                        if field.value is None:
431                                                field.value = u''
432                                        widget.set_text(field.value)
433                                else:
434                                        commonwidget=False
435                                        widget = gtk.Label(field.value)
436                                        widget.set_sensitive(True)
437                                        widget.set_alignment(0.0, 0.5)
438                                        widget=decorate_with_tooltip(widget, field)
439                                        self.attach(widget, 1, 2, linecounter, linecounter+1,
440                                                yoptions=gtk.FILL)
441
442                        if commonlabel and field.label is not None:
443                                label = gtk.Label(field.label)
444                                if commonlabelcenter:
445                                        label.set_alignment(0.0, 0.5)
446                                else:
447                                        label.set_alignment(0.0, 0.0)
448                                label = decorate_with_tooltip(label, field)
449                                self.attach(label, 0, 1, linecounter, linecounter+1,
450                                        xoptions=gtk.FILL, yoptions=gtk.FILL)
451
452                        if commonwidget:
453                                assert widget is not None
454                                widget.set_sensitive(readwrite)
455                                widget = decorate_with_tooltip(widget, field)
456                                self.attach(widget, 1, 2, linecounter, linecounter+1,
457                                        yoptions=gtk.FILL)
458                        widget.show_all()
459
460                        linecounter+=1
461                if self.get_property('visible'):
462                        self.show_all()
463
464        def show(self):
465                # simulate that we are one widget
466                self.show_all()
467
468        def on_boolean_checkbutton_toggled(self, widget, field):
469                field.value = widget.get_active()
470
471        def on_list_single_radiobutton_toggled(self, widget, field, value):
472                field.value = value
473
474        def on_list_multi_checkbutton_toggled(self, widget, field, value):
475                # TODO: make some methods like add_value and remove_value
476                if widget.get_active() and value not in field.values:
477                        field.values += [value]
478                elif not widget.get_active() and value in field.values:
479                        field.values = [v for v in field.values if v!=value]
480
481        def on_text_single_entry_changed(self, widget, field):
482                field.value = widget.get_text()
483
484        def on_text_multi_textbuffer_changed(self, widget, field):
485                field.value = widget.get_text(
486                        widget.get_start_iter(),
487                        widget.get_end_iter())
488
489        def on_jid_multi_cellrenderertext_edited(self, cell, path, newtext, model, field):
490                old=model[path][0]
491                model[path][0]=newtext
492
493                values = field.values
494                values[values.index(old)]=newtext
495                field.values = values
496
497        def on_jid_multi_add_button_clicked(self, widget, treeview, model, field):
498                iter = model.insert(999999, ("new@jabber.id",))
499                treeview.set_cursor(model.get_path(iter), treeview.get_column(0), True)
500                field.values = field.values + ["new@jabber.id"]
501
502        def on_jid_multi_edit_button_clicked(self, widget, treeview):
503                model, iter = treeview.get_selection().get_selected()
504                assert iter is not None
505
506                treeview.set_cursor(model.get_path(iter), treeview.get_column(0), True)
507
508        def on_jid_multi_remove_button_clicked(self, widget, treeview, field):
509                selection = treeview.get_selection()
510                model = treeview.get_model()
511                deleted = []
512
513                def remove(model, path, iter, deleted):
514                        deleted+=model[iter]
515                        model.remove(iter)
516
517                selection.selected_foreach(remove, deleted)
518                field.values = (v for v in field.values if v not in deleted)
519
520        def on_jid_multi_clean_button_clicked(self, widget, model, field):
521                model.clear()
522                del field.values
Note: See TracBrowser for help on using the browser.