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   <varlistentry>
  23     <term>#GtkToolbar</term>
  24     <listitem><para>The toolbar widget</para></listitem>
  25     <term>#GtkToolButton</term>
  26     <listitem>
  27       <para>
  28         The parent class of #GtkToggleToolButton. The properties
  29         "label_widget", "label", "icon_widget", and "stock_id" on
  30         #GtkToolButton determine the label and icon used on
  31         #GtkToggleToolButton<!-- -->s.
  32       </para>
  33     </listitem>
  34     <term>#GtkSeparatorToolItem</term>
  35     <listitem>
  36       <para>A subclass of #GtkToolItem that separates groups of
  37         items on a toolbar.
  38       </para>
  39     </listitem>
  40   </varlistentry>
  41 </para>
  42
  43 <!-- ##### STRUCT GtkToggleToolButton ##### -->
  44 <para>
  45   The #GtkToggleToolButton struct contains only private data and
  46   should only be accessed through the functions described below.
  47 </para>
  48
  49
  50 <!-- ##### SIGNAL GtkToggleToolButton::toggled ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @toggletoolbutton: the object which received the signal.
  56
  57 <!-- ##### FUNCTION gtk_toggle_tool_button_new ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @Returns:
  63
  64
  65 <!-- ##### FUNCTION gtk_toggle_tool_button_new_from_stock ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @stock_id:
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION gtk_toggle_tool_button_set_active ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @button:
  80 @is_active:
  81
  82
  83 <!-- ##### FUNCTION gtk_toggle_tool_button_get_active ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @button:
  89 @Returns:
  90
  91