[Dicson] rewrite groupchat contact list columns code to be able to extend it with plugins. Fixes #5977

src/groupchat_control.py

@@ -339,45 +339,46 @@ class GroupchatControl(ChatControlBase):
             self.on_treeview_size_allocate)
         self.handlers[id_] = self.list_treeview
         #status_image, shown_nick, type, nickname, avatar
-        store = gtk.TreeStore(gtk.Image, str, str, str, gtk.gdk.Pixbuf)
+        self.columns = [gtk.Image, str, str, str, gtk.gdk.Pixbuf]
+        store = gtk.TreeStore(*self.columns)
         store.set_sort_func(C_NICK, self.tree_compare_iters)
         store.set_sort_column_id(C_NICK, gtk.SORT_ASCENDING)
         self.list_treeview.set_model(store)
 
         # columns
-
-        # this col has 3 cells:
-        # first one img, second one text, third is sec pixbuf
         column = gtk.TreeViewColumn()
-
+        # list of renderers with attributes / properties in the form:
-        def add_avatar_renderer():
+        # (name, renderer_object, expand?, attribute_name, attribute_value,
-            renderer_pixbuf = gtk.CellRendererPixbuf() # avatar image
+        # cell_data_func, func_arg)
-            column.pack_start(renderer_pixbuf, expand=False)
+        self.renderers_list = []
-            column.add_attribute(renderer_pixbuf, 'pixbuf', C_AVATAR)
+        # Number of renderers plugins added
-            column.set_cell_data_func(renderer_pixbuf, tree_cell_data_func,
+        self.nb_ext_renderers = 0
-                self.list_treeview)
+        self.renderers_propertys = {}
-
-        if gajim.config.get('avatar_position_in_roster') == 'left':
-            add_avatar_renderer()
-
-        # status img
         renderer_image = cell_renderer_image.CellRendererImage(0, 0)
-        renderer_image.set_property('width', 26)
+        self.renderers_propertys[renderer_image] = ('width', 26)
-        column.pack_start(renderer_image, expand=False)
+        renderer_text = gtk.CellRendererText()
-        column.add_attribute(renderer_image, 'image', C_IMG)
+        self.renderers_propertys[renderer_text] = ('ellipsize',
-        column.set_cell_data_func(renderer_image, tree_cell_data_func,
+            pango.ELLIPSIZE_END)
-            self.list_treeview)
 
-        renderer_text = gtk.CellRendererText() # nickname
+        self.renderers_list += (
-        column.pack_start(renderer_text, expand=True)
+            # status img
-        column.add_attribute(renderer_text, 'markup', C_TEXT)
+            ('icon', renderer_image, False,
-        renderer_text.set_property("ellipsize", pango.ELLIPSIZE_END)
+            'image', C_IMG, tree_cell_data_func, self.list_treeview),
-        column.set_cell_data_func(renderer_text, tree_cell_data_func,
+            # contact name
-            self.list_treeview)
+            ('name', renderer_text, True,
+            'markup', C_TEXT, tree_cell_data_func, self.list_treeview))
+
+        # avatar img
+        avater_renderer = ('avatar', gtk.CellRendererPixbuf(),
+            False, 'pixbuf', C_AVATAR,
+            tree_cell_data_func, self.list_treeview)
 
         if gajim.config.get('avatar_position_in_roster') == 'right':
-            add_avatar_renderer()
+            self.renderers_list.append(avater_renderer)
+        else:
+            self.renderers_list.insert(0, avater_renderer)
 
+        self.fill_column(column)
         self.list_treeview.append_column(column)
 
         # workaround to avoid gtk arrows to be shown
@@ -406,6 +407,16 @@ class GroupchatControl(ChatControlBase):
         # instance object
         gajim.plugin_manager.gui_extension_point('groupchat_control', self)
 
+    def fill_column(self, col):
+        for rend in self.renderers_list:
+            col.pack_start(rend[1], expand=rend[2])
+            col.add_attribute(rend[1], rend[3], rend[4])
+            col.set_cell_data_func(rend[1], rend[5], rend[6])
+        # set renderers propertys
+        for renderer in self.renderers_propertys.keys():
+            renderer.set_property(self.renderers_propertys[renderer][0],
+                self.renderers_propertys[renderer][1])
+
     def tree_compare_iters(self, model, iter1, iter2):
         """
         Compare two iters to sort them
@@ -1564,10 +1575,11 @@ class GroupchatControl(ChatControlBase):
         role_iter = self.get_role_iter(role)
         if not role_iter:
             role_iter = model.append(None,
-                (gajim.interface.jabber_state_images['16']['closed'], role,
+                [gajim.interface.jabber_state_images['16']['closed'], role,
-                'role', role_name,  None))
+                'role', role_name,  None] + [None] * self.nb_ext_renderers)
             self.draw_all_roles()
-        iter_ = model.append(role_iter, (None, nick, 'contact', name, None))
+        iter_ = model.append(role_iter, [None, nick, 'contact', name, None] + \
+                [None] * self.nb_ext_renderers)
         if not nick in gajim.contacts.get_nick_list(self.account,
         self.room_jid):
             gc_contact = gajim.contacts.create_gc_contact(
@@ -1684,7 +1696,6 @@ class GroupchatControl(ChatControlBase):
         # PluginSystem: calling shutdown of super class (ChatControlBase)
         # to let it remove it's GUI extension points
         super(GroupchatControl, self).shutdown()
-
         # PluginSystem: removing GUI extension points connected with
         # GrouphatControl instance object
         gajim.plugin_manager.remove_gui_extension_point('groupchat_control',

src/roster_window.py

@@ -6078,7 +6078,7 @@ class RosterWindow:
         # columns
         col = gtk.TreeViewColumn()
         # list of renderers with attributes / properties in the form:
-        # (name, renderer_object, expand?, attribute_name, attribute_calue,
+        # (name, renderer_object, expand?, attribute_name, attribute_value,
         # cell_data_func, func_arg)
         self.renderers_list = []
         self.renderers_propertys ={}