gtk2/docs/reference/gtk/tmpl/gtkassistant.sgml

<!-- ##### SECTION Title ##### -->
GtkAssistant

<!-- ##### SECTION Short_Description ##### -->
A widget used to guide users through multi-step operations

<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkAssistant ##### -->
<para>

</para>


<!-- ##### SIGNAL GtkAssistant::apply ##### -->
<para>

</para>

@assistant: the object which received the signal.

<!-- ##### SIGNAL GtkAssistant::cancel ##### -->
<para>

</para>

@assistant: the object which received the signal.

<!-- ##### SIGNAL GtkAssistant::close ##### -->
<para>

</para>

@assistant: the object which received the signal.

<!-- ##### SIGNAL GtkAssistant::prepare ##### -->
<para>

</para>

@assistant: the object which received the signal.
@widget: 

<!-- ##### ARG GtkAssistant:complete ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:header-image ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:page-type ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:sidebar-image ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:title ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:content-padding ##### -->
<para>

</para>

<!-- ##### ARG GtkAssistant:header-padding ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_assistant_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_assistant_get_current_page ##### -->
<para>

</para>

@assistant: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_current_page ##### -->
<para>

</para>

@assistant: 
@page_num: 


<!-- ##### FUNCTION gtk_assistant_get_n_pages ##### -->
<para>

</para>

@assistant: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_get_nth_page ##### -->
<para>

</para>

@assistant: 
@page_num: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_prepend_page ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_append_page ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_insert_page ##### -->
<para>

</para>

@assistant: 
@page: 
@position: 
@Returns: 


<!-- ##### USER_FUNCTION GtkAssistantPageFunc ##### -->
<para>
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.
</para>

@current_page: The page number used to calculate the next page.
@data: user data.
@Returns: The next page number.


<!-- ##### FUNCTION gtk_assistant_set_forward_page_func ##### -->
<para>

</para>

@assistant: 
@page_func: 
@data: 
@destroy: 


<!-- ##### ENUM GtkAssistantPageType ##### -->
<para>
An enum for determining the page role inside the #GtkAssistant. It's used to
handle buttons sensitivity and visibility.
</para>

<para>
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.
</para>

@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.

<!-- ##### FUNCTION gtk_assistant_set_page_type ##### -->
<para>

</para>

@assistant: 
@page: 
@type: 


<!-- ##### FUNCTION gtk_assistant_get_page_type ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_title ##### -->
<para>

</para>

@assistant: 
@page: 
@title: 


<!-- ##### FUNCTION gtk_assistant_get_page_title ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_header_image ##### -->
<para>

</para>

@assistant: 
@page: 
@pixbuf: 


<!-- ##### FUNCTION gtk_assistant_get_page_header_image ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_side_image ##### -->
<para>

</para>

@assistant: 
@page: 
@pixbuf: 


<!-- ##### FUNCTION gtk_assistant_get_page_side_image ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_set_page_complete ##### -->
<para>

</para>

@assistant: 
@page: 
@complete: 


<!-- ##### FUNCTION gtk_assistant_get_page_complete ##### -->
<para>

</para>

@assistant: 
@page: 
@Returns: 


<!-- ##### FUNCTION gtk_assistant_add_action_widget ##### -->
<para>

</para>

@assistant: 
@child: 


<!-- ##### FUNCTION gtk_assistant_remove_action_widget ##### -->
<para>

</para>

@assistant: 
@child: 


<!-- ##### FUNCTION gtk_assistant_update_buttons_state ##### -->
<para>

</para>

@assistant: