summaryrefslogtreecommitdiff
path: root/gtk/gtkorientable.c
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2010-05-13 03:35:02 +0200
committerJavier Jardón <jjardon@gnome.org>2010-05-13 03:35:02 +0200
commit95bb12ee66436654d9cd99b35315bd917357a528 (patch)
treee4aee92e43e56d188056f774aa4de2738a6acf05 /gtk/gtkorientable.c
parent8319585673632a67ec130de3a9c5c71db1da8c5c (diff)
downloadgtk+-95bb12ee66436654d9cd99b35315bd917357a528.tar.gz
Move documentation to inline comments: GtkOrientable
Diffstat (limited to 'gtk/gtkorientable.c')
-rw-r--r--gtk/gtkorientable.c16
1 files changed, 16 insertions, 0 deletions
diff --git a/gtk/gtkorientable.c b/gtk/gtkorientable.c
index 95102cb5d9..636f65da8f 100644
--- a/gtk/gtkorientable.c
+++ b/gtk/gtkorientable.c
@@ -29,6 +29,22 @@
#include "gtkalias.h"
+/**
+ * SECTION:gtkorientable
+ * @Short_description: An interface for flippable widgets
+ * @Title: GtkOrientable
+ *
+ * The #GtkOrientable interface is implemented by all widgets that can be
+ * oriented horizontally or vertically. Historically, such widgets have been
+ * realized as subclasses of a common base class (e.g #GtkBox/#GtkHBox/#GtkVBox
+ * or #GtkScale/#GtkHScale/#GtkVScale). #GtkOrientable is more flexible in that
+ * it allows the orientation to be changed at runtime, allowing the widgets
+ * to 'flip'.
+ *
+ * #GtkOrientable was introduced in GTK+ 2.16.
+ */
+
+
typedef GtkOrientableIface GtkOrientableInterface;
G_DEFINE_INTERFACE (GtkOrientable, gtk_orientable, G_TYPE_OBJECT)