064. How to selectively display rows in GtkTreeView with GtkTreeModelFilter - Part 1?

Problem

You would like to selectively display certain rows of a GtkTreeView based on some criteria as shown below:

How to selectively display rows in GtkTreeView with GtkTreeModelFilter - Part 1?


Solution

Of course one way to acheive the above is to clear all GtkListStore and then repopulate the model with the selected rows.

However, php-gtk2 provides us with a simpler and neater way using GtkTreeModelFilter.

  • First store your data in a GtkListstore as usual.
  • In the model, add one more Boolean field. This serves as a flag to indicate whether to include or exclude this row in the treeview.
  • Then create a GtkTreeModelFilter on top of the base model.
  • Use GtkTreemodelfilter::set_visible_column() to inform php-gtk which field is the flag indicating whether to show or hide the row.
  • Attach the GtkTreeModelFilter to the GtkTreeView, not the base GtkListStore storing the entire list.
  • The rest is just the same as you would handle a standard GtkTreeView.
  • To display a row, just set the boolean field to 1 or TRUE.
  • To hide a row, just set the boolean field to 0 or FALSE.

Sample Code

1   
 2   
 3   
 4   
 5   
 6   
 7   
 8   
 9   
 10   
 11   
 12   
 13   
 14   
 15   
 16   
 17   
 18   
 19   
 20   
 21   
 22   
 23   
 24   
 25   
 26   
 27   
 28   
 29   
 30   
 31   
 32   
 33   
 34   
 35   
 36   
 37   
 40   
 41   
 42   
 43   
 44   
 45   
 46   
 47   
 48   
 49   
 50   
 51   
 52   
 53   
 54   
 55   
 56   
 57   
 58   
 59   
 60   
 61   
 62   
 63   
 64   
 65   
 67   
 68   
 69   
 70   
 72   
 73   
 74   
 75   
 76   
 77   
 78   
 79   
 80   
 81   
 82   
 83   
 84   
 85   
 86   
 87   
 88   
 89   
 90   
 91   
 92   
 93   
 94   
 95   
 96   
 97   
 98   
 99   
100   
101   
102   
103   
104   
105   
106   
107   
108   
109   
110   
111   
112   
113   
114   
118   
119   
120   
121   
122   
123   
124   
125   
126   
127   
128   
129   
130   
131   
132   
133   
134   
135   
136   
137   
138   
139   
140   
141   
142   
143   
144   
145   
147   
148   
149   
150   
151   
153   
154   
155   
156   
157   
158   
159   
160   
161   
162   
163   
164   
165   
166   
167   
168   
169   
170   
172   
173   
174   
175   
176   
177   
183   
184   
185   
186   
190   
191   
192   
193   
194   
195   
196   
197   
198   
199   
200   
201   
202   
203   
204   
205   
206   
207   
208   
209   
210   
211   
212   
214   
216   
217   
218   
220   
221   
222   
223   
224   
225   
226   
228   
230   
231   
232   
234   
235   
236   
237   
238   
239   
240   
241   
242   
243   
244   
<?php
$window = new GtkWindow();
$window->set_size_request(400, 320);
$window->connect_simple('destroy', array('Gtk','main_quit'));
$window->add($vbox = new GtkVBox());
$accel_group = new GtkAccelGroup();
$window->add_accel_group($accel_group);

// define menu definition
$menu_definition = array(
    '_File' => array('_Quit|Q'),
    '_Test' => array('Show All Rows|1', 'Show Rows where Qty > 10|2',
                'Show Rows where Price < $10|3')
);
setup_menu($vbox, $menu_definition);

// display title
$title = new GtkLabel("Use of GtkTreeModelFilter");
$title->modify_font(new PangoFontDescription("Times New Roman Italic 10"));
$title->modify_fg(Gtk::STATE_NORMAL, GdkColor::parse("#0000ff"));
$title->set_size_request(-1, 40);
$vbox->pack_start($title, 0, 0);

$vbox->pack_start(new GtkLabel("Press Ctrl-1 to show all rows\n".
"Ctrl-2 to show qty > 10\nCtrl-3 to show price < \$10"), 0, 0);
$vbox->pack_start(new GtkLabel(), 0, 0);

// the 2D table
$data = array(
array('row0', 'item 42', 2, 3.1, 1),
array('row1', 'item 36', 20, 6.21, 1),
array('row2', 'item 21', 8, 9.36, 1),
array('row3', 'item 10', 11, 12.4, 1),
array('row4', 'item 7', 5, 15.5, 1),
array('row5', 'item 4', 17, 18.6, 1),
array('row6', 'item 3', 20, 21.73, 1));

display_table ($vbox, $data);

$window->show_all();
Gtk::main();

function display_table($vbox, $data) {

    // Set up a scroll window
    $scrolled_win = new GtkScrolledWindow();
    $scrolled_win->set_policy( Gtk::POLICY_AUTOMATIC,
        Gtk::POLICY_AUTOMATIC);
    $vbox->pack_start($scrolled_win);

    // Creates the list store
    global $model;
    if (defined("GObject::TYPE_STRING")) {
        $model = new GtkListStore(GObject::TYPE_STRING, GObject::TYPE_STRING, 
                GObject::TYPE_LONG, GObject::TYPE_DOUBLE, GObject::TYPE_BOOLEAN); // note 1
    } else {
        $model = new GtkListStore(Gtk::TYPE_STRING, Gtk::TYPE_STRING, 
                    Gtk::TYPE_LONG, Gtk::TYPE_DOUBLE, Gtk::TYPE_BOOLEAN); // note 1
    }
    $field_header = array('Row #', 'Description', 'Qty', 'Price');
    $field_justification = array(0.0, 0.0, 0.5, 1.0);

    // setup GtkTreeModelFilter - note 2
    $modelfilter = new GtkTreeModelFilter($model); 
    $modelfilter->set_visible_column(4); 
    
    // Creates the view to display the list store
    $view = new GtkTreeView($modelfilter);
    $scrolled_win->add($view);

    // Creates the columns
    for ($col=0; $col<count($field_header); ++$col) {
        $cell_renderer = new GtkCellRendererText();
        $cell_renderer->set_property("xalign", $field_justification[$col]);
        $column = new GtkTreeViewColumn($field_header[$col],
            $cell_renderer, 'text', $col);
        $column->set_alignment($field_justification[$col]);
        $column->set_sort_column_id($col);

        // set the header font and color
        $label = new GtkLabel($field_header[$col]);
        $label->modify_font(new PangoFontDescription("Arial Bold"));
        $label->modify_fg(Gtk::STATE_NORMAL, GdkColor::parse("#0000FF"));
        $column->set_widget($label);
        $label->show();

        // setup self-defined function to display alternate row color
        $column->set_cell_data_func($cell_renderer, "format_col", $col);
        $view->append_column($column);
    }

    // pupulates the data
    for ($row=0; $row<count($data); ++$row) {
        $values = array();
        for ($col=0; $col<count($data[$row]); ++$col) {
            $values[] = $data[$row][$col];
        }
        $model->append($values);
    }

    // setup selection
    $selection = $view->get_selection();
    $selection->connect('changed', 'on_selection');

}

// self-defined function to format the price column
function format_col($column, $cell, $model, $iter, $col_num) {
    $path = $model->get_path($iter); // get the current path
    $row_num = $path[0]; // get the row number
    if ($col_num==3) {
        $amt = $model->get_value($iter, 3);
        $cell->set_property('text', '$'.number_format($amt,2));
    }
    $row_color = ($row_num%2==1) ? '#dddddd' : '#ffffff';
    $cell->set_property('cell-background', $row_color);
}

// the function that is called when user selects a row
function on_selection($selection) {
    list($model, $iter) = $selection->get_selected();
    if ($iter==NULL) return;
    $desc = $model->get_value($iter, 1);
    $qty = $model->get_value($iter, 2);
    $price = $model->get_value($iter, 3);
    print "You have selected $desc: $qty ($price)\n";
}

// setup menu
function setup_menu($vbox, $menus) {
    global $accel_group;
    $menubar = new GtkMenuBar();
    $vbox->pack_start($menubar, 0, 0);
    foreach($menus as $toplevel => $sublevels) {
        $menubar->append($top_menu = new GtkMenuItem($toplevel));
        $menu = new GtkMenu();
        $top_menu->set_submenu($menu);
        foreach($sublevels as $submenu) {
            if (strpos("$submenu", '|') === false) {
                $accel_key = '';
            } else {
                list($submenu, $accel_key) = explode('|', $submenu);
            }

            if (is_array($submenu)) { // set up radio menus
                $i=0;
                $radio[0] = null;
                foreach($submenu as $radio_item) {
                    $radio[$i] = new GtkRadioMenuItem($radio[0], $radio_item);
                    $radio[$i]->connect('toggled', "on_toggle");
                    $menu->append($radio[$i]);
                    ++$i;
                }
                $radio[0]->set_active(1); // select the first item
            } else {
                if ($submenu=='<hr>') {
                    $menu->append(new GtkSeparatorMenuItem());
                } else {
                    $submenu2 = str_replace('_', '', $submenu);
                    $submenu2 = str_replace(' ', '_', $submenu2);
                    $stock_image_name = 'Gtk::STOCK_'.strtoupper($submenu2);
                    if (defined($stock_image_name)) {
                        $menu_item = new GtkImageMenuItem(
                            constant($stock_image_name));
                    } else {
                        $menu_item = new GtkMenuItem($submenu);
                    }
                    if ($accel_key!='') {
                        $menu_item->add_accelerator("activate",
                            $accel_group, ord($accel_key), Gdk::CONTROL_MASK, 1);
                    }

                    $menu->append($menu_item);
                    $menu_item->connect('activate', 'on_menu_select');
                }
            }
        }
    }
}

// process menu item selection
function on_menu_select($menu_item) {
    global $model;
    $item = $menu_item->child->get_label();
    echo "menu selected: $item\n";
    if ($item=='_Quit') {
        Gtk::main_quit();
    } elseif ($item=='Show All Rows') { // note 3
        $n = $model->iter_n_children(NULL);
        for($i=0; $i<$n; ++$i) {
            $iter = $model->get_iter($i);
            $model->set($iter, 4, 1);
        }
    } elseif ($item=='Show Rows where Qty > 10') { // note 4
        $n = $model->iter_n_children(NULL);
        for($i=0; $i<$n; ++$i) {
            $iter = $model->get_iter($i);
            $qty = $model->get_value($iter, 2);
            if ($qty>10) {
                $model->set($iter, 4, 1);
            } else {
                $model->set($iter, 4, 0);
            }
        }
    } elseif ($item=='Show Rows where Price < $10') { // note 5
        $n = $model->iter_n_children(NULL);
        for($i=0; $i<$n; ++$i) {
            $iter = $model->get_iter($i);
            $price = $model->get_value($iter, 3);
            $model->set($iter, 4, 1);
            if ($price<10) {
                $model->set($iter, 4, 1);
            } else {
                $model->set($iter, 4, 0);
            }
        }
    }
}

?>

Output

As shown above.
 

Explanation

The above code is based on How to display a 2D array in GtkTreeView - Part 5 - get user selection?.

We also make use of the codes in How to set up menu and radio menu - Part 3 - add accelerators? to display a menu with accelerators so that we use Ctrl-1, Ctrl-2 and Ctrl-3 to switch between the three views.

What's new here:

  1. Remember to add one Gtk::TYPE_BOOLEAN field as a flag to let php-gtk know whether to show or hide a particular row.
  2. Here we create a new GtkTreeModelFilter, and inform php-gtk that the flag column is field #4.
  3. Displays the entire list by setting all flags to 1.
  4. Go through the entire list. Set the flag to 1 for all those rows with quantity > 10. Set all the others to 0.
  5. Go through the entire list. Set the flag to 1 for all those rows with price < $10. Set all the others to 0.

Related Links

Add comment

Security code
Refresh