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

module pango.PgGlyphString;

public  import gtkc.pangotypes;

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


private import glib.Str;
private import pango.PgFont;




/**
 * Description
 * pango_shape() produces a string of glyphs which
 * can be measured or drawn to the screen. The following
 * structures are used to store information about
 * glyphs.
 */
public class PgGlyphString
{
	
	/** the main Gtk struct */
	protected PangoGlyphString* pangoGlyphString;
	
	
	public PangoGlyphString* getPgGlyphStringStruct()
	{
		return pangoGlyphString;
	}
	
	
	/** the main Gtk struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)pangoGlyphString;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (PangoGlyphString* pangoGlyphString)
	{
		this.pangoGlyphString = pangoGlyphString;
	}
	
	/**
	 */
	
	/**
	 * Create a new PangoGlyphString.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this ()
	{
		// PangoGlyphString * pango_glyph_string_new (void);
		auto p = pango_glyph_string_new();
		if(p is null)
		{
			throw new ConstructionException("null returned by pango_glyph_string_new()");
		}
		this(cast(PangoGlyphString*) p);
	}
	
	/**
	 * Copy a glyph string and associated storage.
	 * Returns: the newly allocated PangoGlyphString, which should be freed with pango_glyph_string_free(), or NULL if string was NULL.
	 */
	public PgGlyphString copy()
	{
		// PangoGlyphString * pango_glyph_string_copy (PangoGlyphString *string);
		auto p = pango_glyph_string_copy(pangoGlyphString);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(PgGlyphString)(cast(PangoGlyphString*) p);
	}
	
	/**
	 * Resize a glyph string to the given length.
	 * Params:
	 * newLen = the new length of the string.
	 */
	public void setSize(int newLen)
	{
		// void pango_glyph_string_set_size (PangoGlyphString *string,  gint new_len);
		pango_glyph_string_set_size(pangoGlyphString, newLen);
	}
	
	/**
	 * Free a glyph string and associated storage.
	 */
	public void free()
	{
		// void pango_glyph_string_free (PangoGlyphString *string);
		pango_glyph_string_free(pangoGlyphString);
	}
	
	/**
	 * Compute the logical and ink extents of a glyph string. See the documentation
	 * for pango_font_get_glyph_extents() for details about the interpretation
	 * of the rectangles.
	 * Params:
	 * font = a PangoFont
	 * inkRect = rectangle used to store the extents of the glyph string as drawn
	 *  or NULL to indicate that the result is not needed.
	 * logicalRect = rectangle used to store the logical extents of the glyph string
	 *  or NULL to indicate that the result is not needed.
	 */
	public void extents(PgFont font, PangoRectangle* inkRect, PangoRectangle* logicalRect)
	{
		// void pango_glyph_string_extents (PangoGlyphString *glyphs,  PangoFont *font,  PangoRectangle *ink_rect,  PangoRectangle *logical_rect);
		pango_glyph_string_extents(pangoGlyphString, (font is null) ? null : font.getPgFontStruct(), inkRect, logicalRect);
	}
	
	/**
	 * Computes the extents of a sub-portion of a glyph string. The extents are
	 * relative to the start of the glyph string range (the origin of their
	 * coordinate system is at the start of the range, not at the start of the entire
	 * glyph string).
	 * Params:
	 * start = start index
	 * end = end index (the range is the set of bytes with
	 * 	 indices such that start <= index < end)
	 * font = a PangoFont
	 * inkRect = rectangle used to store the extents of the glyph string range as drawn
	 *  or NULL to indicate that the result is not needed.
	 * logicalRect = rectangle used to store the logical extents of the glyph string range
	 *  or NULL to indicate that the result is not needed.
	 */
	public void extentsRange(int start, int end, PgFont font, PangoRectangle* inkRect, PangoRectangle* logicalRect)
	{
		// void pango_glyph_string_extents_range (PangoGlyphString *glyphs,  int start,  int end,  PangoFont *font,  PangoRectangle *ink_rect,  PangoRectangle *logical_rect);
		pango_glyph_string_extents_range(pangoGlyphString, start, end, (font is null) ? null : font.getPgFontStruct(), inkRect, logicalRect);
	}
	
	/**
	 * Computes the logical width of the glyph string as can also be computed
	 * using pango_glyph_string_extents(). However, since this only computes the
	 * width, it's much faster. This is in fact only a convenience function that
	 * computes the sum of geometry.width for each glyph in the glyphs.
	 * Since 1.14
	 * Returns: the logical width of the glyph string.
	 */
	public int getWidth()
	{
		// int pango_glyph_string_get_width (PangoGlyphString *glyphs);
		return pango_glyph_string_get_width(pangoGlyphString);
	}
	
	/**
	 * Converts from character position to x position. (X position
	 * is measured from the left edge of the run). Character positions
	 * are computed by dividing up each cluster into equal portions.
	 * Params:
	 * text = the text for the run
	 * length = the number of bytes (not characters) in text.
	 * analysis = the analysis information return from pango_itemize()
	 * index = the byte index within text
	 * trailing = whether we should compute the result for the beginning (FALSE)
	 *  or end (TRUE) of the character.
	 * xPos = location to store result
	 */
	public void indexToX(string text, int length, PangoAnalysis* analysis, int index, int trailing, out int xPos)
	{
		// void pango_glyph_string_index_to_x (PangoGlyphString *glyphs,  char *text,  int length,  PangoAnalysis *analysis,  int index_,  gboolean trailing,  int *x_pos);
		pango_glyph_string_index_to_x(pangoGlyphString, Str.toStringz(text), length, analysis, index, trailing, &xPos);
	}
	
	/**
	 * Convert from x offset to character position. Character positions
	 * are computed by dividing up each cluster into equal portions.
	 * In scripts where positioning within a cluster is not allowed
	 * (such as Thai), the returned value may not be a valid cursor
	 * position; the caller must combine the result with the logical
	 * attributes for the text to compute the valid cursor position.
	 * Params:
	 * text = the text for the run
	 * length = the number of bytes (not characters) in text.
	 * analysis = the analysis information return from pango_itemize()
	 * xPos = the x offset (in Pango units)
	 * index = location to store calculated byte index within text
	 * trailing = location to store a boolean indicating
	 *  whether the user clicked on the leading or trailing
	 *  edge of the character.
	 */
	public void xToIndex(string text, int length, PangoAnalysis* analysis, int xPos, out int index, out int trailing)
	{
		// void pango_glyph_string_x_to_index (PangoGlyphString *glyphs,  char *text,  int length,  PangoAnalysis *analysis,  int x_pos,  int *index_,  int *trailing);
		pango_glyph_string_x_to_index(pangoGlyphString, Str.toStringz(text), length, analysis, xPos, &index, &trailing);
	}
	
	/**
	 * Given a PangoGlyphString resulting from pango_shape() and the corresponding
	 * text, determine the screen width corresponding to each character. When
	 * multiple characters compose a single cluster, the width of the entire
	 * cluster is divided equally among the characters.
	 * See also pango_glyph_item_get_logical_widths().
	 * Params:
	 * text = the text corresponding to the glyphs
	 * length = the length of text, in bytes
	 * embeddingLevel = the embedding level of the string
	 * logicalWidths = an array whose length is the number of characters in
	 *  text (equal to g_utf8_strlen (text, length) unless
	 *  text has NUL bytes)
	 *  to be filled in with the resulting character widths.
	 */
	public void getLogicalWidths(string text, int length, int embeddingLevel, int* logicalWidths)
	{
		// void pango_glyph_string_get_logical_widths  (PangoGlyphString *glyphs,  const char *text,  int length,  int embedding_level,  int *logical_widths);
		pango_glyph_string_get_logical_widths(pangoGlyphString, Str.toStringz(text), length, embeddingLevel, logicalWidths);
	}
}