PHP-GTK2 Newsletter

PHP-GTK2 Tips & Techniques
FREE Newsletter
by kksou



Sample Code 501: How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 2 - OOP version using classes?
Written by kksou   
Friday, 30 May 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 2, I present the same solution, but using the OOP (object-oriented programming) approach for those people who like using classes as shown below:

How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 2 - OOP version using classes?


Solution

Please refer to How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 1 - non OOP version?


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   
141   
142   
143   
144   
145   
146   
147   
148   
149   
150   
151   
152   
153   
154   
155   
156   
157   
158   
159   
160   
161   
<?php
$app = new App();
$app->go();

class App {

    protected $window; // the window
    protected $view; // the treeview

    function __construct() {

        $window = new GtkWindow();
        global $argv;
        $window->set_title($argv[0]);
        $window->set_size_request(400, 240);
        $window->connect_simple('destroy', array('Gtk','main_quit'));
        $window->add($vbox = new GtkVBox());
        $this->window = $window;

        // display title
        $title = new GtkLabel("Interactive search in GtkTreeView for PHP-GTK v2.0\n".
        "                          Part 2 - OOP version");
        $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('Press Ctrl-F 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 = new TreeView($window, $vbox, $data);
    }

    public function go() {
        $this->window->show_all();
        Gtk::main();
    }
}

class TreeView extends GtkTreeView {

    var $parent_window; // parent window
    var $search_app = null; // the interactive search application

    function __construct($parent_window, $vbox, $data) {
        $this->parent_window = $parent_window;

        // 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
        parent::__construct($model);
        $scrolled_win->add($this);

        // 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, array($this, "format_col"), $col);
            $this->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 = $this->get_selection();
        $selection->connect('changed', array($this, 'on_selection'));

        $this->set_enable_search(false);
        $this->connect('start-interactive-search', array($this, 'on_search_start'));
        $this->connect('button-press-event', array($this, 'on_buttonpress'));
    }

    // 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) {
        if ($this->search_app==null || !$this->search_app->searchbox_on) {
            $this->search_app = new Interactive_Search($this->parent_window, $this);
        }
    }

    function on_buttonpress($view, $event) {
        if ($this->search_app!=null) {
            $this->search_app->destroy_searchwin();
            $this->search_app = null;
        }
    }
}

class Interactive_Search extends GtkWindow {

    public $searchbox_on = 0;
    protected $parent_window; // parent window
    protected $treeview; // the tree view
    protected $search_win; // the search window

    function __construct($parent_window, $treeview) {
  • 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

Please refer to How to setup interactive search in GtkTreeView for PHP GTK v2.0 - Part 1 - non OOP version? for explanations.


Related Links

User reviews   Average user ratings:    3.0   (from 1 user)
  1. André
    September 07, 2008 4:31am

    A few points:

    Rather than creating the window and the search entry each time it is needed, I would do this only once and store them as properties of my custom GtkTreeView class. When I'm done, I just hide the window. Next time I need it, all I have to do is call show_all() on the window.
    ...
    if (is_null($this->searchwindow)) {
    // create searchwindow
    }
    else {
    $this->searchwindow->show_all();
    }
    ...

    To position the search window, I'd figure out the position of the lower left corner of the treeview widget, and then simply use set_uposition(x,y) - it's less code and more straightforward.
    ...
    $ppos = $this->get_parent_window()->get_position();
    $wpos = $this->get_allocation();
    $xpos = $ppos[0] + $wpos->x;
    $ypos = $ppos[1] + $wpos->y + $wpos->height;
    $this->searchwindow->set_uposition($xpos,$ypos);
    ...

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

 
< Prev   Next >

Blog - Forum - Privacy Policy - Contact Us
Copyright © 2006-2009. kksou.com. All Rights Reserved