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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkToggleToolButton
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A GtkToolItem containing a toggle button
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9   A #GtkToggleToolButton is a #GtkToolItem that contains a toggle
  10   button.
  11 </para>
  12
  13 <para>
  14   Use gtk_toggle_tool_button_new() to create a new
  15   #GtkToggleToolButton. Use gtk_toggle_tool_button_new_from_stock() to
  16   create a new #GtkToggleToolButton containing a stock item.
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20
  21 <para>
  22   <variablelist>
  23     <varlistentry>
  24       <term>#GtkToolbar</term>
  25       <listitem><para>The toolbar widget</para></listitem>
  26       <term>#GtkToolButton</term>
  27       <listitem>
  28         <para>
  29           The parent class of #GtkToggleToolButton. The properties
  30           "label_widget", "label", "icon_widget", and "stock_id" on
  31           #GtkToolButton determine the label and icon used on
  32           #GtkToggleToolButton<!-- -->s.
  33         </para>
  34       </listitem>
  35       <term>#GtkSeparatorToolItem</term>
  36       <listitem>
  37         <para>A subclass of #GtkToolItem that separates groups of
  38           items on a toolbar.
  39         </para>
  40       </listitem>
  41     </varlistentry>
  42   </variablelist>
  43 </para>
  44
  45 <!-- ##### SECTION Stability_Level ##### -->
  46
  47
  48 <!-- ##### SECTION Image ##### -->
  49
  50
  51 <!-- ##### STRUCT GtkToggleToolButton ##### -->
  52 <para>
  53   The #GtkToggleToolButton struct contains only private data and
  54   should only be accessed through the functions described below.
  55 </para>
  56
  57
  58 <!-- ##### SIGNAL GtkToggleToolButton::toggled ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @toggletoolbutton: the object which received the signal.
  64
  65 <!-- ##### ARG GtkToggleToolButton:active ##### -->
  66 <para>
  67
  68 </para>
  69
  70 <!-- ##### FUNCTION gtk_toggle_tool_button_new ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @void:
  76 @Returns:
  77
  78
  79 <!-- ##### FUNCTION gtk_toggle_tool_button_new_from_stock ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @stock_id:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION gtk_toggle_tool_button_set_active ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @button:
  94 @is_active:
  95
  96
  97 <!-- ##### FUNCTION gtk_toggle_tool_button_get_active ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @button:
 103 @Returns:
 104
 105