Assistant

Object Hierarchy:

Description:

public static int main (string[] args) {
	Gtk.init (ref args);

	Gtk.Assistant assistant = new Gtk.Assistant ();
	assistant.apply.connect (Gtk.main_quit);
	assistant.cancel.connect (Gtk.main_quit);
	assistant.set_default_size (500, 500);

	Gtk.Label label1 = new Gtk.Label ("My first page");
	int page_num = assistant.append_page (label1);
	assistant.set_page_title (label1, "Page %d: My Intro".printf (page_num));
	assistant.set_page_type (label1, Gtk.AssistantPageType.INTRO);
	assistant.set_page_complete (label1, true);

	Gtk.Label label2 = new Gtk.Label ("My second page");
	page_num = assistant.append_page (label2);
	assistant.set_page_title (label2, "Page %d: My Content".printf (page_num));
	assistant.set_page_type (label2, Gtk.AssistantPageType.CONTENT);
	assistant.set_page_complete (label2, true);

	Gtk.Label label3 = new Gtk.Label ("My third page");
	page_num = assistant.append_page (label3);
	assistant.set_page_title (label3, "Page %d: Confirm".printf (page_num));
	assistant.set_page_type (label3, Gtk.AssistantPageType.CONFIRM);
	assistant.set_page_complete (label3, true);

	assistant.show_all ();
	Gtk.main ();
	return 0;
}

valac --pkg gtk+-3.0 Gtk.Assistant.vala

Content:

Properties:

• public int use_header_bar { get; construct; }
  true if the assistant uses a HeaderBar for action buttons instead of the action-area.

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 this.
• public void commit ()
  Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages.
• 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 this
• public unowned 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 bool get_page_has_padding (Widget page)
  Gets whether page has padding.
• public unowned Pixbuf get_page_header_image (Widget page)
  Gets the header image for page.
• public unowned Pixbuf get_page_side_image (Widget page)
  Gets the side 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 this at a given position.
• public void next_page ()
  Navigate to the next page.
• public int prepend_page (Widget page)
  Prepends a page to the this.
• public void previous_page ()
  Navigate to the previous visited page.
• public void remove_action_widget (Widget child)
  Removes a widget from the action area of a Assistant.
• public void remove_page (int page_num)
  Removes the page_num’s page from this.
• public void set_current_page (int page_num)
  Switches the page to page_num.
• public void set_forward_page_func (owned AssistantPageFunc? page_func)
  Sets the page forwarding function to be page_func.
• public void set_page_complete (Widget page, bool complete)
  Sets whether page contents are complete.
• public void set_page_has_padding (Widget page, bool has_padding)
  Sets whether the assistant is adding padding around the page.
• public void set_page_header_image (Widget page, Pixbuf? pixbuf)
  Sets a header image for page.
• public void set_page_side_image (Widget page, Pixbuf? pixbuf)
  Sets a side image for page.
• public void set_page_title (Widget page, string title)
  Sets a title for page.
• public void set_page_type (Widget page, AssistantPageType type)
  Sets the page type for page.
• public void update_buttons_state ()
  Forces this to recompute the buttons state.

Signals:

• public virtual signal void apply ()
  The apply signal is emitted when the apply button is clicked.
• public virtual signal void cancel ()
  The cancel signal is emitted when then the cancel button is clicked.
• public virtual signal 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 gtk_assistant_page_confirm) is clicked.
• public signal void escape ()
• public virtual signal 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.

Inherited Members: