/*
 * 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  = GtkSourceCompletion.html
 * outPack = gsv
 * outFile = SourceCompletion
 * strct   = GtkSourceCompletion
 * realStrct=
 * ctorStrct=
 * clss    = SourceCompletion
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- gtk_source_completion_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.ErrorG
 * 	- glib.GException
 * 	- glib.ListG
 * 	- gsv.SourceCompletionContext
 * 	- gsv.SourceCompletionInfo
 * 	- gsv.SourceCompletionProviderIF
 * 	- gsv.SourceView
 * 	- gtk.TextIter
 * structWrap:
 * 	- GList* -> ListG
 * 	- GtkSourceCompletionContext* -> SourceCompletionContext
 * 	- GtkSourceCompletionInfo* -> SourceCompletionInfo
 * 	- GtkSourceCompletionProvider* -> SourceCompletionProviderIF
 * 	- GtkSourceView* -> SourceView
 * 	- GtkTextIter* -> TextIter
 * module aliases:
 * local aliases:
 * overrides:
 */

module gsv.SourceCompletion;

public  import gsvc.gsvtypes;

private import gsvc.gsv;
private import glib.ConstructionException;
private import gobject.ObjectG;

private import gobject.Signals;
public  import gtkc.gdktypes;
private import glib.ErrorG;
private import glib.GException;
private import glib.ListG;
private import gsv.SourceCompletionContext;
private import gsv.SourceCompletionInfo;
private import gsv.SourceCompletionProviderIF;
private import gsv.SourceView;
private import gtk.TextIter;


private import gobject.ObjectG;

/**
 * The completion system helps the user when he writes some text, such
 * as words, command names, functions, and suchlike. Proposals can be
 * shown, to complete the text the user is writing. Each proposal can
 * contain an additional piece of information, that is displayed when
 * the "Details" button is active.
 *
 * Proposals are created via a GtkSourceCompletionProvider. There can
 * be for example a provider to complete words (see
 * GtkSourceCompletionWords), another provider for the completion of
 * function's names, etc. To add a provider, call
 * gtk_source_completion_add_provider().
 *
 * When the completion is activated, a GtkSourceCompletionContext object is
 * created. The providers are asked whether they match the context, with
 * gtk_source_completion_provider_match(). If a provider doesn't match the
 * context, it will not be visible in the completion window. On the
 * other hand, if the provider matches the context, its proposals will
 * be displayed.
 *
 * When several providers match, they are all shown in the completion
 * window, but one can switch between providers: see the
 * "move-page" signal. It is also possible to
 * activate the first proposals with key bindings, see the
 * "accelerators" property.
 *
 * The GtkSourceCompletionProposal interface represents a proposal.
 * The GtkSourceCompletionItem class is a simple implementation of this
 * interface.
 *
 * If a proposal contains extra information (see
 * gtk_source_completion_provider_get_info_widget()), it will be
 * displayed in a GtkSourceCompletionInfo window, which appears when
 * the "Details" button is clicked.
 *
 * A GtkSourceCompletionInfo window can also be used to display
 * calltips. When no proposals are available, it can be useful to
 * display extra information like a function's prototype (number of
 * parameters, types of parameters, etc).
 *
 * Each GtkSourceView object is associated with a GtkSourceCompletion
 * instance. This instance can be obtained with
 * gtk_source_view_get_completion(). The GtkSourceView class contains also the
 * "show-completion" signal.
 *
 * A same GtkSourceCompletionProvider object can be used for several
 * GtkSourceCompletion.
 */
public class SourceCompletion : ObjectG
{
	
	/** the main Gtk struct */
	protected GtkSourceCompletion* gtkSourceCompletion;
	
	
	/** Get the main Gtk struct */
	public GtkSourceCompletion* getSourceCompletionStruct()
	{
		return gtkSourceCompletion;
	}
	
	
	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkSourceCompletion;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GtkSourceCompletion* gtkSourceCompletion)
	{
		super(cast(GObject*)gtkSourceCompletion);
		this.gtkSourceCompletion = gtkSourceCompletion;
	}
	
	protected override void setStruct(GObject* obj)
	{
		super.setStruct(obj);
		gtkSourceCompletion = cast(GtkSourceCompletion*)obj;
	}
	
	/**
	 */
	int[string] connectedSignals;
	
	void delegate(SourceCompletion)[] onActivateProposalListeners;
	/**
	 * The "activate-proposal" signal is a
	 * keybinding signal which gets emitted when the user initiates
	 * a proposal activation.
	 * Applications should not connect to it, but may emit it with
	 * g_signal_emit_by_name() if they need to control the proposal
	 * activation programmatically.
	 */
	void addOnActivateProposal(void delegate(SourceCompletion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("activate-proposal" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"activate-proposal",
			cast(GCallback)&callBackActivateProposal,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["activate-proposal"] = 1;
		}
		onActivateProposalListeners ~= dlg;
	}
	extern(C) static void callBackActivateProposal(GtkSourceCompletion* completionStruct, SourceCompletion _sourceCompletion)
	{
		foreach ( void delegate(SourceCompletion) dlg ; _sourceCompletion.onActivateProposalListeners )
		{
			dlg(_sourceCompletion);
		}
	}
	
	void delegate(SourceCompletion)[] onHideListeners;
	/**
	 * Emitted when the completion window is hidden. The default handler
	 * will actually hide the window.
	 */
	void addOnHide(void delegate(SourceCompletion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("hide" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"hide",
			cast(GCallback)&callBackHide,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["hide"] = 1;
		}
		onHideListeners ~= dlg;
	}
	extern(C) static void callBackHide(GtkSourceCompletion* completionStruct, SourceCompletion _sourceCompletion)
	{
		foreach ( void delegate(SourceCompletion) dlg ; _sourceCompletion.onHideListeners )
		{
			dlg(_sourceCompletion);
		}
	}
	
	void delegate(GtkScrollStep, gint, SourceCompletion)[] onMoveCursorListeners;
	/**
	 * The "move-cursor" signal is a keybinding
	 * signal which gets emitted when the user initiates a cursor
	 * movement.
	 * The Up, Down,
	 * PageUp, PageDown,
	 * Home and End keys are bound to the
	 * normal behavior expected by those keys.
	 * When step is equal to GTK_SCROLL_PAGES, the page size is defined by
	 * the "proposal-page-size" property. It is used for
	 * the PageDown and PageUp keys.
	 * Applications should not connect to it, but may emit it with
	 * g_signal_emit_by_name() if they need to control the cursor
	 * programmatically.
	 */
	void addOnMoveCursor(void delegate(GtkScrollStep, gint, SourceCompletion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("move-cursor" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"move-cursor",
			cast(GCallback)&callBackMoveCursor,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["move-cursor"] = 1;
		}
		onMoveCursorListeners ~= dlg;
	}
	extern(C) static void callBackMoveCursor(GtkSourceCompletion* completionStruct, GtkScrollStep step, gint num, SourceCompletion _sourceCompletion)
	{
		foreach ( void delegate(GtkScrollStep, gint, SourceCompletion) dlg ; _sourceCompletion.onMoveCursorListeners )
		{
			dlg(step, num, _sourceCompletion);
		}
	}
	
	void delegate(GtkScrollStep, gint, SourceCompletion)[] onMovePageListeners;
	/**
	 * The "move-page" signal is a keybinding
	 * signal which gets emitted when the user initiates a page
	 * movement (i.e. switches between provider pages).
	 * Control+Left
	 * is for going to the previous provider.
	 * Control+Right
	 * is for going to the next provider.
	 * Control+Home
	 * is for displaying all the providers.
	 * Control+End
	 * is for going to the last provider.
	 * When step is equal to GTK_SCROLL_PAGES, the page size is defined by
	 * the "provider-page-size" property.
	 * Applications should not connect to it, but may emit it with
	 * g_signal_emit_by_name() if they need to control the page selection
	 * programmatically.
	 */
	void addOnMovePage(void delegate(GtkScrollStep, gint, SourceCompletion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("move-page" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"move-page",
			cast(GCallback)&callBackMovePage,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["move-page"] = 1;
		}
		onMovePageListeners ~= dlg;
	}
	extern(C) static void callBackMovePage(GtkSourceCompletion* completionStruct, GtkScrollStep step, gint num, SourceCompletion _sourceCompletion)
	{
		foreach ( void delegate(GtkScrollStep, gint, SourceCompletion) dlg ; _sourceCompletion.onMovePageListeners )
		{
			dlg(step, num, _sourceCompletion);
		}
	}
	
	void delegate(SourceCompletionContext, SourceCompletion)[] onPopulateContextListeners;
	/**
	 * Emitted just before starting to populate the completion with providers.
	 * You can use this signal to add additional attributes in the context.
	 */
	void addOnPopulateContext(void delegate(SourceCompletionContext, SourceCompletion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("populate-context" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"populate-context",
			cast(GCallback)&callBackPopulateContext,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["populate-context"] = 1;
		}
		onPopulateContextListeners ~= dlg;
	}
	extern(C) static void callBackPopulateContext(GtkSourceCompletion* completionStruct, GtkSourceCompletionContext* context, SourceCompletion _sourceCompletion)
	{
		foreach ( void delegate(SourceCompletionContext, SourceCompletion) dlg ; _sourceCompletion.onPopulateContextListeners )
		{
			dlg(ObjectG.getDObject!(SourceCompletionContext)(context), _sourceCompletion);
		}
	}
	
	void delegate(SourceCompletion)[] onShowListeners;
	/**
	 * Emitted when the completion window is shown. The default handler
	 * will actually show the window.
	 */
	void addOnShow(void delegate(SourceCompletion) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		if ( !("show" in connectedSignals) )
		{
			Signals.connectData(
			getStruct(),
			"show",
			cast(GCallback)&callBackShow,
			cast(void*)this,
			null,
			connectFlags);
			connectedSignals["show"] = 1;
		}
		onShowListeners ~= dlg;
	}
	extern(C) static void callBackShow(GtkSourceCompletion* completionStruct, SourceCompletion _sourceCompletion)
	{
		foreach ( void delegate(SourceCompletion) dlg ; _sourceCompletion.onShowListeners )
		{
			dlg(_sourceCompletion);
		}
	}
	
	
	/**
	 * Add a new GtkSourceCompletionProvider to the completion object. This will
	 * add a reference provider, so make sure to unref your own copy when you
	 * no longer need it.
	 * Params:
	 * provider = a GtkSourceCompletionProvider.
	 * Returns: TRUE if provider was successfully added, otherwise if error is provided, it will be set with the error and FALSE is returned.
	 * Throws: GException on failure.
	 */
	public int addProvider(SourceCompletionProviderIF provider)
	{
		// gboolean gtk_source_completion_add_provider (GtkSourceCompletion *completion,  GtkSourceCompletionProvider *provider,  GError **error);
		GError* err = null;
		
		auto p = gtk_source_completion_add_provider(gtkSourceCompletion, (provider is null) ? null : provider.getSourceCompletionProviderTStruct(), &err);
		
		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
		
		return p;
	}
	
	/**
	 * Remove provider from the completion.
	 * Params:
	 * provider = a GtkSourceCompletionProvider.
	 * Returns: TRUE if provider was successfully removed, otherwise if error is provided, it will be set with the error and FALSE is returned.
	 * Throws: GException on failure.
	 */
	public int removeProvider(SourceCompletionProviderIF provider)
	{
		// gboolean gtk_source_completion_remove_provider  (GtkSourceCompletion *completion,  GtkSourceCompletionProvider *provider,  GError **error);
		GError* err = null;
		
		auto p = gtk_source_completion_remove_provider(gtkSourceCompletion, (provider is null) ? null : provider.getSourceCompletionProviderTStruct(), &err);
		
		if (err !is null)
		{
			throw new GException( new ErrorG(err) );
		}
		
		return p;
	}
	
	/**
	 * Get list of providers registered on completion. The returned list is owned
	 * by the completion and should not be freed.
	 * Returns: list of GtkSourceCompletionProvider. [element-type GtkSource.CompletionProvider][transfer none]
	 */
	public ListG getProviders()
	{
		// GList * gtk_source_completion_get_providers (GtkSourceCompletion *completion);
		auto p = gtk_source_completion_get_providers(gtkSourceCompletion);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(ListG)(cast(GList*) p);
	}
	
	/**
	 * Starts a new completion with the specified GtkSourceCompletionContext and
	 * a list of potential candidate providers for completion.
	 * It can be convenient for showing a completion on-the-fly, without the need to
	 * add or remove providers to the GtkSourceCompletion.
	 * Another solution is to add providers with
	 * gtk_source_completion_add_provider(), and implement
	 * gtk_source_completion_provider_match() for each provider.
	 * Params:
	 * providers = a list of GtkSourceCompletionProvider, or NULL. [element-type GtkSource.CompletionProvider][allow-none]
	 * context = The GtkSourceCompletionContext
	 * with which to start the completion. [transfer floating]
	 * Returns: TRUE if it was possible to the show completion window.
	 */
	public int show(ListG providers, SourceCompletionContext context)
	{
		// gboolean gtk_source_completion_show (GtkSourceCompletion *completion,  GList *providers,  GtkSourceCompletionContext *context);
		return gtk_source_completion_show(gtkSourceCompletion, (providers is null) ? null : providers.getListGStruct(), (context is null) ? null : context.getSourceCompletionContextStruct());
	}
	
	/**
	 * Hides the completion if it is active (visible).
	 */
	public void hide()
	{
		// void gtk_source_completion_hide (GtkSourceCompletion *completion);
		gtk_source_completion_hide(gtkSourceCompletion);
	}
	
	/**
	 * The info widget is the window where the completion displays optional extra
	 * information of the proposal.
	 * Returns: The GtkSourceCompletionInfo window associated with completion. [transfer none]
	 */
	public SourceCompletionInfo getInfoWindow()
	{
		// GtkSourceCompletionInfo * gtk_source_completion_get_info_window  (GtkSourceCompletion *completion);
		auto p = gtk_source_completion_get_info_window(gtkSourceCompletion);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(SourceCompletionInfo)(cast(GtkSourceCompletionInfo*) p);
	}
	
	/**
	 * The GtkSourceView associated with completion.
	 * Returns: The GtkSourceView associated with completion. [type GtkSource.View][transfer none]
	 */
	public SourceView getView()
	{
		// GtkSourceView * gtk_source_completion_get_view (GtkSourceCompletion *completion);
		auto p = gtk_source_completion_get_view(gtkSourceCompletion);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(SourceView)(cast(GtkSourceView*) p);
	}
	
	/**
	 * Create a new GtkSourceCompletionContext for completion. The position where
	 * the completion occurs can be specified by position. If position is NULL,
	 * the current cursor position will be used.
	 * Params:
	 * position = a GtkTextIter, or NULL. [allow-none]
	 * Returns: a new GtkSourceCompletionContext. The reference being returned is a 'floating' reference, so if you invoke gtk_source_completion_show() with this context you don't need to unref it. [transfer floating]
	 */
	public SourceCompletionContext createContext(TextIter position)
	{
		// GtkSourceCompletionContext * gtk_source_completion_create_context  (GtkSourceCompletion *completion,  GtkTextIter *position);
		auto p = gtk_source_completion_create_context(gtkSourceCompletion, (position is null) ? null : position.getTextIterStruct());
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(SourceCompletionContext)(cast(GtkSourceCompletionContext*) p);
	}
	
	/**
	 * Warning
	 * gtk_source_completion_move_window has been deprecated since version 3.8 and should not be used in newly-written code. Use gtk_source_completion_provider_get_start_iter() instead.
	 * Move the completion window to a specific iter.
	 * Params:
	 * iter = a GtkTextIter.
	 */
	public void moveWindow(TextIter iter)
	{
		// void gtk_source_completion_move_window (GtkSourceCompletion *completion,  GtkTextIter *iter);
		gtk_source_completion_move_window(gtkSourceCompletion, (iter is null) ? null : iter.getTextIterStruct());
	}
	
	/**
	 * Block interactive completion. This can be used to disable interactive
	 * completion when inserting or deleting text from the buffer associated with
	 * the completion. Use gtk_source_completion_unblock_interactive() to enable
	 * interactive completion again.
	 */
	public void blockInteractive()
	{
		// void gtk_source_completion_block_interactive  (GtkSourceCompletion *completion);
		gtk_source_completion_block_interactive(gtkSourceCompletion);
	}
	
	/**
	 * Unblock interactive completion. This can be used after using
	 * gtk_source_completion_block_interactive() to enable interactive completion
	 * again.
	 */
	public void unblockInteractive()
	{
		// void gtk_source_completion_unblock_interactive  (GtkSourceCompletion *completion);
		gtk_source_completion_unblock_interactive(gtkSourceCompletion);
	}
}