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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkExpander
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A container which can hide its child
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkExpander allows the user to hide or show its child by clicking on an expander triangle similar to
  10 the triangles used in a #GtkTreeView.
  11 </para>
  12
  13   <para>
  14     Normally you use an expander as you would use any other descendant
  15     of #GtkBin; you create the child widget and use
  16     gtk_container_add() to add it to the expander.  When the expander
  17     is toggled, it will take care of showing and hiding the child
  18     automatically.
  19   </para>
  20
  21   <section id="expander-special-usage">
  22     <title>Special Usage</title>
  23
  24     <para>
  25       There are situations in which you may prefer to show and
  26       hide the expanded widget yourself, such as when you want to
  27       actually create the widget at expansion time.  In this case,
  28       create a #GtkExpander but do not add a child to it.  The
  29       expander widget has an <literal>expanded</literal> property
  30       which can be used to monitor its expansion state.  You should
  31       watch this property with a signal connection as follows:
  32     </para>
  33
  34     <programlisting id="expander-callback-example">
  35 expander = gtk_expander_new_with_mnemonic ("_More Options");
  36 g_signal_connect (expander, "notify::expanded",
  37                   G_CALLBACK (expander_callback), NULL);
  38
  39 ...
  40
  41 static void
  42 expander_callback (GObject    *object,
  43                    GParamSpec *param_spec,
  44                    gpointer    user_data)
  45 {
  46   GtkExpander *expander;
  47
  48   expander = GTK_EXPANDER (object);
  49
  50   if (gtk_expander_get_expanded (expander))
  51     {
  52       /* Show or create widgets */
  53     }
  54   else
  55     {
  56       /* Hide or destroy widgets */
  57     }
  58 }
  59
  60     </programlisting>
  61   </section>
  62
  63 <!-- ##### SECTION See_Also ##### -->
  64 <para>
  65
  66 </para>
  67
  68 <!-- ##### STRUCT GtkExpander ##### -->
  69 <para>
  70
  71 </para>
  72
  73
  74 <!-- ##### SIGNAL GtkExpander::activate ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @expander: the object which received the signal.
  80
  81 <!-- ##### ARG GtkExpander:expanded ##### -->
  82 <para>
  83
  84 </para>
  85
  86 <!-- ##### ARG GtkExpander:label ##### -->
  87 <para>
  88
  89 </para>
  90
  91 <!-- ##### ARG GtkExpander:label-widget ##### -->
  92 <para>
  93
  94 </para>
  95
  96 <!-- ##### ARG GtkExpander:spacing ##### -->
  97 <para>
  98
  99 </para>
 100
 101 <!-- ##### ARG GtkExpander:use-markup ##### -->
 102 <para>
 103
 104 </para>
 105
 106 <!-- ##### ARG GtkExpander:use-underline ##### -->
 107 <para>
 108
 109 </para>
 110
 111 <!-- ##### ARG GtkExpander:expander-size ##### -->
 112 <para>
 113
 114 </para>
 115
 116 <!-- ##### ARG GtkExpander:expander-spacing ##### -->
 117 <para>
 118
 119 </para>
 120
 121 <!-- ##### FUNCTION gtk_expander_new ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @label:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION gtk_expander_new_with_mnemonic ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @label:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gtk_expander_set_expanded ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @expander:
 145 @expanded:
 146
 147
 148 <!-- ##### FUNCTION gtk_expander_get_expanded ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @expander:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION gtk_expander_set_spacing ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @expander:
 163 @spacing:
 164
 165
 166 <!-- ##### FUNCTION gtk_expander_get_spacing ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @expander:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION gtk_expander_set_label ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @expander:
 181 @label:
 182
 183
 184 <!-- ##### FUNCTION gtk_expander_get_label ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @expander:
 190 @Returns:
 191
 192
 193 <!-- ##### FUNCTION gtk_expander_set_use_underline ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @expander:
 199 @use_underline:
 200
 201
 202 <!-- ##### FUNCTION gtk_expander_get_use_underline ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @expander:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION gtk_expander_set_use_markup ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @expander:
 217 @use_markup:
 218
 219
 220 <!-- ##### FUNCTION gtk_expander_get_use_markup ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @expander:
 226 @Returns:
 227
 228
 229 <!-- ##### FUNCTION gtk_expander_set_label_widget ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @expander:
 235 @label_widget:
 236
 237
 238 <!-- ##### FUNCTION gtk_expander_get_label_widget ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @expander:
 244 @Returns:
 245
 246