Assistant

Object Hierarchy:

Description:

public class Assistant : Window, Implementor, Buildable

A Assistant 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.

Namespace: Gtk

Package: gtk+-2.0

Content:

Creation methods:

public Assistant ()
Creates a new Assistant.

Methods:

public void add_action_widget (Widget child)
Adds a widget to the action area of a Assistant.
public int append_page (Widget page)
Appends a page to the assistant.
public int get_current_page ()
Returns the page number of the current page
public int get_n_pages ()
Returns the number of pages in the assistant
public weak Widget get_nth_page (int page_num)
Returns the child widget contained in page number page_num.
public bool get_page_complete (Widget page)
Gets whether page is complete.
public weak Pixbuf get_page_header_image (Widget page)
Gets the header image for page.
public weak Pixbuf get_page_side_image (Widget page)
Gets the header image for page.
public unowned string get_page_title (Widget page)
Gets the title for page.
public AssistantPageType get_page_type (Widget page)
Gets the page type of page.
public int insert_page (Widget page, int position)
Inserts a page in the assistant at a given position.
public int prepend_page (Widget page)
Prepends a page to the assistant.
public void remove_action_widget (Widget child)
Removes a widget from the action area of a Assistant.
public void set_current_page (int page_num)
Switches the page to page_num. Note that this will only be necessary in custom buttons, as the assistant flow can be set with set_forward_page_func.
public void set_forward_page_func (owned AssistantPageFunc page_func)
Sets the page forwarding function to be page_func, this function will be used to determine what will be the next page when the user presses the forward button. Setting page_func to null will make the assistant to use the default forward function, which just goes to the next visible page.
public void set_page_complete (Widget page, bool complete)
Sets whether page contents are complete. This will make assistant update the buttons state to be able to continue the task.
public void set_page_header_image (Widget page, Pixbuf pixbuf)
Sets a header image for page. This image is displayed in the header area of the assistant when page is the current page.
public void set_page_side_image (Widget page, Pixbuf pixbuf)
Sets a header image for page. This image is displayed in the side area of the assistant when page is the current page.
public void set_page_title (Widget page, string title)
Sets a title for page. The title is displayed in the header area of the assistant when page is the current page.
public void set_page_type (Widget page, AssistantPageType type)
Sets the page type for page. The page type determines the page behavior in the assistant.
public void update_buttons_state ()
Forces assistant to recompute the buttons state.

Signals:

public virtual void apply ()
The apply signal is emitted when the apply button is clicked. The default behavior of the Assistant is to switch to the page after the current page, unless the current page is the last one.
public virtual void cancel ()
The cancel signal is emitted when then the cancel button is clicked.
public virtual void close ()
The close signal is emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type CONFIRM) is clicked.
public virtual void prepare (Widget page)
The prepare signal is emitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparation which are necessary before showing page.

Fields:

public weak Widget back
public weak Widget forward
public weak Widget last