286. How to display keyboard accelerator in GtkTreeView with GtkCellRendererAccel - Part 3 - process the hot keys?

Problem

In Part 1, we have showed you how to display keyboard accelerators in a treeview using the new widget GtkCellRendererAccel.

In this Part 2, we have showed you how you can allow users to change the hot keys on the fly.

In this Part 3, we will show you how to process the keyboard accelerators that have been defined for each row of the GtkTreeView as shown below:

How to display keyboard accelerator in GtkTreeView with GtkCellRendererAccel - Part 3 - process the hot keys?


Solution

If you have followed Part 2, you won't be surprised that you have to handle all processing of the hot keys manually!

Important Note: This only works for PHP-GTK2 compliled with gtk+ v2.10 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.10. For windows, please refer to How to install php gtk2 on windows? You may also want to take a look here to see some of the new exciting PHP-GTK2 Functionalities.


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   
 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   
 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   
114   
118   
119   
120   
121   
122   
123   
124   
125   
126   
127   
128   
129   
130   
131   
132   
133   
134   
135   
136   
137   
138   
139   
140   
142   
143   
147   
148   
149   
150   
151   
152   
153   
154   
155   
157   
158   
159   
160   
161   
162   
163   
<?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("Display keyboard accelerators in GtkTreeView\n".
"               Part 3 - Process the hot keys");
$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, 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', 5, 15.5),
array('row5', 'item 4', 17, 18.6),
array('row6', 'item 3', 20, 21.73));

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
    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
    global $view;
    $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);
    }

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

    $cell_renderer = new GtkCellRendererAccel();
    $cell_renderer->set_property('editable', true);
    $cell_renderer->connect('accel-edited', 'on_edit');
    $column = new GtkTreeViewColumn();
    $column->pack_start($cell_renderer, false);
    $view->append_column($column);
    $column->set_cell_data_func($cell_renderer, "format_col", $col);

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

        $accel_keys[$row] = 97+$row;
        $accel_keys_mods[$row] = Gdk::MOD1_MASK;
    }

    $view->connect('key-press-event', 'on_keypress'); // note 1
    $view->grab_focus();

}

// 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==4) {
        global $accel_keys, $accel_keys_mods;
        $cell->set_property("accel-key", $accel_keys[$row_num]);
        $cell->set_property("accel-mods", $accel_keys_mods[$row_num]);
    } elseif ($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();
    $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_edit($cell_renderer, $path, $accel_key, $accel_mods,
    $hardware_keycode) {
    global $accel_keys, $accel_keys_mods;
    $accel_keys[$path] = $accel_key;
    $accel_keys_mods[$path] = $accel_mods;
}

function on_keypress($view, $event) {
    global $accel_keys, $accel_keys_mods;
    global $view;
    for($row=0; $row<count($accel_keys); ++$row) {
        $key = $accel_keys[$row];
        $mods = $accel_keys_mods[$row];
        if ($event->keyval==$key && $event->state==$mods) { // note 2
            $selection = $view->get_selection();
            $selection->select_path($row); // note 3
        }
    }
}

?>

Output

As shown above.

 

Explanation

This example makes use of the base code from How to display keyboard accelerator in GtkTreeView with GtkCellRendererAccel - Part 2 - change hot keys on the fly?.

What's new here:

  1. Register the signal 'key-press-event' on the treeview.
  2. Check if this is a hot key.
  3. Yes, it's a hot key! Select this row.

Related Links

Add comment

Security code
Refresh