/*
 * 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


module gtk.FileChooserButton;

private import glib.ConstructionException;
private import glib.Str;
private import gobject.ObjectG;
private import gobject.Signals;
private import gtk.Box;
private import gtk.Dialog;
private import gtk.FileChooserIF;
private import gtk.FileChooserT;
private import gtk.Widget;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;
private import std.algorithm;


/**
 * The #GtkFileChooserButton is a widget that lets the user select a
 * file.  It implements the #GtkFileChooser interface.  Visually, it is a
 * file name with a button to bring up a #GtkFileChooserDialog.
 * The user can then use that dialog to change the file associated with
 * that button.  This widget does not support setting the
 * #GtkFileChooser:select-multiple property to %TRUE.
 * 
 * ## Create a button to let the user select a file in /etc
 * 
 * |[<!-- language="C" -->
 * {
 * GtkWidget *button;
 * 
 * button = gtk_file_chooser_button_new (_("Select a file"),
 * GTK_FILE_CHOOSER_ACTION_OPEN);
 * gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (button),
 * "/etc");
 * }
 * ]|
 * 
 * The #GtkFileChooserButton supports the #GtkFileChooserActions
 * %GTK_FILE_CHOOSER_ACTION_OPEN and %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
 * 
 * > The #GtkFileChooserButton will ellipsize the label, and will thus
 * > request little horizontal space.  To give the button more space,
 * > you should call gtk_widget_get_preferred_size(),
 * > gtk_file_chooser_button_set_width_chars(), or pack the button in
 * > such a way that other interface elements give space to the
 * > widget.
 */
public class FileChooserButton : Box, FileChooserIF
{
	/** the main Gtk struct */
	protected GtkFileChooserButton* gtkFileChooserButton;

	/** Get the main Gtk struct */
	public GtkFileChooserButton* getFileChooserButtonStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkFileChooserButton;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkFileChooserButton;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GtkFileChooserButton* gtkFileChooserButton, bool ownedRef = false)
	{
		this.gtkFileChooserButton = gtkFileChooserButton;
		super(cast(GtkBox*)gtkFileChooserButton, ownedRef);
	}

	// add the FileChooser capabilities
	mixin FileChooserT!(GtkFileChooserButton);


	/** */
	public static GType getType()
	{
		return gtk_file_chooser_button_get_type();
	}

	/**
	 * Creates a new file-selecting button widget.
	 *
	 * Params:
	 *     title = the title of the browse dialog.
	 *     action = the open mode for the widget.
	 *
	 * Returns: a new button widget.
	 *
	 * Since: 2.6
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(string title, GtkFileChooserAction action)
	{
		auto p = gtk_file_chooser_button_new(Str.toStringz(title), action);

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GtkFileChooserButton*) p);
	}

	/**
	 * Creates a #GtkFileChooserButton widget which uses @dialog as its
	 * file-picking window.
	 *
	 * Note that @dialog must be a #GtkDialog (or subclass) which
	 * implements the #GtkFileChooser interface and must not have
	 * %GTK_DIALOG_DESTROY_WITH_PARENT set.
	 *
	 * Also note that the dialog needs to have its confirmative button
	 * added with response %GTK_RESPONSE_ACCEPT or %GTK_RESPONSE_OK in
	 * order for the button to take over the file selected in the dialog.
	 *
	 * Params:
	 *     dialog = the widget to use as dialog
	 *
	 * Returns: a new button widget.
	 *
	 * Since: 2.6
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(Dialog dialog)
	{
		auto p = gtk_file_chooser_button_new_with_dialog((dialog is null) ? null : cast(GtkWidget*)dialog.getDialogStruct());

		if(p is null)
		{
			throw new ConstructionException("null returned by new_with_dialog");
		}

		this(cast(GtkFileChooserButton*) p);
	}

	/**
	 * Returns whether the button grabs focus when it is clicked with the mouse.
	 * See gtk_file_chooser_button_set_focus_on_click().
	 *
	 * Deprecated: Use gtk_widget_get_focus_on_click() instead
	 *
	 * Returns: %TRUE if the button grabs focus when it is clicked with
	 *     the mouse.
	 *
	 * Since: 2.10
	 */
	public override bool getFocusOnClick()
	{
		return gtk_file_chooser_button_get_focus_on_click(gtkFileChooserButton) != 0;
	}

	/**
	 * Retrieves the title of the browse dialog used by @button. The returned value
	 * should not be modified or freed.
	 *
	 * Returns: a pointer to the browse dialog’s title.
	 *
	 * Since: 2.6
	 */
	public string getTitle()
	{
		return Str.toString(gtk_file_chooser_button_get_title(gtkFileChooserButton));
	}

	/**
	 * Retrieves the width in characters of the @button widget’s entry and/or label.
	 *
	 * Returns: an integer width (in characters) that the button will use to size itself.
	 *
	 * Since: 2.6
	 */
	public int getWidthChars()
	{
		return gtk_file_chooser_button_get_width_chars(gtkFileChooserButton);
	}

	/**
	 * Sets whether the button will grab focus when it is clicked with the mouse.
	 * Making mouse clicks not grab focus is useful in places like toolbars where
	 * you don’t want the keyboard focus removed from the main area of the
	 * application.
	 *
	 * Deprecated: Use gtk_widget_set_focus_on_click() instead
	 *
	 * Params:
	 *     focusOnClick = whether the button grabs focus when clicked with the mouse
	 *
	 * Since: 2.10
	 */
	public override void setFocusOnClick(bool focusOnClick)
	{
		gtk_file_chooser_button_set_focus_on_click(gtkFileChooserButton, focusOnClick);
	}

	/**
	 * Modifies the @title of the browse dialog used by @button.
	 *
	 * Params:
	 *     title = the new browse dialog title.
	 *
	 * Since: 2.6
	 */
	public void setTitle(string title)
	{
		gtk_file_chooser_button_set_title(gtkFileChooserButton, Str.toStringz(title));
	}

	/**
	 * Sets the width (in characters) that @button will use to @n_chars.
	 *
	 * Params:
	 *     nChars = the new width, in characters.
	 *
	 * Since: 2.6
	 */
	public void setWidthChars(int nChars)
	{
		gtk_file_chooser_button_set_width_chars(gtkFileChooserButton, nChars);
	}

	protected class OnFileSetDelegateWrapper
	{
		void delegate(FileChooserButton) dlg;
		gulong handlerId;

		this(void delegate(FileChooserButton) dlg)
		{
			this.dlg = dlg;
			onFileSetListeners ~= this;
		}

		void remove(OnFileSetDelegateWrapper source)
		{
			foreach(index, wrapper; onFileSetListeners)
			{
				if (wrapper.handlerId == source.handlerId)
				{
					onFileSetListeners[index] = null;
					onFileSetListeners = std.algorithm.remove(onFileSetListeners, index);
					break;
				}
			}
		}
	}
	OnFileSetDelegateWrapper[] onFileSetListeners;

	/**
	 * The ::file-set signal is emitted when the user selects a file.
	 *
	 * Note that this signal is only emitted when the user
	 * changes the file.
	 *
	 * Since: 2.12
	 */
	gulong addOnFileSet(void delegate(FileChooserButton) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		auto wrapper = new OnFileSetDelegateWrapper(dlg);
		wrapper.handlerId = Signals.connectData(
			this,
			"file-set",
			cast(GCallback)&callBackFileSet,
			cast(void*)wrapper,
			cast(GClosureNotify)&callBackFileSetDestroy,
			connectFlags);
		return wrapper.handlerId;
	}

	extern(C) static void callBackFileSet(GtkFileChooserButton* filechooserbuttonStruct, OnFileSetDelegateWrapper wrapper)
	{
		wrapper.dlg(wrapper.outer);
	}

	extern(C) static void callBackFileSetDestroy(OnFileSetDelegateWrapper wrapper, GClosure* closure)
	{
		wrapper.remove(wrapper);
	}
}