From 5f767e2c48080d59b55879ac7b9b642dd0e42b0f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tadej=20Borov=C5=A1ak?= Date: Fri, 5 Mar 2010 23:44:31 +0100 Subject: [PATCH] [docs] Move documentation to inline comments: GtkAssistant MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Javier Jardón --- docs/reference/gtk/tmpl/gtkassistant.sgml | 344 ---------------------- gtk/gtkassistant.c | 24 +- gtk/gtkassistant.h | 30 ++ 3 files changed, 53 insertions(+), 345 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkassistant.sgml diff --git a/docs/reference/gtk/tmpl/gtkassistant.sgml b/docs/reference/gtk/tmpl/gtkassistant.sgml deleted file mode 100644 index ab00eee54..000000000 --- a/docs/reference/gtk/tmpl/gtkassistant.sgml +++ /dev/null @@ -1,344 +0,0 @@ - -GtkAssistant - - -A widget used to guide users through multi-step operations - - - -A #GtkAssistant is a widget used to represent a generally complex -operation splitted in several steps, guiding the user through its pages -and controlling the page flow to collect the necessary data. - -GtkAssistant as GtkBuildable - -The GtkAssistant implementation of the GtkBuildable interface exposes the -@action_area as internal children with the name "action_area". - - -To add pages to an assistant in GtkBuilder, simply add it as a <child> -to the GtkAssistant object, and set its child properties as necessary. - - - - - - - - - - - - - - - - - - - - - - -@assistant: the object which received the signal. - - - - - - -@assistant: the object which received the signal. - - - - - - -@assistant: the object which received the signal. - - - - - - -@assistant: the object which received the signal. -@widget: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@Returns: - - - - - - - -@assistant: -@Returns: - - - - - - - -@assistant: -@page_num: - - - - - - - -@assistant: -@Returns: - - - - - - - -@assistant: -@page_num: -@Returns: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@page: -@position: -@Returns: - - - - -A function used by gtk_assistant_set_forward_page_func() to know which -is the next page given a current one. It's called both for computing the -next page when the user presses the "forward" button and for handling -the behavior of the "last" button. - - -@current_page: The page number used to calculate the next page. -@data: user data. -@Returns: The next page number. - - - - - - - -@assistant: -@page_func: -@data: -@destroy: - - - - -An enum for determining the page role inside the #GtkAssistant. It's used to -handle buttons sensitivity and visibility. - - - -Note that an assistant needs to end its page flow with a page of type GTK_ASSISTANT_PAGE_CONFIRM -or GTK_ASSISTANT_PAGE_SUMMARY to be correct. - - -@GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents. -@GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the assistant task. -@GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the changes. -@GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes done. -@GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to complete, blocks the assistant until the page is marked as complete. - - - - - - -@assistant: -@page: -@type: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@page: -@title: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@page: -@pixbuf: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@page: -@pixbuf: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@page: -@complete: - - - - - - - -@assistant: -@page: -@Returns: - - - - - - - -@assistant: -@child: - - - - - - - -@assistant: -@child: - - - - - - - -@assistant: - - diff --git a/gtk/gtkassistant.c b/gtk/gtkassistant.c index 1e2c3ce43..41ecd1311 100644 --- a/gtk/gtkassistant.c +++ b/gtk/gtkassistant.c @@ -23,6 +23,28 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gtkassistant + * @Short_description: A widget used to guide users through multi-step operations + * @Title: GtkAssistant + * + * A #GtkAssistant is a widget used to represent a generally complex + * operation splitted in several steps, guiding the user through its pages + * and controlling the page flow to collect the necessary data. + * + * + * GtkAssistant as GtkBuildable + * + * The GtkAssistant implementation of the GtkBuildable interface exposes the + * @action_area as internal children with the name "action_area". + * + * To add pages to an assistant in GtkBuilder, simply add it as a + * <child> to the GtkAssistant object, and set its child properties + * as necessary. + * + * + */ + #include "config.h" #include @@ -237,7 +259,7 @@ gtk_assistant_class_init (GtkAssistantClass *class) /** * GtkAssistant::apply: - * @assistant: the @GtkAssistant + * @assistant: the #GtkAssistant * * The ::apply signal is emitted when the apply button is clicked. The default * behavior of the #GtkAssistant is to switch to the page after the current diff --git a/gtk/gtkassistant.h b/gtk/gtkassistant.h index b39afef43..5f26325bf 100644 --- a/gtk/gtkassistant.h +++ b/gtk/gtkassistant.h @@ -41,6 +41,24 @@ G_BEGIN_DECLS #define GTK_IS_ASSISTANT_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), GTK_TYPE_ASSISTANT)) #define GTK_ASSISTANT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_ASSISTANT, GtkAssistantClass)) +/** + * GtkAssistantPageType: + * @GTK_ASSISTANT_PAGE_CONTENT: The page has regular contents. + * @GTK_ASSISTANT_PAGE_INTRO: The page contains an introduction to the + * assistant task. + * @GTK_ASSISTANT_PAGE_CONFIRM: The page lets the user confirm or deny the + * changes. + * @GTK_ASSISTANT_PAGE_SUMMARY: The page informs the user of the changes + * done. + * @GTK_ASSISTANT_PAGE_PROGRESS: Used for tasks that take a long time to + * complete, blocks the assistant until the page is marked as complete. + * + * An enum for determining the page role inside the #GtkAssistant. It's + * used to handle buttons sensitivity and visibility. + * + * Note that an assistant needs to end its page flow with a page of type + * %GTK_ASSISTANT_PAGE_CONFIRM or %GTK_ASSISTANT_PAGE_SUMMARY to be correct. + */ typedef enum { GTK_ASSISTANT_PAGE_CONTENT, @@ -86,6 +104,18 @@ struct _GtkAssistantClass void (*_gtk_reserved5) (void); }; +/** + * GtkAssistantPageFunc: + * @current_page: The page number used to calculate the next page. + * @data: user data. + * + * A function used by gtk_assistant_set_forward_page_func() to know which + * is the next page given a current one. It's called both for computing the + * next page when the user presses the "forward" button and for handling + * the behavior of the "last" button. + * + * Returns: The next page number. + */ typedef gint (*GtkAssistantPageFunc) (gint current_page, gpointer data); GType gtk_assistant_get_type (void) G_GNUC_CONST; -- 2.43.2