gtk.Bin 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.Bin;
26 
27 private import gobject.ObjectG;
28 private import gtk.Container;
29 private import gtk.Widget;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 public  import gtkc.gtktypes;
33 
34 
35 /**
36  * The #GtkBin widget is a container with just one child.
37  * It is not very useful itself, but it is useful for deriving subclasses,
38  * since it provides common code needed for handling a single child widget.
39  * 
40  * Many GTK+ widgets are subclasses of #GtkBin, including #GtkWindow,
41  * #GtkButton, #GtkFrame, #GtkHandleBox or #GtkScrolledWindow.
42  */
43 public class Bin : Container
44 {
45 	/** the main Gtk struct */
46 	protected GtkBin* gtkBin;
47 
48 	/** Get the main Gtk struct */
49 	public GtkBin* getBinStruct(bool transferOwnership = false)
50 	{
51 		if (transferOwnership)
52 			ownedRef = false;
53 		return gtkBin;
54 	}
55 
56 	/** the main Gtk struct as a void* */
57 	protected override void* getStruct()
58 	{
59 		return cast(void*)gtkBin;
60 	}
61 
62 	/**
63 	 * Sets our main struct and passes it to the parent class.
64 	 */
65 	public this (GtkBin* gtkBin, bool ownedRef = false)
66 	{
67 		this.gtkBin = gtkBin;
68 		super(cast(GtkContainer*)gtkBin, ownedRef);
69 	}
70 
71 
72 	/** */
73 	public static GType getType()
74 	{
75 		return gtk_bin_get_type();
76 	}
77 
78 	/**
79 	 * Gets the child of the #GtkBin, or %NULL if the bin contains
80 	 * no child widget. The returned widget does not have a reference
81 	 * added, so you do not need to unref it.
82 	 *
83 	 * Returns: the child of @bin, or %NULL if it does
84 	 *     not have a child.
85 	 */
86 	public Widget getChild()
87 	{
88 		auto p = gtk_bin_get_child(gtkBin);
89 
90 		if(p is null)
91 		{
92 			return null;
93 		}
94 
95 		return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
96 	}
97 }