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 <!-- ##### SECTION Stability_Level ##### -->
  40
  41
  42 <!-- ##### STRUCT GtkLinkButton ##### -->
  43 <para>
  44 The #GtkLinkButton struct contains private data only, and should be
  45 manipulated using the functions below.
  46 </para>
  47
  48
  49 <!-- ##### ARG GtkLinkButton:uri ##### -->
  50 <para>
  51
  52 </para>
  53
  54 <!-- ##### ARG GtkLinkButton:visited ##### -->
  55 <para>
  56
  57 </para>
  58
  59 <!-- ##### FUNCTION gtk_link_button_new ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @uri:
  65 @Returns:
  66
  67
  68 <!-- ##### FUNCTION gtk_link_button_new_with_label ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @uri:
  74 @label:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION gtk_link_button_get_uri ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @link_button:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION gtk_link_button_set_uri ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @link_button:
  93 @uri:
  94
  95
  96 <!-- ##### USER_FUNCTION GtkLinkButtonUriFunc ##### -->
  97 <para>
  98 The type of a function which is called when the #GtkLinkButton is
  99 clicked.
 100 </para>
 101
 102 @button: the #GtkLinkButton which was clicked
 103 @link_:
 104 @user_data: user data that was passed when the function was registered
 105   with gtk_link_button_set_uri_hook()
 106 <!-- # Unused Parameters # -->
 107 @link: the URI to which the clicked #GtkLinkButton points
 108
 109
 110 <!-- ##### FUNCTION gtk_link_button_set_uri_hook ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @func:
 116 @data:
 117 @destroy:
 118 @Returns:
 119
 120