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

module pango.PgScriptIter;

public  import gtkc.pangotypes;

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

private import glib.Str;



/**
 * The functions in this section are used to identify the writing
 * system, or script of individual characters
 * and of ranges within a larger text string.
 */
public class PgScriptIter
{
	
	/** the main Gtk struct */
	protected PangoScriptIter* pangoScriptIter;
	
	
	/** Get the main Gtk struct */
	public PangoScriptIter* getPgScriptIterStruct()
	{
		return pangoScriptIter;
	}
	
	
	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)pangoScriptIter;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (PangoScriptIter* pangoScriptIter)
	{
		this.pangoScriptIter = pangoScriptIter;
	}
	
	/**
	 */
	
	/**
	 * Create a new PangoScriptIter, used to break a string of
	 * Unicode into runs by text. No copy is made of text, so
	 * the caller needs to make sure it remains valid until
	 * the iterator is freed with pango_script_iter_free().
	 * Since 1.4
	 * Params:
	 * text = a UTF-8 string
	 * length = length of text, or -1 if text is nul-terminated.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this (string text, int length)
	{
		// PangoScriptIter * pango_script_iter_new (const char *text,  int length);
		auto p = pango_script_iter_new(Str.toStringz(text), length);
		if(p is null)
		{
			throw new ConstructionException("null returned by pango_script_iter_new(Str.toStringz(text), length)");
		}
		this(cast(PangoScriptIter*) p);
	}
	
	/**
	 * Gets information about the range to which iter currently points.
	 * The range is the set of locations p where *start <= p < *end.
	 * (That is, it doesn't include the character stored at *end)
	 * Since 1.4
	 * Params:
	 * start = location to store start position of the range, or NULL. [out][allow-none]
	 * end = location to store end position of the range, or NULL. [out][allow-none]
	 * script = location to store script for range, or NULL. [out][allow-none]
	 */
	public void getRange(out string start, out string end, out PangoScript script)
	{
		// void pango_script_iter_get_range (PangoScriptIter *iter,  const char **start,  const char **end,  PangoScript *script);
		char* outstart = null;
		char* outend = null;
		
		pango_script_iter_get_range(pangoScriptIter, &outstart, &outend, &script);
		
		start = Str.toString(outstart);
		end = Str.toString(outend);
	}
	
	/**
	 * Advances a PangoScriptIter to the next range. If iter
	 * is already at the end, it is left unchanged and FALSE
	 * is returned.
	 * Since 1.4
	 * Returns: TRUE if iter was successfully advanced.
	 */
	public int next()
	{
		// gboolean pango_script_iter_next (PangoScriptIter *iter);
		return pango_script_iter_next(pangoScriptIter);
	}
	
	/**
	 * Frees a PangoScriptIter created with pango_script_iter_new().
	 * Since 1.4
	 */
	public void free()
	{
		// void pango_script_iter_free (PangoScriptIter *iter);
		pango_script_iter_free(pangoScriptIter);
	}
}