[gtk+] Move documentation to inline comments: GtkFrame
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Move documentation to inline comments: GtkFrame
- Date: Wed, 13 Apr 2011 01:14:40 +0000 (UTC)
commit 7f504fdfa00c954ab29cda6010be493d8c0b12fd
Author: Javier Jardón <jjardon gnome org>
Date: Wed Apr 13 00:49:30 2011 +0100
Move documentation to inline comments: GtkFrame
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtkframe.sgml | 160 ------------------------------
docs/reference/gtk/tmpl/gtkmenuitem.sgml | 18 ++++
gtk/gtkframe.c | 37 +++++++
4 files changed, 56 insertions(+), 160 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 1ceddcf..6ac20b6 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -37,6 +37,7 @@ gtkfixed.sgml
gtkfilechooserwidget.sgml
gtkfilefilter.sgml
gtkfontbutton.sgml
+gtkframe.sgml
gtkhbox.sgml
gtkhpaned.sgml
gtkhscale.sgml
diff --git a/docs/reference/gtk/tmpl/gtkmenuitem.sgml b/docs/reference/gtk/tmpl/gtkmenuitem.sgml
index 83a554f..881646e 100644
--- a/docs/reference/gtk/tmpl/gtkmenuitem.sgml
+++ b/docs/reference/gtk/tmpl/gtkmenuitem.sgml
@@ -324,3 +324,21 @@ Emits the "toggle_size_allocate" signal on the given item.
@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:
+
+
diff --git a/gtk/gtkframe.c b/gtk/gtkframe.c
index 62e0dc1..5f201cc 100644
--- a/gtk/gtkframe.c
+++ b/gtk/gtkframe.c
@@ -34,6 +34,43 @@
#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 <child> element.
+ * A normal content child can be specified without specifying
+ * a <child> 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_SIDE_PAD 2
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]