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 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 <!-- ##### FUNCTION gtk_expander_new ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @label:
  80 @Returns:
  81
  82
  83 <!-- ##### FUNCTION gtk_expander_new_with_mnemonic ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @label:
  89 @Returns:
  90
  91
  92 <!-- ##### FUNCTION gtk_expander_set_expanded ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @expander:
  98 @expanded:
  99
 100
 101 <!-- ##### FUNCTION gtk_expander_get_expanded ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @expander:
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION gtk_expander_set_spacing ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @expander:
 116 @spacing:
 117
 118
 119 <!-- ##### FUNCTION gtk_expander_get_spacing ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @expander:
 125 @Returns:
 126
 127
 128 <!-- ##### FUNCTION gtk_expander_set_label ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @expander:
 134 @label:
 135
 136
 137 <!-- ##### FUNCTION gtk_expander_get_label ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @expander:
 143 @Returns:
 144
 145
 146 <!-- ##### FUNCTION gtk_expander_set_use_underline ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @expander:
 152 @use_underline:
 153
 154
 155 <!-- ##### FUNCTION gtk_expander_get_use_underline ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @expander:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION gtk_expander_set_use_markup ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @expander:
 170 @use_markup:
 171
 172
 173 <!-- ##### FUNCTION gtk_expander_get_use_markup ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @expander:
 179 @Returns:
 180
 181
 182 <!-- ##### FUNCTION gtk_expander_set_label_widget ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @expander:
 188 @label_widget:
 189
 190
 191 <!-- ##### FUNCTION gtk_expander_get_label_widget ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @expander:
 197 @Returns:
 198
 199
 200 <!-- ##### SIGNAL GtkExpander::activate ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @expander: the object which received the signal.
 206
 207 <!-- ##### ARG GtkExpander:expanded ##### -->
 208 <para>
 209
 210 </para>
 211
 212 <!-- ##### ARG GtkExpander:label ##### -->
 213 <para>
 214
 215 </para>
 216
 217 <!-- ##### ARG GtkExpander:label-widget ##### -->
 218 <para>
 219
 220 </para>
 221
 222 <!-- ##### ARG GtkExpander:spacing ##### -->
 223 <para>
 224
 225 </para>
 226
 227 <!-- ##### ARG GtkExpander:use-markup ##### -->
 228 <para>
 229
 230 </para>
 231
 232 <!-- ##### ARG GtkExpander:use-underline ##### -->
 233 <para>
 234
 235 </para>
 236
 237 <!-- ##### ARG GtkExpander:expander-size ##### -->
 238 <para>
 239
 240 </para>
 241
 242 <!-- ##### ARG GtkExpander:expander-spacing ##### -->
 243 <para>
 244
 245 </para>
 246