PHP-GTK2 Newsletter

PHP-GTK2 Tips & Techniques
FREE Newsletter
by kksou



Sample Code 502: How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 3 - start on any keypress?
Written by kksou   
Monday, 02 June 2008
Problem

In How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 1 - non OOP version? I showed you how to set up an interactive search on the windows platform using the latest PHP-GTK v2.0 and v2.0.1.

In this Part 3, I added one more enhancement: on windows platform, the interactive search will automatically kicks in when you start typing any character in the treeview - just like what the users experience on the linux platform! Yes, you do not need to press Ctrl-F to start the interactive search as shown below!

How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 3 - start on any keypress?


Solution

The idea is very simple:

  • Register the signal 'key-press-event' on the treeview to let us know when the user pressed a key.
  • When the user presses a key in treeview, we manually pop-up the interactive search box.

However, there are some details you need to take care of:

  1. You need to insert the first character the user typed into the interactive search field.
  2. You also need to position the insert character to the end of the GtkEntry, otherwise the first character will be overridden.

Sample Code

Important Note: This only works for PHP-GTK v2.0 (or PHP-GTK2 compliled with gtk+ v2.12 and above. If you are using an older version, for linux, you may follow the step-by-step instructions to recompile php-gtk2 with gtk+ v2.12. For windows, please refer to How to install php gtk2 on windows?

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   
38   
39   
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   
66   
67   
68   
69   
70   
71   
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   
115   
116   
117   
118   
119   
120   
121   
122   
123   
124   
125   
126   
127   
128   
129   
130   
131   
132   
133   
134   
135   
136   
137   
138   
139   
140   
<?php
$window = new GtkWindow();
$window->set_title($argv[0]);
$window->set_size_request(400, 240);
$window->connect_simple('destroy', array('Gtk','main_quit'));
$window->add($vbox = new GtkVBox());

// display title
$title = new GtkLabel("Interactive search in GtkTreeView for PHP-GTK v2.0\n".
"     Part 3 - start interactive search without Ctrl-F");
$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(), 0);

$vbox->pack_start(new GtkLabel('Just start typing in treeview to activate interactive search'), 0);
$vbox->pack_start(new GtkLabel('Note: Search column is the Qty column'), 0);

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

$view = display_table($vbox, $data);

$view->set_enable_search(false);
$view->connect('start-interactive-search', 'on_search_start');
$view->connect('button-press-event', 'on_buttonpress');
$view->connect('key-press-event', 'on_keypress'); // note 1
$searchbox_on = 0;

$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
    if (defined("GObject::TYPE_STRING")) {
        $model = new GtkListStore(GObject::TYPE_STRING, GObject::TYPE_STRING,
                    GObject::TYPE_LONG, GObject::TYPE_DOUBLE);
    } else {
        $model = new GtkListStore(Gtk::TYPE_STRING, Gtk::TYPE_STRING,
                    Gtk::TYPE_LONG, Gtk::TYPE_DOUBLE);
    }
    $field_header = array('Row #', 'Description', 'Qty', 'Price');
    $field_justification = array(0.0, 0.0, 0.5, 1.0);

    // Creates the view to display the list store
    $view = new GtkTreeView($model);
    $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);
    }

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

    return $view;
}

// 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";
}

function on_search_start($view) {
    global $searchbox_on;
    if (!$searchbox_on) interactive_search($view);
}

function interactive_search($view, $key='') {
    global $searchbox_on;
    $searchbox_on = 1;

    global $search_win;
    $search_win = new GtkWindow();
    $search_win->add($vbox = new GtkVBox());
    $search_win->set_modal(0);
    $search_win->set_decorated(0);

    $vbox->pack_start($frame = new GtkFrame(), 0);
    $frame->add($search_entry = new GtkEntry());
    $search_entry->connect('key-press-event', 'on_entry_keypress');

  • Note that this is only 70% of the sample code. You have to be a registered member to see the entire sample code. Please login or register.
  • Registration is free and immediate.
  • Have some doubt about the registration? Please read this forum article.
Explanation

The code above is extended from that of How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 1 - non OOP version?

What's new here:

  1. Register the signal 'key-press-event' on the treeview to let us know when the user pressed a key.
  2. We added this here so that Ctrl-F will still popup the interactive search field.
  3. You might want to finetune this regular expression to suit your application needs. Here I let all alphabets, digits and some common characters to pass through.
  4. Popup up the interactive search field.
  5. Insert the first character into the search field.
  6. Position the cursor at the end of the search field.


Related Links

User reviews

There are no user reviews yet.

Note: You have to be a registered member to leave a comment. Free registration here.

 
< Prev   Next >

Copyright © 2006-2008. kksou.com. All Rights Reserved