summaryrefslogtreecommitdiff
path: root/gtk/gtklinkbutton.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2010-09-24 13:41:29 -0400
committerMatthias Clasen <mclasen@redhat.com>2010-09-24 13:41:29 -0400
commitcc9ac5b7eaeb93578e9e12059648400ec76b1a3f (patch)
treea4690d07970e3b3c1befced4f608d83cab4f1405 /gtk/gtklinkbutton.c
parentbc6a3f8cd8c3ead617f9860b1d8ad177b49f606c (diff)
downloadgtk+-cc9ac5b7eaeb93578e9e12059648400ec76b1a3f.tar.gz
Update docs of GtkAboutDialog and GtkLinkButton
Remove references to global hooks from the docs. Also move remaining docs inline, and remove the templates.
Diffstat (limited to 'gtk/gtklinkbutton.c')
-rw-r--r--gtk/gtklinkbutton.c22
1 files changed, 22 insertions, 0 deletions
diff --git a/gtk/gtklinkbutton.c b/gtk/gtklinkbutton.c
index 85de592c0f..027c7ee524 100644
--- a/gtk/gtklinkbutton.c
+++ b/gtk/gtklinkbutton.c
@@ -22,6 +22,28 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Cambridge, MA 02139, USA.
*/
+/**
+ * SECTION:gtklinkbutton
+ * @Title: GtkLinkButton
+ * @Short_description: Create buttons bound to a URL
+ * @See_also: #GtkButton
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * The URI bound to a GtkLinkButton can be set specifically using
+ * gtk_link_button_set_uri(), and retrieved using gtk_link_button_get_uri().
+ *
+ * By default, GtkLinkButton calls gtk_show_uri() when the button is
+ * clicked. This behaviour can be overridden by connecting to the
+ * #GtkButton::clicked signal.
+ */
+
#include "config.h"
#include "gtklinkbutton.h"