pango.PgAttributeShape source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module pango.PgAttributeShape;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import pango.PgAttribute;
30 private import pango.c.functions;
31 public  import pango.c.types;
32 
33 
34 /**
35  * The `PangoAttrShape` structure is used to represent attributes which
36  * impose shape restrictions.
37  */
38 public class PgAttributeShape : PgAttribute
39 {
40 	/** the main Gtk struct */
41 	protected PangoAttrShape* pangoAttrShape;
42 
43 	/** Get the main Gtk struct */
44 	public PangoAttrShape* getPgAttributeShapeStruct(bool transferOwnership = false)
45 	{
46 		if (transferOwnership)
47 			ownedRef = false;
48 		return pangoAttrShape;
49 	}
50 
51 	/** the main Gtk struct as a void* */
52 	protected override void* getStruct()
53 	{
54 		return cast(void*)pangoAttrShape;
55 	}
56 
57 	/**
58 	 * Sets our main struct and passes it to the parent class.
59 	 */
60 	public this (PangoAttrShape* pangoAttrShape, bool ownedRef = false)
61 	{
62 		this.pangoAttrShape = pangoAttrShape;
63 		super(cast(PangoAttribute*)pangoAttrShape, ownedRef);
64 	}
65 
66 
67 	/**
68 	 * Create a new shape attribute.
69 	 *
70 	 * A shape is used to impose a particular ink and logical rectangle
71 	 * on the result of shaping a particular glyph. This might be used,
72 	 * for instance, for embedding a picture or a widget inside a `PangoLayout`.
73 	 *
74 	 * Params:
75 	 *     inkRect = ink rectangle to assign to each character
76 	 *     logicalRect = logical rectangle to assign to each character
77 	 *
78 	 * Returns: the newly allocated `PangoAttribute`,
79 	 *     which should be freed with [method@Pango.Attribute.destroy].
80 	 *
81 	 * Throws: ConstructionException GTK+ fails to create the object.
82 	 */
83 	public this(PangoRectangle* inkRect, PangoRectangle* logicalRect)
84 	{
85 		auto __p = pango_attr_shape_new(inkRect, logicalRect);
86 
87 		if(__p is null)
88 		{
89 			throw new ConstructionException("null returned by new");
90 		}
91 
92 		this(cast(PangoAttrShape*) __p);
93 	}
94 
95 	/**
96 	 * Creates a new shape attribute.
97 	 *
98 	 * Like pango_attr_shape_new(), but a user data pointer is also
99 	 * provided; this pointer can be accessed when later rendering the glyph.
100 	 *
101 	 * Params:
102 	 *     inkRect = ink rectangle to assign to each character
103 	 *     logicalRect = logical rectangle to assign to each character
104 	 *     data = user data pointer
105 	 *     copyFunc = function to copy @data when the
106 	 *         attribute is copied. If %NULL, @data is simply copied as a pointer.
107 	 *     destroyFunc = function to free @data when the
108 	 *         attribute is freed, or %NULL
109 	 *
110 	 * Returns: the newly allocated `PangoAttribute`,
111 	 *     which should be freed with [method@Pango.Attribute.destroy].
112 	 *
113 	 * Since: 1.8
114 	 *
115 	 * Throws: ConstructionException GTK+ fails to create the object.
116 	 */
117 	public this(PangoRectangle* inkRect, PangoRectangle* logicalRect, void* data, PangoAttrDataCopyFunc copyFunc, GDestroyNotify destroyFunc)
118 	{
119 		auto __p = pango_attr_shape_new_with_data(inkRect, logicalRect, data, copyFunc, destroyFunc);
120 
121 		if(__p is null)
122 		{
123 			throw new ConstructionException("null returned by new_with_data");
124 		}
125 
126 		this(cast(PangoAttrShape*) __p);
127 	}
128 }