Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtklinkbutton.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkLinkButton
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Create buttons bound to a URL
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkLinkButton is a #GtkButton with a hyperlink, similar to the one
  10 used by web browsers, which triggers an action when clicked. It is useful
  11 to show quick links to resources.
  12 </para>
  13
  14 <para>
  15 A link button is created by calling either gtk_link_button_new() or
  16 gtk_link_button_new_with_label(). If using the former, the URI you pass
  17 to the constructor is used as a label for the widget.
  18 </para>
  19
  20 <para>
  21 The URI bound to a #GtkLinkButton can be set specifically using
  22 gtk_link_button_set_uri(), and retrieved using gtk_link_button_get_uri().
  23 </para>
  24
  25 <para>
  26 #GtkLinkButton offers a global hook, which is called when the used clicks
  27 on it: see gtk_link_button_set_uri_hook().
  28 </para>
  29
  30 <para>
  31 #GtkLinkButton was added in GTK+ 2.10.
  32 </para>
  33
  34 <!-- ##### SECTION See_Also ##### -->
  35 <para>
  36 #GtkButton
  37 </para>
  38
  39
  40 <!-- ##### SECTION Stability_Level ##### -->
  41
  42
  43 <!-- ##### STRUCT GtkLinkButton ##### -->
  44 <para>
  45 The #GtkLinkButton struct contains private data only, and should be
  46 manipulated using the functions below.
  47 </para>
  48
  49
  50 <!-- ##### ARG GtkLinkButton:uri ##### -->
  51 <para>
  52
  53 </para>
  54
  55 <!-- ##### FUNCTION gtk_link_button_new ##### -->
  56 <para>
  57
  58 </para>
  59
  60 @uri:
  61 @Returns:
  62
  63
  64 <!-- ##### FUNCTION gtk_link_button_new_with_label ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @uri:
  70 @label:
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION gtk_link_button_get_uri ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @link_button:
  80 @Returns:
  81
  82
  83 <!-- ##### FUNCTION gtk_link_button_set_uri ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @link_button:
  89 @uri:
  90
  91
  92 <!-- ##### USER_FUNCTION GtkLinkButtonUriFunc ##### -->
  93 <para>
  94 The type of a function which is called when the #GtkLinkButton is
  95 clicked.
  96 </para>
  97
  98 @button: the #GtkLinkButton which was clicked
  99 @link: the URI to which the clicked #GtkLinkButton points
 100 @data: user data that was passed when the function was registered
 101   with gtk_link_button_set_uri_hook()
 102
 103
 104 <!-- ##### FUNCTION gtk_link_button_set_uri_hook ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @func:
 110 @data:
 111 @destroy:
 112 @Returns:
 113
 114