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 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### STRUCT GtkFrame ##### -->
  22 <para>
  23
  24 </para>
  25
  26
  27 <!-- ##### FUNCTION gtk_frame_new ##### -->
  28 <para>
  29 Create a new Frame, with optional label @label.
  30 If @label is %NULL, the label is omitted.
  31 </para>
  32
  33 @label:
  34 @Returns:
  35
  36
  37 <!-- ##### FUNCTION gtk_frame_set_label ##### -->
  38 <para>
  39
  40 Set the text of the label. If @label is %NULL,
  41 the current label, if any, is removed.
  42 </para>
  43
  44 @frame:
  45 @label:
  46
  47
  48 <!-- ##### FUNCTION gtk_frame_set_label_widget ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @frame:
  54 @label_widget:
  55 <!-- # Unused Parameters # -->
  56 @title_widget:
  57
  58
  59 <!-- ##### FUNCTION gtk_frame_set_label_align ##### -->
  60 <para>
  61 Set the alignment of the Frame widget's label. The
  62 default value for a newly created Frame is 0.0.
  63 </para>
  64
  65 @frame: The Frame widget.
  66 @xalign: The position of the label along the top edge
  67   of the widget. A value of 0.0 represents left alignment;
  68   1.0 represents right alignment.
  69 @yalign: The y alignment of the label. Currently ignored.
  70
  71
  72 <!-- ##### FUNCTION gtk_frame_set_shadow_type ##### -->
  73 <para>
  74 Set the shadow type for the Frame widget.
  75 </para>
  76
  77 @frame: The Frame widget.
  78 @type: New shadow type.
  79
  80
  81 <!-- ##### FUNCTION gtk_frame_get_label ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @frame:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION gtk_frame_get_label_align ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @frame:
  96 @xalign:
  97 @yalign:
  98
  99
 100 <!-- ##### FUNCTION gtk_frame_get_label_widget ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @frame:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION gtk_frame_get_shadow_type ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @frame:
 115 @Returns:
 116
 117
 118 <!-- ##### ARG GtkFrame:label ##### -->
 119 <para>
 120
 121 </para>
 122
 123 <!-- ##### ARG GtkFrame:label-xalign ##### -->
 124 <para>
 125
 126 </para>
 127
 128 <!-- ##### ARG GtkFrame:label-yalign ##### -->
 129 <para>
 130
 131 </para>
 132
 133 <!-- ##### ARG GtkFrame:shadow ##### -->
 134 <para>
 135
 136 </para>
 137
 138 <!-- ##### ARG GtkFrame:shadow-type ##### -->
 139 <para>
 140
 141 </para>
 142
 143 <!-- ##### ARG GtkFrame:label-widget ##### -->
 144 <para>
 145
 146 </para>
 147