/*
 * 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  = GtkSourceSearchSettings.html
 * outPack = gsv
 * outFile = SourceSearchSettings
 * strct   = GtkSourceSearchSettings
 * realStrct=
 * ctorStrct=
 * clss    = SourceSearchSettings
 * interf  = 
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 * 	- gtk_source_search_settings_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.Str
 * structWrap:
 * module aliases:
 * local aliases:
 * overrides:
 */

module gsv.SourceSearchSettings;

public  import gsvc.gsvtypes;

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

private import glib.Str;


private import gobject.ObjectG;

/**
 * A GtkSourceSearchSettings object represents the settings of a search. The
 * search settings can be associated with one or several
 * GtkSourceSearchContexts.
 */
public class SourceSearchSettings : ObjectG
{
	
	/** the main Gtk struct */
	protected GtkSourceSearchSettings* gtkSourceSearchSettings;
	
	
	/** Get the main Gtk struct */
	public GtkSourceSearchSettings* getSourceSearchSettingsStruct()
	{
		return gtkSourceSearchSettings;
	}
	
	
	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkSourceSearchSettings;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GtkSourceSearchSettings* gtkSourceSearchSettings)
	{
		super(cast(GObject*)gtkSourceSearchSettings);
		this.gtkSourceSearchSettings = gtkSourceSearchSettings;
	}
	
	protected override void setStruct(GObject* obj)
	{
		super.setStruct(obj);
		gtkSourceSearchSettings = cast(GtkSourceSearchSettings*)obj;
	}
	
	/**
	 */
	
	/**
	 * Creates a new search settings object.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this ()
	{
		// GtkSourceSearchSettings * gtk_source_search_settings_new  (void);
		auto p = gtk_source_search_settings_new();
		if(p is null)
		{
			throw new ConstructionException("null returned by gtk_source_search_settings_new()");
		}
		this(cast(GtkSourceSearchSettings*) p);
	}
	
	/**
	 * Gets the text to search. The return value must not be freed.
	 * You may be interested to call gtk_source_utils_escape_search_text() after
	 * this function.
	 * Returns: the text to search, or NULL if the search is disabled. Since 3.10
	 */
	public string getSearchText()
	{
		// const gchar * gtk_source_search_settings_get_search_text  (GtkSourceSearchSettings *settings);
		return Str.toString(gtk_source_search_settings_get_search_text(gtkSourceSearchSettings));
	}
	
	/**
	 * Sets the text to search. If text is NULL or is empty, the search will be
	 * disabled. A copy of text will be made, so you can safely free text after
	 * a call to this function.
	 * You may be interested to call gtk_source_utils_unescape_search_text() before
	 * this function.
	 * Params:
	 * searchText = the nul-terminated text to search, or NULL to disable the search. [allow-none]
	 * Since 3.10
	 */
	public void setSearchText(string searchText)
	{
		// void gtk_source_search_settings_set_search_text  (GtkSourceSearchSettings *settings,  const gchar *search_text);
		gtk_source_search_settings_set_search_text(gtkSourceSearchSettings, Str.toStringz(searchText));
	}
	
	/**
	 * Returns: whether the search is case sensitive. Since 3.10
	 */
	public int getCaseSensitive()
	{
		// gboolean gtk_source_search_settings_get_case_sensitive  (GtkSourceSearchSettings *settings);
		return gtk_source_search_settings_get_case_sensitive(gtkSourceSearchSettings);
	}
	
	/**
	 * Enables or disables the case sensitivity for the search.
	 * Params:
	 * caseSensitive = the setting.
	 * Since 3.10
	 */
	public void setCaseSensitive(int caseSensitive)
	{
		// void gtk_source_search_settings_set_case_sensitive  (GtkSourceSearchSettings *settings,  gboolean case_sensitive);
		gtk_source_search_settings_set_case_sensitive(gtkSourceSearchSettings, caseSensitive);
	}
	
	/**
	 * Returns: whether to search at word boundaries. Since 3.10
	 */
	public int getAtWordBoundaries()
	{
		// gboolean gtk_source_search_settings_get_at_word_boundaries  (GtkSourceSearchSettings *settings);
		return gtk_source_search_settings_get_at_word_boundaries(gtkSourceSearchSettings);
	}
	
	/**
	 * Change whether the search is done at word boundaries. If at_word_boundaries
	 * is TRUE, a search match must start and end a word. The match can span
	 * multiple words. See also gtk_text_iter_starts_word() and
	 * gtk_text_iter_ends_word().
	 * Params:
	 * atWordBoundaries = the setting.
	 * Since 3.10
	 */
	public void setAtWordBoundaries(int atWordBoundaries)
	{
		// void gtk_source_search_settings_set_at_word_boundaries  (GtkSourceSearchSettings *settings,  gboolean at_word_boundaries);
		gtk_source_search_settings_set_at_word_boundaries(gtkSourceSearchSettings, atWordBoundaries);
	}
	
	/**
	 * Returns: whether to wrap around the search. Since 3.10
	 */
	public int getWrapAround()
	{
		// gboolean gtk_source_search_settings_get_wrap_around  (GtkSourceSearchSettings *settings);
		return gtk_source_search_settings_get_wrap_around(gtkSourceSearchSettings);
	}
	
	/**
	 * Enables or disables the wrap around search. If wrap_around is TRUE, the
	 * forward search continues at the beginning of the buffer if no search
	 * occurrences are found. Similarly, the backward search continues to search at
	 * the end of the buffer.
	 * Params:
	 * wrapAround = the setting.
	 * Since 3.10
	 */
	public void setWrapAround(int wrapAround)
	{
		// void gtk_source_search_settings_set_wrap_around  (GtkSourceSearchSettings *settings,  gboolean wrap_around);
		gtk_source_search_settings_set_wrap_around(gtkSourceSearchSettings, wrapAround);
	}
	
	/**
	 * Returns: whether to search by regular expressions. Since 3.10
	 */
	public int getRegexEnabled()
	{
		// gboolean gtk_source_search_settings_get_regex_enabled  (GtkSourceSearchSettings *settings);
		return gtk_source_search_settings_get_regex_enabled(gtkSourceSearchSettings);
	}
	
	/**
	 * Enables or disables whether to search by regular expressions.
	 * If enabled, the "search-text" property contains the
	 * pattern of the regular expression.
	 * Params:
	 * regexEnabled = the setting.
	 * Since 3.10
	 */
	public void setRegexEnabled(int regexEnabled)
	{
		// void gtk_source_search_settings_set_regex_enabled  (GtkSourceSearchSettings *settings,  gboolean regex_enabled);
		gtk_source_search_settings_set_regex_enabled(gtkSourceSearchSettings, regexEnabled);
	}
}