<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GtkLinkButton</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkLayout.html">Previous: Class GtkLayout</a></li>
<li class="next"><a href="gtk_GtkListStore.html">Next: Class GtkListStore</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.80</span>Class GtkLinkButton</h1><p class="brief">Create buttons bound to a URL </p>
<pre class="prototype">Class GtkLinkButton( uri )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">uri</td><td class="content"> a valid URI string </td></tr>
</tbody>
</table>
<p>A GtkLinkButton is a GtkButton with a hyperlink, similar to the one used by web browsers, which triggers an action when clicked. It is useful to show quick links to resources. </p>
<p>A link button is created by calling either gtk_link_button_new() or gtk_link_button_new_with_label(). If using the former, the URI you pass to the constructor is used as a label for the widget. </p>
<p>The URI bound to a GtkLinkButton can be set specifically using gtk_link_button_set_uri(), and retrieved using gtk_link_button_get_uri(). </p>
<p>GtkLinkButton offers a global hook, which is called when the used clicks on it: see gtk_link_button_set_uri_hook(). </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#get_uri">get_uri</a></td><td>Retrieves the URI set using gtk_link_button_set_uri(). </td></tr>
<tr><td><a href="#get_visited">get_visited</a></td><td>Retrieves the 'visited' state of the URI where the GtkLinkButton points. </td></tr>
<tr><td><a href="#new_with_label">new_with_label</a></td><td>Creates a new GtkLinkButton containing a label. </td></tr>
<tr><td><a href="#set_uri">set_uri</a></td><td>Sets uri as the URI where the GtkLinkButton points. </td></tr>
<tr><td><a href="#set_uri_hook">set_uri_hook</a></td><td>Sets func as the function that should be invoked every time a user clicks a GtkLinkButton. </td></tr>
<tr><td><a href="#set_visited">set_visited</a></td><td>Sets the 'visited' state of the URI where the GtkLinkButton points. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="get_uri">get_uri</a></h3><p class="brief">Retrieves the URI set using gtk_link_button_set_uri(). </p>
<pre class="prototype">GtkLinkButton.get_uri()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a valid URI </td></tr>
</tbody>
</table>
<h3><a name="get_visited">get_visited</a></h3><p class="brief">Retrieves the 'visited' state of the URI where the GtkLinkButton points. </p>
<pre class="prototype">GtkLinkButton.get_visited()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if the link has been visited, FALSE otherwise </td></tr>
</tbody>
</table>
<p>The button becomes visited when it is clicked. If the URI is changed on the button, the 'visited' state is unset again. </p>
<p>The state may also be changed using gtk_link_button_set_visited(). </p>
<h3><a name="new_with_label">new_with_label</a></h3><p class="brief">Creates a new GtkLinkButton containing a label. </p>
<pre class="prototype">GtkLinkButton.new_with_label( uri, label )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">uri</td><td class="content"> a valid URI </td></tr>
<tr class="param"><td class="name">label</td><td class="content"> the text of the button (or nil). </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">a new link button widget </td></tr>
</tbody>
</table>
<h3><a name="set_uri">set_uri</a></h3><p class="brief">Sets uri as the URI where the GtkLinkButton points. </p>
<pre class="prototype">GtkLinkButton.set_uri( uri )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">uri</td><td class="content"> a valid URI. </td></tr>
</tbody>
</table>
<p>As a side-effect this unsets the 'visited' state of the button. </p>
<h3><a name="set_uri_hook">set_uri_hook</a></h3><p class="brief">Sets func as the function that should be invoked every time a user clicks a GtkLinkButton. </p>
<pre class="prototype">GtkLinkButton.set_uri_hook( func, user )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">func</td><td class="content"> a function called each time a GtkLinkButton is clicked, or NULL. </td></tr>
<tr class="param"><td class="name">user</td><td class="content"> data to be passed to func, or NULL. </td></tr>
</tbody>
</table>
<p>This function is called before every callback registered for the "clicked" signal. </p>
<p>The function will get the button object as first parameter, the activated link as second parameter (string), and user data as third parameter. </p>
<p>If no uri hook has been set, GTK+ defaults to calling gtk_show_uri(). </p>
<h3><a name="set_visited">set_visited</a></h3><p class="brief">Sets the 'visited' state of the URI where the GtkLinkButton points. </p>
<pre class="prototype">GtkLinkButton.set_visited( visited )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">visited</td><td class="content"> the new 'visited' state </td></tr>
</tbody>
</table>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkLayout.html">Previous: Class GtkLayout</a></li>
<li class="next"><a href="gtk_GtkListStore.html">Next: Class GtkListStore</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
