summaryrefslogtreecommitdiff
path: root/gtk/gtkassistant.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2010-10-30 21:25:21 -0400
committerMatthias Clasen <mclasen@redhat.com>2010-10-30 21:30:23 -0400
commitc5e9526faf218a0ed1873d7e337052295b155e26 (patch)
treef2af11c338afef1750cbc66c6b3d60df4d72a30d /gtk/gtkassistant.c
parentcdda7f91515ada8cd56de95feb122829b62d53a1 (diff)
downloadgtk+-c5e9526faf218a0ed1873d7e337052295b155e26.tar.gz
Improve GtkAssistant docs
Diffstat (limited to 'gtk/gtkassistant.c')
-rw-r--r--gtk/gtkassistant.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/gtk/gtkassistant.c b/gtk/gtkassistant.c
index 3fc0616bb0..10241a399f 100644
--- a/gtk/gtkassistant.c
+++ b/gtk/gtkassistant.c
@@ -32,6 +32,13 @@
* operation splitted in several steps, guiding the user through its pages
* and controlling the page flow to collect the necessary data.
*
+ * The design of GtkAssistant is that it controls what buttons to show and
+ * to make sensitive, based on what it knows about the page sequence and
+ * the <link linkend="GtkAssistantPageType">type</link> of each page, in
+ * addition to state information like the page
+ * <link linkend="gtk-assistant-set-page-complete">completion</link> and
+ * <link linkend="gtk-assistant-commit">committed</link> status.
+ *
* <refsect2 id="GtkAssistant-BUILDER-UI">
* <title>GtkAssistant as GtkBuildable</title>
* <para>