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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkFrame
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A bin with a decorative frame and optional label
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The frame widget is a Bin that surrounds its child
  10 with a decorative frame and an optional label.
  11 If present, the label is drawn in a gap in the
  12 top side of the frame. The position of the
  13 label can be controlled with gtk_frame_set_label_align().
  14 </para>
  15
  16 <refsect2 id="GtkFrame-BUILDER-UI">
  17 <title>GtkFrame as GtkBuildable</title>
  18 <para>
  19 The GtkFrame implementation of the GtkBuildable interface
  20 supports placing a child in the label position by specifying
  21 "label" as the "type" attribute of a &lt;child&gt; element.
  22 A normal content child can be specified without specifying
  23 a &lt;child&gt; type attribute.
  24 </para>
  25 <example>
  26 <title>A UI definition fragment with GtkFrame</title>
  27 <programlisting><![CDATA[
  28 <object class="GtkFrame">
  29   <child type="label">
  30     <object class="GtkLabel" id="frame-label"/>
  31   </child>
  32   <child>
  33     <object class="GtkEntry" id="frame-content"/>
  34   </child>
  35 </object>
  36 ]]></programlisting>
  37 </example>
  38 </refsect2>
  39
  40 <!-- ##### SECTION See_Also ##### -->
  41 <para>
  42
  43 </para>
  44
  45 <!-- ##### SECTION Stability_Level ##### -->
  46
  47
  48 <!-- ##### STRUCT GtkFrame ##### -->
  49 <para>
  50
  51 </para>
  52
  53
  54 <!-- ##### ARG GtkFrame:label ##### -->
  55 <para>
  56
  57 </para>
  58
  59 <!-- ##### ARG GtkFrame:label-widget ##### -->
  60 <para>
  61
  62 </para>
  63
  64 <!-- ##### ARG GtkFrame:label-xalign ##### -->
  65 <para>
  66
  67 </para>
  68
  69 <!-- ##### ARG GtkFrame:label-yalign ##### -->
  70 <para>
  71
  72 </para>
  73
  74 <!-- ##### ARG GtkFrame:shadow ##### -->
  75 <para>
  76
  77 </para>
  78
  79 <!-- ##### ARG GtkFrame:shadow-type ##### -->
  80 <para>
  81
  82 </para>
  83
  84 <!-- ##### FUNCTION gtk_frame_new ##### -->
  85 <para>
  86 </para>
  87
  88 @label:
  89 @Returns:
  90
  91
  92 <!-- ##### FUNCTION gtk_frame_set_label ##### -->
  93 <para>
  94 </para>
  95
  96 @frame:
  97 @label:
  98
  99
 100 <!-- ##### FUNCTION gtk_frame_set_label_widget ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @frame:
 106 @label_widget:
 107
 108
 109 <!-- ##### FUNCTION gtk_frame_set_label_align ##### -->
 110 <para>
 111 </para>
 112
 113 @frame:
 114 @xalign:
 115 @yalign:
 116
 117
 118 <!-- ##### FUNCTION gtk_frame_set_shadow_type ##### -->
 119 <para>
 120 </para>
 121
 122 @frame:
 123 @type:
 124
 125
 126 <!-- ##### FUNCTION gtk_frame_get_label ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @frame:
 132 @Returns:
 133
 134
 135 <!-- ##### FUNCTION gtk_frame_get_label_align ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @frame:
 141 @xalign:
 142 @yalign:
 143
 144
 145 <!-- ##### FUNCTION gtk_frame_get_label_widget ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @frame:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION gtk_frame_get_shadow_type ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @frame:
 160 @Returns:
 161
 162