Sample Code 159: How to insert links in GtkTextView - Part 3 - Display Link in Status Bar?
Written by kksou   
Thursday, 01 February 2007
Problem

You want to allow users to insert links in a GtkTextView. The user will highlight some text and press the "Insert Link" button. A popup dialog box will appear where the user enters the URL address. On pressing return, the URL address will be registered, and the link highlighted in the standard blue underlined text.

  • In Part 1, we have the link displayed as blue underlined text.
  • In Part 2, we launch the link in the default browser when the user clicks on the link.

In this article, we will display the url address in the status bar when the user hovers the mouse over the link in the textview as shown below:

How to insert links in GtkTextView - Part 3 - Display Link in Status Bar?


Solution

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   
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   
<?php
$window = new GtkWindow();
$window->set_size_request(400, 240);
$window->connect_simple('destroy', array('Gtk','main_quit'));
$window->add($vbox = new GtkVBox());

// display title
$title = new GtkLabel("Insert Links in GtkTextView - Part 3\n".
"Display Link in Status Bar");
$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);
$title->set_justify(Gtk::JUSTIFY_CENTER);
$alignment = new GtkAlignment(0.5, 0.5, 0, 0);
$alignment->add($title);
$vbox->pack_start($alignment);

// Setup TextBuffer and TextView
$tag_count = 0;
$buffer = new GtkTextBuffer();
$buffer->set_text('PHP-GTK2 resources:
1) manual: http://gtk.php.net/manual/en/gtkclasses.php
2) mailing list: http://www.nabble.com/Php---GTK---General-f171.html
');
$view = new GtkTextView();
$view->set_buffer($buffer);
$view->modify_font(new PangoFontDescription("Arial 10"));
$view->set_wrap_mode(Gtk::WRAP_WORD);
$buffer->connect('mark-set', 'on_mark_set');
$view->connect('motion-notify-event', 'on_motion_in_textview'); // note 1
$view->set_events(Gdk::POINTER_MOTION_MASK);


$hbox = new GtkHBox();
$hbox->pack_start($button = new GtkButton('Insert Link'), 0);
$vbox->pack_start($hbox, 0);
$button->connect('clicked', 'on_button', $buffer);

$scrolled_win = new GtkScrolledWindow();
$scrolled_win->set_policy( Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

$scrolled_win->add($view);
$vbox->pack_start($scrolled_win);

// setup status area
$status = new GtkStatusbar(); // note 1
$vbox->pack_start($status, 0);

$window->show_all();
Gtk::main();

// Setup highlight tag

class LinkTag extends GtkTextTag {
    function __construct($link) {
        global $buffer;
        parent::__construct();
        $tag_table = $buffer->get_tag_table();
        $this->set_property('foreground', "#0000ff");
        $this->set_property('underline', Pango::UNDERLINE_SINGLE);
        $tag_table->add($this);
    }
}

function on_button($button, $buffer) {
    global $view, $tag, $url, $tag_count;

    $cursor_pos = $buffer->get_mark('insert');
    $iter = $buffer->get_iter_at_mark($cursor_pos);

    list($start, $end) = $buffer->get_selection_bounds();
    if ($start==null || $end==null) return; // no selection

    $url[$tag_count] = prompt("Enter URL:");
    $tag[$tag_count] = new LinkTag($url[$tag_count]);
    $buffer->apply_tag($tag[$tag_count], $start, $end);
    ++$tag_count;

    $buffer->place_cursor($end);
    $view->grab_focus();
}

function on_mark_set($buffer, $textiter, $textmark) {

    global $tag, $url, $tag_count;

    if ($textmark->get_name()!='insert') return;

    $cursor_pos = $buffer->get_insert();
    $iter = $buffer->get_iter_at_mark($cursor_pos);

    for ($i=0; $i<$tag_count; ++$i) {
        if ($iter->has_tag($tag[$i])) {
            if (PHP_SHLIB_SUFFIX=='dll') {
                $shell = new COM('WScript.Shell');
                $shell->Run('cmd /c start "" "' . $url[$i] . '"', 0, FALSE);
                unset($shell);
            } else {
                exec("firefox $url[$i] > /dev/null &");
            }
        } else {
        }
    }
    return true;
}

function on_motion_in_textview($view, $event) {
    $buffer_location = $view->window_to_buffer_coords 
        (Gtk::TEXT_WINDOW_TEXT, $event->x, $event->y); // note 2
    $iter = $view->get_iter_at_location( 
        $buffer_location[0], $buffer_location[1]); // note 3
    if ($iter==null) return;

    global $tag, $url, $tag_count, $status;
    for ($i=0; $i<$tag_count; ++$i) {
        $context_id = $status->get_context_id('msg1');
        if ($iter->has_tag($tag[$i])) { // note 4
            // display a message
            $status->pop($context_id); // note 5
  • 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

We make use of the code in Part 2.

We also make use of the code in How to have a status area using GtkStatusbar? to set up the status bar.

What's new here:

  1. Connect the motion-notify-event signal.
  2. Get the buffer coordinate from view coordinate.
  3. Get the iter of the current mouse location.
  4. Check if there's a link at this location.
  5. If yes, we remove any previous message at the status bar first.
  6. Display the link in the status bar.

Note

This example works only on windows. It does not work on Linux. This is because for some reason, GtkTextView does not emit the signal motion-notify-event in linux. So there's no way you can know if the current mouse location is over a link.


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