078. How to display directory tree using GtkTreeView - Part 3 - add selection box?

Problem

You have displayed a directory tree with folder icons using a GtkTreeView in Part 2 as shown below:

How to display directory tree using GtkTreeView - Part 2 - add folder icon?

You would now like to add in selection checkboxes. Users can select the folders and files by checking the checkboxes as shown below:

How to display directory tree using GtkTreeView - Part 3 - add selection box?


Solution


Sample Code

Note 1: If you select "C:\", the program will run, but it will take a long time. You will see the processing, though, in the command window.

Note 2: On windows, you may see a warning "Gtk-WARNING: Could not find the icon 'stock_unknown'. The 'hicolor' theme was not found either, perhaps you need to install it." This is from the GtkFileChooserButton. It's just a warning. You may ignore it, or go ahead and install it.

Note 3: The following image files are required by the sample code below. Please save a copy of the image files and put them in the same directory where you store the sample code.

 folder_open.gif
 folder_closed.gif

1   
 2   
 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   
 31   
 32   
 33   
 34   
 35   
 36   
 37   
 38   
 39   
 40   
 41   
 42   
 43   
 44   
 45   
 46   
 47   
 48   
 49   
 50   
 51   
 52   
 53   
 58   
 59   
 60   
 61   
 62   
 63   
 64   
 65   
 66   
 68   
 69   
 70   
 71   
 72   
 73   
 76   
 78   
 79   
 80   
 81   
 82   
 84   
 85   
 86   
 87   
 88   
 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   
154   
155   
156   
157   
158   
159   
160   
161   
162   
163   
164   
165   
166   
<?php
$window = new GtkWindow();
$window->connect_simple('destroy', array('Gtk','main_quit'));
$window->add($vbox = new GtkVBox());

// display title
$title = new GtkLabel("Display folder contents in GtkTreeView - Part 3\n".
"                         add selection box");
$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($hbox = new GtkHBox());
$hbox->pack_start(new GtkLabel('Click to select a folder: '), 0, 0);

// set up model
if (defined("GObject::TYPE_STRING")) {
    $model = new GtkTreeStore(GObject::TYPE_STRING, GObject::TYPE_STRING,
        GObject::TYPE_BOOLEAN);
} else {
    $model = new GtkTreeStore(Gtk::TYPE_STRING, Gtk::TYPE_STRING,
        Gtk::TYPE_BOOLEAN);
}

// set up file chooser button
$file_chooser_button = new GtkFileChooserButton('Select the Folder',
    Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
$file_chooser_button->set_size_request(320, -1);
$file_chooser_button->connect('selection-changed', 'on_selection_changed');
on_selection_changed($file_chooser_button);
$hbox->pack_start($file_chooser_button, 0, 0);
$vbox->pack_start(new GtkLabel());

$process_button = new GtkButton('Process Selected Folder/Files');
$process_button->connect('clicked', 'on_process_button', $model);
$vbox->pack_start($hbox=new GtkHBox(), 0, 0);
$hbox->pack_start($process_button, 0, 0);
$vbox->pack_start(new GtkLabel());

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

// set up treeview
$view = new GtkTreeView($model);
$scrolled_win->add($view);
$view->set_size_request(400, 320);

//set up treeview columns
$column = new GtkTreeViewColumn();

// for image
$cell_renderer = new GtkCellRendererPixbuf(); // note 1
$column->pack_start($cell_renderer, false);
$cell_renderer->set_property('pixbuf-expander-open',
    GdkPixbuf::new_from_file('folder_open.gif'));
$cell_renderer->set_property('pixbuf-expander-closed',
    GdkPixbuf::new_from_file('folder_closed.gif'));

// for selection checkbox
$cell_renderer = new GtkCellRendererToggle(); // note 2
$cell_renderer->set_property('activatable', true);
$column->pack_start($cell_renderer, false);
$column->set_attributes($cell_renderer, 'active', 2); // uses col 2 of model
$cell_renderer->connect('toggled', 'on_toggle', $model); // toggles the checkbox

// for filename
$cell_renderer = new GtkCellRendererText(); // note 3
$column->pack_start($cell_renderer, true);
$column->set_attributes($cell_renderer, 'text', 0); // uses col 0 of model

$view->append_column($column);
$column->set_title('Folders / Files');

//display it
$window->show_all();
Gtk::main();

function on_selection_changed($button) {
    $folder = $button->get_current_folder();
    echo "new folder: $folder\n";
    populate_tree($folder);
}

function populate_tree($folder) {
    global $model;
    $model->clear();
    $root = $folder;
    $dir_list = array($root);
    $nodes = array();
    $nodes[$root] = null;
    while(count($dir_list)>0) {
        $dir = array_shift($dir_list);
        echo "folder = $dir\n";

        // add the directories first
        if ($handle = opendir($dir)) {
            while (false !== ($file = readdir($handle))) {
                if ($file != "." && $file != "..") {
                    $fullpath = $dir.'/'.$file;
                    if (is_dir($fullpath)) {
                        $nodes[$fullpath] = $model->append($nodes[$dir], 
                            array($file, $fullpath, 0)); // note 4
                        array_push($dir_list, $fullpath);
                    }
                }
            }
            closedir($handle);
        }

        $num_files = 0;
        // then add the files
        if ($handle = opendir($dir)) {
            while (false !== ($file = readdir($handle))) {
                if ($file != "." && $file != "..") {
                    $fullpath = $dir.'/'.$file;
                    if (!is_dir($fullpath)) {
                        $nodes[$fullpath] = $model->append($nodes[$dir], 
                            array($file, $fullpath, 0)); // note 4
                        ++$num_files;
                    }
                }
            }
            closedir($handle);
        }

        if ($num_files==0) $nodes[$fullpath] =
            $model->append($nodes[$dir], array('' ,'' ,0));
    }
}

// toggle the selection box note 5
function on_toggle($renderer, $row, $model) {
    $iter = $model->get_iter($row); // get the iter
    $model->set($iter, 2, !$model->get_value($iter, 2));
}

function on_process_button($button, $model) {
    $model->foreach('process_each_entry'); // note 6
}

function process_each_entry($model, $path, $iter) { // note 6
    $file   = $model->get_value($iter, 0);
    $fullpath = $model->get_value($iter, 1);
    $checked = $model->get_value($iter, 2);
    if ($checked) {
           echo "selected file = $file ($fullpath)\n";
    }
}

?>

Output

As shown above.
 

Explanation

The above sample code is based on How to display directory tree using GtkTreeView - Part 2 - add folder icon?

What's new here:

  1. Set up the GtkCellRendererPixbuf.
  2. Set up the GtkCellRendererToggle for the selection checkbox.
  3. Set up the GtkCellRenderer.
  4. Note that we add the filename to col 0 of model and the fullpath name to col 1 of model - so that when we process user selection, we have both the filename and fullpath name of the selected folders/files.
    5. Note that we also set 0 to col 2 of model - this sets the default checkbox in the unchecked status.
  5. Please refer to How to use GtkCellRendererToggle - Part 2 - process selection?
  6. Uses GtkTreemodel::foreach() to loop through each row of the treeview model to check if it is selected.

Related Links

Add comment

Security code
Refresh