/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = GtkAssistant.html
 * outPack = gtk
 * outFile = Assistant
 * strct   = GtkAssistant
 * realStrct=
 * ctorStrct=
 * clss    = Assistant
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- gtk_assistant_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.Str
 * 	- gdk.Pixbuf
 * 	- gtk.Widget
 * structWrap:
 * 	- GdkPixbuf* -> Pixbuf
 * 	- GtkWidget* -> Widget
 * module aliases:
 * local aliases:
 * overrides:
 */

module gtk.Assistant;

public  import gtkc.gtktypes;

private import gtkc.gtk;
private import glib.ConstructionException;
private import gobject.ObjectG;

private import gobject.Signals;
public  import gtkc.gdktypes;
private import glib.Str;
private import gdk.Pixbuf;
private import gtk.Widget;


private import gtk.Window;

/**
 * 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.
 *
 * 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 type of each page, in
 * addition to state information like the page
 * completion and
 * committed status.
 *
 * If you have a case that doesn't quite fit in GtkAssistants way of
 * handling buttons, you can use the GTK_ASSISTANT_PAGE_CUSTOM page type
 * and handle buttons yourself.
 *
 * 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.
 */
public class Assistant : Window
{
	
	/** the main Gtk struct */
	protected GtkAssistant* gtkAssistant;
	
	
	/** Get the main Gtk struct */
	public GtkAssistant* getAssistantStruct()
	{
		return gtkAssistant;
	}
	
	
	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkAssistant;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GtkAssistant* gtkAssistant)
	{
		super(cast(GtkWindow*)gtkAssistant);
		this.gtkAssistant = gtkAssistant;
	}
	
	protected override void setStruct(GObject* obj)
	{
		super.setStruct(obj);
		gtkAssistant = cast(GtkAssistant*)obj;
	}
	
	/**
	 */
	int[string] connectedSignals;
	
	void delegate(Assistant)[] onApplyListeners;
	/**
	 * 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 page, unless the current page is the last one.
	 * A handler for the ::apply signal should carry out the actions for
	 * which the wizard has collected data. If the action takes a long time
	 * to complete, you might consider putting a page of type
	 * GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page and handle
	 * this operation within the "prepare" signal of the progress
	 * page.
	 * Since 2.10
	 */
	void addOnApply(void delegate(Assistant) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("apply" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"apply",
			cast(GCallback)&callBackApply,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["apply"] = 1;
		}
		onApplyListeners ~= dlg;
	}
	extern(C) static void callBackApply(GtkAssistant* assistantStruct, Assistant _assistant)
	{
		foreach ( void delegate(Assistant) dlg ; _assistant.onApplyListeners )
		{
			dlg(_assistant);
		}
	}
	
	void delegate(Assistant)[] onCancelListeners;
	/**
	 * The ::cancel signal is emitted when then the cancel button is clicked.
	 * Since 2.10
	 */
	void addOnCancel(void delegate(Assistant) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("cancel" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"cancel",
			cast(GCallback)&callBackCancel,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["cancel"] = 1;
		}
		onCancelListeners ~= dlg;
	}
	extern(C) static void callBackCancel(GtkAssistant* assistantStruct, Assistant _assistant)
	{
		foreach ( void delegate(Assistant) dlg ; _assistant.onCancelListeners )
		{
			dlg(_assistant);
		}
	}
	
	void delegate(Assistant)[] onCloseListeners;
	/**
	 * 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.
	 * Since 2.10
	 */
	void addOnClose(void delegate(Assistant) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("close" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"close",
			cast(GCallback)&callBackClose,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["close"] = 1;
		}
		onCloseListeners ~= dlg;
	}
	extern(C) static void callBackClose(GtkAssistant* assistantStruct, Assistant _assistant)
	{
		foreach ( void delegate(Assistant) dlg ; _assistant.onCloseListeners )
		{
			dlg(_assistant);
		}
	}
	
	void delegate(Widget, Assistant)[] onPrepareListeners;
	/**
	 * 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 preparations which are
	 * necessary before showing page.
	 * Since 2.10
	 */
	void addOnPrepare(void delegate(Widget, Assistant) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("prepare" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"prepare",
			cast(GCallback)&callBackPrepare,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["prepare"] = 1;
		}
		onPrepareListeners ~= dlg;
	}
	extern(C) static void callBackPrepare(GtkAssistant* assistantStruct, GtkWidget* page, Assistant _assistant)
	{
		foreach ( void delegate(Widget, Assistant) dlg ; _assistant.onPrepareListeners )
		{
			dlg(ObjectG.getDObject!(Widget)(page), _assistant);
		}
	}
	
	
	/**
	 * Creates a new GtkAssistant.
	 * Since 2.10
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this ()
	{
		// GtkWidget * gtk_assistant_new (void);
		auto p = gtk_assistant_new();
		if(p is null)
		{
			throw new ConstructionException("null returned by gtk_assistant_new()");
		}
		this(cast(GtkAssistant*) p);
	}
	
	/**
	 * Returns the page number of the current page.
	 * Since 2.10
	 * Returns: The index (starting from 0) of the current page in the assistant, or -1 if the assistant has no pages, or no current page.
	 */
	public int getCurrentPage()
	{
		// gint gtk_assistant_get_current_page (GtkAssistant *assistant);
		return gtk_assistant_get_current_page(gtkAssistant);
	}
	
	/**
	 * Switches the page to page_num.
	 * Note that this will only be necessary in custom buttons,
	 * as the assistant flow can be set with
	 * gtk_assistant_set_forward_page_func().
	 * Since 2.10
	 * Params:
	 * pageNum = index of the page to switch to, starting from 0.
	 * If negative, the last page will be used. If greater
	 * than the number of pages in the assistant, nothing
	 * will be done.
	 */
	public void setCurrentPage(int pageNum)
	{
		// void gtk_assistant_set_current_page (GtkAssistant *assistant,  gint page_num);
		gtk_assistant_set_current_page(gtkAssistant, pageNum);
	}
	
	/**
	 * Returns the number of pages in the assistant
	 * Since 2.10
	 * Returns: the number of pages in the assistant
	 */
	public int getNPages()
	{
		// gint gtk_assistant_get_n_pages (GtkAssistant *assistant);
		return gtk_assistant_get_n_pages(gtkAssistant);
	}
	
	/**
	 * Returns the child widget contained in page number page_num.
	 * Since 2.10
	 * Params:
	 * pageNum = the index of a page in the assistant,
	 * or -1 to get the last page
	 * Returns: the child widget, or NULL if page_num is out of bounds. [transfer none]
	 */
	public Widget getNthPage(int pageNum)
	{
		// GtkWidget * gtk_assistant_get_nth_page (GtkAssistant *assistant,  gint page_num);
		auto p = gtk_assistant_get_nth_page(gtkAssistant, pageNum);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
	}
	
	/**
	 * Prepends a page to the assistant.
	 * Since 2.10
	 * Params:
	 * page = a GtkWidget
	 * Returns: the index (starting at 0) of the inserted page
	 */
	public int prependPage(Widget page)
	{
		// gint gtk_assistant_prepend_page (GtkAssistant *assistant,  GtkWidget *page);
		return gtk_assistant_prepend_page(gtkAssistant, (page is null) ? null : page.getWidgetStruct());
	}
	
	/**
	 * Appends a page to the assistant.
	 * Since 2.10
	 * Params:
	 * page = a GtkWidget
	 * Returns: the index (starting at 0) of the inserted page
	 */
	public int appendPage(Widget page)
	{
		// gint gtk_assistant_append_page (GtkAssistant *assistant,  GtkWidget *page);
		return gtk_assistant_append_page(gtkAssistant, (page is null) ? null : page.getWidgetStruct());
	}
	
	/**
	 * Inserts a page in the assistant at a given position.
	 * Since 2.10
	 * Params:
	 * page = a GtkWidget
	 * position = the index (starting at 0) at which to insert the page,
	 * or -1 to append the page to the assistant
	 * Returns: the index (starting from 0) of the inserted page
	 */
	public int insertPage(Widget page, int position)
	{
		// gint gtk_assistant_insert_page (GtkAssistant *assistant,  GtkWidget *page,  gint position);
		return gtk_assistant_insert_page(gtkAssistant, (page is null) ? null : page.getWidgetStruct(), position);
	}
	
	/**
	 * Removes the page_num's page from assistant.
	 * Params:
	 * pageNum = the index of a page in the assistant,
	 * or -1 to remove the last page
	 * Since 3.2
	 */
	public void removePage(int pageNum)
	{
		// void gtk_assistant_remove_page (GtkAssistant *assistant,  gint page_num);
		gtk_assistant_remove_page(gtkAssistant, pageNum);
	}
	
	/**
	 * 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.
	 * Since 2.10
	 * Params:
	 * pageFunc = the GtkAssistantPageFunc, or NULL
	 * to use the default one. [allow-none]
	 * data = user data for page_func
	 * destroy = destroy notifier for data
	 */
	public void setForwardPageFunc(GtkAssistantPageFunc pageFunc, void* data, GDestroyNotify destroy)
	{
		// void gtk_assistant_set_forward_page_func (GtkAssistant *assistant,  GtkAssistantPageFunc page_func,  gpointer data,  GDestroyNotify destroy);
		gtk_assistant_set_forward_page_func(gtkAssistant, pageFunc, data, destroy);
	}
	
	/**
	 * Sets the page type for page.
	 * The page type determines the page behavior in the assistant.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * type = the new type for page
	 */
	public void setPageType(Widget page, GtkAssistantPageType type)
	{
		// void gtk_assistant_set_page_type (GtkAssistant *assistant,  GtkWidget *page,  GtkAssistantPageType type);
		gtk_assistant_set_page_type(gtkAssistant, (page is null) ? null : page.getWidgetStruct(), type);
	}
	
	/**
	 * Gets the page type of page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * Returns: the page type of page
	 */
	public GtkAssistantPageType getPageType(Widget page)
	{
		// GtkAssistantPageType gtk_assistant_get_page_type (GtkAssistant *assistant,  GtkWidget *page);
		return gtk_assistant_get_page_type(gtkAssistant, (page is null) ? null : page.getWidgetStruct());
	}
	
	/**
	 * Sets a title for page.
	 * The title is displayed in the header area of the assistant
	 * when page is the current page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * title = the new title for page
	 */
	public void setPageTitle(Widget page, string title)
	{
		// void gtk_assistant_set_page_title (GtkAssistant *assistant,  GtkWidget *page,  const gchar *title);
		gtk_assistant_set_page_title(gtkAssistant, (page is null) ? null : page.getWidgetStruct(), Str.toStringz(title));
	}
	
	/**
	 * Gets the title for page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * Returns: the title for page
	 */
	public string getPageTitle(Widget page)
	{
		// const gchar * gtk_assistant_get_page_title (GtkAssistant *assistant,  GtkWidget *page);
		return Str.toString(gtk_assistant_get_page_title(gtkAssistant, (page is null) ? null : page.getWidgetStruct()));
	}
	
	/**
	 * Warning
	 * gtk_assistant_set_page_header_image has been deprecated since version 3.2 and should not be used in newly-written code. Since GTK+ 3.2, a header is no longer shown;
	 *  add your header decoration to the page content instead.
	 * Sets a header image for page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * pixbuf = the new header image page. [allow-none]
	 */
	public void setPageHeaderImage(Widget page, Pixbuf pixbuf)
	{
		// void gtk_assistant_set_page_header_image (GtkAssistant *assistant,  GtkWidget *page,  GdkPixbuf *pixbuf);
		gtk_assistant_set_page_header_image(gtkAssistant, (page is null) ? null : page.getWidgetStruct(), (pixbuf is null) ? null : pixbuf.getPixbufStruct());
	}
	
	/**
	 * Warning
	 * gtk_assistant_get_page_header_image has been deprecated since version 3.2 and should not be used in newly-written code. Since GTK+ 3.2, a header is no longer shown;
	 *  add your header decoration to the page content instead.
	 * Gets the header image for page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * Returns: the header image for page, or NULL if there's no header image for the page. [transfer none]
	 */
	public Pixbuf getPageHeaderImage(Widget page)
	{
		// GdkPixbuf * gtk_assistant_get_page_header_image (GtkAssistant *assistant,  GtkWidget *page);
		auto p = gtk_assistant_get_page_header_image(gtkAssistant, (page is null) ? null : page.getWidgetStruct());
		
		if(p is null)
		{
			return null;
		}
		
		import gtkc.gobject : g_object_ref;
		g_object_ref(cast(GObject*)p);
		
		return ObjectG.getDObject!(Pixbuf)(cast(GdkPixbuf*) p);
	}
	
	/**
	 * Warning
	 * gtk_assistant_set_page_side_image has been deprecated since version 3.2 and should not be used in newly-written code. Since GTK+ 3.2, sidebar images are not
	 *  shown anymore.
	 * Sets a side image for page.
	 * This image used to be displayed in the side area of the assistant
	 * when page is the current page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * pixbuf = the new side image page. [allow-none]
	 */
	public void setPageSideImage(Widget page, Pixbuf pixbuf)
	{
		// void gtk_assistant_set_page_side_image (GtkAssistant *assistant,  GtkWidget *page,  GdkPixbuf *pixbuf);
		gtk_assistant_set_page_side_image(gtkAssistant, (page is null) ? null : page.getWidgetStruct(), (pixbuf is null) ? null : pixbuf.getPixbufStruct());
	}
	
	/**
	 * Warning
	 * gtk_assistant_get_page_side_image has been deprecated since version 3.2 and should not be used in newly-written code. Since GTK+ 3.2, sidebar images are not
	 *  shown anymore.
	 * Gets the side image for page.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * Returns: the side image for page, or NULL if there's no side image for the page. [transfer none]
	 */
	public Pixbuf getPageSideImage(Widget page)
	{
		// GdkPixbuf * gtk_assistant_get_page_side_image (GtkAssistant *assistant,  GtkWidget *page);
		auto p = gtk_assistant_get_page_side_image(gtkAssistant, (page is null) ? null : page.getWidgetStruct());
		
		if(p is null)
		{
			return null;
		}
		
		import gtkc.gobject : g_object_ref;
		g_object_ref(cast(GObject*)p);
		
		return ObjectG.getDObject!(Pixbuf)(cast(GdkPixbuf*) p);
	}
	
	/**
	 * Sets whether page contents are complete.
	 * This will make assistant update the buttons state
	 * to be able to continue the task.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * complete = the completeness status of the page
	 */
	public void setPageComplete(Widget page, int complete)
	{
		// void gtk_assistant_set_page_complete (GtkAssistant *assistant,  GtkWidget *page,  gboolean complete);
		gtk_assistant_set_page_complete(gtkAssistant, (page is null) ? null : page.getWidgetStruct(), complete);
	}
	
	/**
	 * Gets whether page is complete.
	 * Since 2.10
	 * Params:
	 * page = a page of assistant
	 * Returns: TRUE if page is complete.
	 */
	public int getPageComplete(Widget page)
	{
		// gboolean gtk_assistant_get_page_complete (GtkAssistant *assistant,  GtkWidget *page);
		return gtk_assistant_get_page_complete(gtkAssistant, (page is null) ? null : page.getWidgetStruct());
	}
	
	/**
	 * Adds a widget to the action area of a GtkAssistant.
	 * Since 2.10
	 * Params:
	 * child = a GtkWidget
	 */
	public void addActionWidget(Widget child)
	{
		// void gtk_assistant_add_action_widget (GtkAssistant *assistant,  GtkWidget *child);
		gtk_assistant_add_action_widget(gtkAssistant, (child is null) ? null : child.getWidgetStruct());
	}
	
	/**
	 * Removes a widget from the action area of a GtkAssistant.
	 * Since 2.10
	 * Params:
	 * child = a GtkWidget
	 */
	public void removeActionWidget(Widget child)
	{
		// void gtk_assistant_remove_action_widget (GtkAssistant *assistant,  GtkWidget *child);
		gtk_assistant_remove_action_widget(gtkAssistant, (child is null) ? null : child.getWidgetStruct());
	}
	
	/**
	 * Forces assistant to recompute the buttons state.
	 * GTK+ automatically takes care of this in most situations,
	 * e.g. when the user goes to a different page, or when the
	 * visibility or completeness of a page changes.
	 * One situation where it can be necessary to call this
	 * function is when changing a value on the current page
	 * affects the future page flow of the assistant.
	 * Since 2.10
	 */
	public void updateButtonsState()
	{
		// void gtk_assistant_update_buttons_state (GtkAssistant *assistant);
		gtk_assistant_update_buttons_state(gtkAssistant);
	}
	
	/**
	 * Erases the visited page history so the back button is not
	 * shown on the current page, and removes the cancel button
	 * from subsequent pages.
	 * Use this when the information provided up to the current
	 * page is hereafter deemed permanent and cannot be modified
	 * or undone. For example, showing a progress page to track
	 * a long-running, unreversible operation after the user has
	 * clicked apply on a confirmation page.
	 * Since 2.22
	 */
	public void commit()
	{
		// void gtk_assistant_commit (GtkAssistant *assistant);
		gtk_assistant_commit(gtkAssistant);
	}
	
	/**
	 * Navigate to the next page.
	 * It is a programming error to call this function when
	 * there is no next page.
	 * This function is for use when creating pages of the
	 * GTK_ASSISTANT_PAGE_CUSTOM type.
	 */
	public void nextPage()
	{
		// void gtk_assistant_next_page (GtkAssistant *assistant);
		gtk_assistant_next_page(gtkAssistant);
	}
	
	/**
	 * Navigate to the previous visited page.
	 * It is a programming error to call this function when
	 * no previous page is available.
	 * This function is for use when creating pages of the
	 * GTK_ASSISTANT_PAGE_CUSTOM type.
	 * Since 2.10
	 */
	public void previousPage()
	{
		// void gtk_assistant_previous_page (GtkAssistant *assistant);
		gtk_assistant_previous_page(gtkAssistant);
	}
}