gtk.CustomLayout 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 gtk.CustomLayout;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.LayoutManager;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 
33 
34 /**
35  * `GtkCustomLayout` uses closures for size negotiation.
36  * 
37  * A `GtkCustomLayout `uses closures matching to the old `GtkWidget`
38  * virtual functions for size negotiation, as a convenience API to
39  * ease the porting towards the corresponding `GtkLayoutManager
40  * virtual functions.
41  */
42 public class CustomLayout : LayoutManager
43 {
44 	/** the main Gtk struct */
45 	protected GtkCustomLayout* gtkCustomLayout;
46 
47 	/** Get the main Gtk struct */
48 	public GtkCustomLayout* getCustomLayoutStruct(bool transferOwnership = false)
49 	{
50 		if (transferOwnership)
51 			ownedRef = false;
52 		return gtkCustomLayout;
53 	}
54 
55 	/** the main Gtk struct as a void* */
56 	protected override void* getStruct()
57 	{
58 		return cast(void*)gtkCustomLayout;
59 	}
60 
61 	/**
62 	 * Sets our main struct and passes it to the parent class.
63 	 */
64 	public this (GtkCustomLayout* gtkCustomLayout, bool ownedRef = false)
65 	{
66 		this.gtkCustomLayout = gtkCustomLayout;
67 		super(cast(GtkLayoutManager*)gtkCustomLayout, ownedRef);
68 	}
69 
70 
71 	/** */
72 	public static GType getType()
73 	{
74 		return gtk_custom_layout_get_type();
75 	}
76 
77 	/**
78 	 * Creates a new legacy layout manager.
79 	 *
80 	 * Legacy layout managers map to the old `GtkWidget` size negotiation
81 	 * virtual functions, and are meant to be used during the transition
82 	 * from layout containers to layout manager delegates.
83 	 *
84 	 * Params:
85 	 *     requestMode = a function to retrieve
86 	 *         the `GtkSizeRequestMode` of the widget using the layout; the
87 	 *         default request mode is %GTK_SIZE_REQUEST_CONSTANT_SIZE
88 	 *     measure = a function to measure the widget using the layout manager
89 	 *     allocate = a function to allocate the children of the widget using
90 	 *         the layout manager
91 	 *
92 	 * Returns: the newly created `GtkCustomLayout`
93 	 *
94 	 * Throws: ConstructionException GTK+ fails to create the object.
95 	 */
96 	public this(GtkCustomRequestModeFunc requestMode, GtkCustomMeasureFunc measure, GtkCustomAllocateFunc allocate)
97 	{
98 		auto __p = gtk_custom_layout_new(requestMode, measure, allocate);
99 
100 		if(__p is null)
101 		{
102 			throw new ConstructionException("null returned by new");
103 		}
104 
105 		this(cast(GtkCustomLayout*) __p, true);
106 	}
107 }