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 4, I added one more enhancement: the interactive search box will automatically disappear after 3 seconds of inactivity (just like the default interactive search), as shown below:
Solution
Here are the steps to make this work:
- Use a variable e.g.
$start_time
to keep track of the time the interactive search first started. - Use Gtk::timeout_add() to allow us to check the elapsed time every 1 second.
- When the elapsed time is more than 3 seconds, we destroy the interactive search box.
- If the user enters something or clicks somewhere in the search field, we need to update the
$start_time
accordingly. - Don't forget to use Gtk::timeout_remove() to remove the timeout event.
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 39 40 41 42 43 44 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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 140 141 142 143 145 147 148 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 167 168 173 175 176 177 178 179 180 181 182 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 200 201 202 203 204 205 206 207 208 209 212 213 214 215 216 217 219 220 221 222 224 225 226 227 228 229 230 232 233 234 235 236 237 238 239 240 241 242 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | <?php $window = new GtkWindow(); $window->set_title($argv[0]); $window->set_size_request(400, 260); $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 4 - hide the search box after 3 seconds"); $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( 'The search box will automatically hide after three seconds'), 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'); $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'); $search_entry->connect('button-press-event', 'on_entry_buttonpress'); $view->set_search_entry($search_entry); $view->set_search_column(2); $search_entry->set_text($key); $search_win->show_all(); set_searchwin_pos($search_entry); $search_entry->set_position(-1); global $timeout_handle, $start_time; $start_time = microtime(1); // note 1 $timeout_handle = Gtk::timeout_add(1000, 'check_idle'); // note 2 } function on_buttonpress($view, $event) { global $searchbox_on; if ($searchbox_on) destroy_searchwin(); } function on_entry_keypress($entry, $event) { global $start_time; $start_time = microtime(1); // note 6 if ($event->keyval==Gdk::KEY_Return || $event->keyval==Gdk::KEY_Escape) { destroy_searchwin(); } return false; } function destroy_searchwin() { global $search_win, $searchbox_on, $view; $view->set_search_entry(null); $search_win->destroy(); $searchbox_on = 0; $view->grab_focus(); } function set_searchwin_pos($search_entry) { global $window, $view, $search_win; $win_pos = $window->get_position(); $x_shift = 0; $y_shift = 6; $x = $win_pos[0] + $view->allocation->width - $search_entry->allocation->width + $x_shift; $y = $win_pos[1] + $view->allocation->height + $view->allocation->y + $search_entry->allocation->height + $y_shift ; $search_win->move($x, $y); } function on_keypress($view, $event) { if ($event->keyval>255 || $event->keyval<32) return false; if (preg_match('/f/i', chr($event->keyval)) && ($event->state & Gdk::CONTROL_MASK)) return false; if (preg_match('/[a-zA-Z0-9\s_\!@#\$%\^&\*-+=;\:,\.<>]/', chr($event->keyval))) { Gtk::idle_add('interactive_search', $view, chr($event->keyval)); return true; } return false; } function check_idle() { global $timeout_handle, $start_time; $elapsed_time = microtime(1)-$start_time; if ($elapsed_time>3) { // note 3 Gtk::timeout_remove($timeout_handle); // note 4 destroy_searchwin(); // note 5 return false; } else { return true; } } function on_entry_buttonpress($entry, $event) { global $start_time; $start_time = microtime(1); // note 7 } ?> |
Output
As shown above.Explanation
The code above is extended from that of How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 3 - start on any keypress?
What's new here:
- Take note of the start time in the global variable
$start_time
. - Add a timeout event that will call the function
check_idle()
once every 1 second. - Check if the time elapsed is more than 3 seconds.
- Remove the timeout event.
- Destroy the search box.
- Each time the user typed something, we update the start time accordingly.
- Each time the user clicks somewhere in the search field, we also update the start time accordingly.
Related Links
- How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 1 - non OOP version?
- How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 2 - OOP version using classes?
- How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 3 - start on any keypress?
- How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 5 - switch search column using tab key?
- How to finetune interactive search in GtkTreeView - Part 1 - turning it on?
- How to finetune interactive search in GtkTreeView - Part 2 - set search column?
- How to finetune interactive search in GtkTreeView - Part 3 - set custom search entry?
- How to finetune interactive search in GtkTreeView - Part 4 - set custom compare function?
Read more...