Commit 7f504fdf authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkFrame

parent 1263fdbd
...@@ -37,6 +37,7 @@ gtkfixed.sgml ...@@ -37,6 +37,7 @@ gtkfixed.sgml
gtkfilechooserwidget.sgml gtkfilechooserwidget.sgml
gtkfilefilter.sgml gtkfilefilter.sgml
gtkfontbutton.sgml gtkfontbutton.sgml
gtkframe.sgml
gtkhbox.sgml gtkhbox.sgml
gtkhpaned.sgml gtkhpaned.sgml
gtkhscale.sgml gtkhscale.sgml
......
<!-- ##### SECTION Title ##### -->
GtkFrame
<!-- ##### SECTION Short_Description ##### -->
A bin with a decorative frame and optional label
<!-- ##### SECTION Long_Description ##### -->
<para>
The frame widget is a Bin that surrounds its child
with a decorative frame and an optional label.
If present, the label is drawn in a gap in the
top side of the frame. The position of the
label can be controlled with gtk_frame_set_label_align().
</para>
<refsect2 id="GtkFrame-BUILDER-UI">
<title>GtkFrame as GtkBuildable</title>
<para>
The GtkFrame implementation of the GtkBuildable interface
supports placing a child in the label position by specifying
"label" as the "type" attribute of a &lt;child&gt; element.
A normal content child can be specified without specifying
a &lt;child&gt; type attribute.
</para>
<example>
<title>A UI definition fragment with GtkFrame</title>
<programlisting><![CDATA[
<object class="GtkFrame">
<child type="label">
<object class="GtkLabel" id="frame-label"/>
</child>
<child>
<object class="GtkEntry" id="frame-content"/>
</child>
</object>
]]></programlisting>
</example>
</refsect2>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkFrame ##### -->
<para>
</para>
<!-- ##### ARG GtkFrame:label ##### -->
<para>
</para>
<!-- ##### ARG GtkFrame:label-widget ##### -->
<para>
</para>
<!-- ##### ARG GtkFrame:label-xalign ##### -->
<para>
</para>
<!-- ##### ARG GtkFrame:label-yalign ##### -->
<para>
</para>
<!-- ##### ARG GtkFrame:shadow-type ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_frame_new ##### -->
<para>
</para>
@label:
@Returns:
<!-- ##### FUNCTION gtk_frame_set_label ##### -->
<para>
</para>
@frame:
@label:
<!-- ##### FUNCTION gtk_frame_set_label_widget ##### -->
<para>
</para>
@frame:
@label_widget:
<!-- ##### FUNCTION gtk_frame_set_label_align ##### -->
<para>
</para>
@frame:
@xalign:
@yalign:
<!-- ##### FUNCTION gtk_frame_set_shadow_type ##### -->
<para>
</para>
@frame:
@type:
<!-- ##### FUNCTION gtk_frame_get_label ##### -->
<para>
</para>
@frame:
@Returns:
<!-- ##### FUNCTION gtk_frame_get_label_align ##### -->
<para>
</para>
@frame:
@xalign:
@yalign:
<!-- ##### FUNCTION gtk_frame_get_label_widget ##### -->
<para>
</para>
@frame:
@Returns:
<!-- ##### FUNCTION gtk_frame_get_shadow_type ##### -->
<para>
</para>
@frame:
@Returns:
...@@ -324,3 +324,21 @@ Emits the "toggle_size_allocate" signal on the given item. ...@@ -324,3 +324,21 @@ Emits the "toggle_size_allocate" signal on the given item.
@allocation: the allocation to use as signal data. @allocation: the allocation to use as signal data.
<!-- ##### FUNCTION gtk_menu_item_get_reserve_indicator ##### -->
<para>
</para>
@menu_item:
@Returns:
<!-- ##### FUNCTION gtk_menu_item_set_reserve_indicator ##### -->
<para>
</para>
@menu_item:
@reserve:
...@@ -34,6 +34,43 @@ ...@@ -34,6 +34,43 @@
#include "gtkbuildable.h" #include "gtkbuildable.h"
/**
* SECTION:gtkframe
* @Short_description: A bin with a decorative frame and optional label
* @Title: GtkFrame
*
* The frame widget is a Bin that surrounds its child
* with a decorative frame and an optional label.
* If present, the label is drawn in a gap in the
* top side of the frame. The position of the
* label can be controlled with gtk_frame_set_label_align().
*
* <refsect2 id="GtkFrame-BUILDER-UI">
* <title>GtkFrame as GtkBuildable</title>
* <para>
* The GtkFrame implementation of the GtkBuildable interface
* supports placing a child in the label position by specifying
* "label" as the "type" attribute of a &lt;child&gt; element.
* A normal content child can be specified without specifying
* a &lt;child&gt; type attribute.
* </para>
* <example>
* <title>A UI definition fragment with GtkFrame</title>
* <programlisting><![CDATA[
* <object class="GtkFrame">
* <child type="label">
* <object class="GtkLabel" id="frame-label"/>
* </child>
* <child>
* <object class="GtkEntry" id="frame-content"/>
* </child>
* </object>
* ]]></programlisting>
* </example>
* </refsect2>
*/
#define LABEL_PAD 1 #define LABEL_PAD 1
#define LABEL_SIDE_PAD 2 #define LABEL_SIDE_PAD 2
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment