gtk.VPaned 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.VPaned;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Paned;
30 private import gtk.Widget;
31 private import gtkc.gtk;
32 public  import gtkc.gtktypes;
33 
34 
35 /**
36  * The VPaned widget is a container widget with two
37  * children arranged vertically. The division between
38  * the two panes is adjustable by the user by dragging
39  * a handle. See #GtkPaned for details.
40  * 
41  * GtkVPaned has been deprecated, use #GtkPaned instead.
42  */
43 public class VPaned : Paned
44 {
45 	/** the main Gtk struct */
46 	protected GtkVPaned* gtkVPaned;
47 
48 	/** Get the main Gtk struct */
49 	public GtkVPaned* getVPanedStruct(bool transferOwnership = false)
50 	{
51 		if (transferOwnership)
52 			ownedRef = false;
53 		return gtkVPaned;
54 	}
55 
56 	/** the main Gtk struct as a void* */
57 	protected override void* getStruct()
58 	{
59 		return cast(void*)gtkVPaned;
60 	}
61 
62 	protected override void setStruct(GObject* obj)
63 	{
64 		gtkVPaned = cast(GtkVPaned*)obj;
65 		super.setStruct(obj);
66 	}
67 
68 	/**
69 	 * Sets our main struct and passes it to the parent class.
70 	 */
71 	public this (GtkVPaned* gtkVPaned, bool ownedRef = false)
72 	{
73 		this.gtkVPaned = gtkVPaned;
74 		super(cast(GtkPaned*)gtkVPaned, ownedRef);
75 	}
76 
77 	/**
78 	 * Creates a new HPaned and adds two widgets as it's children
79 	 * Params:
80 	 *  child1 =
81 	 *  child2 =
82 	 */
83 	this(Widget child1, Widget child2)
84 	{
85 		this();
86 		add1(child1);
87 		add2(child2);
88 	}
89 
90 	/**
91 	 */
92 
93 	/** */
94 	public static GType getType()
95 	{
96 		return gtk_vpaned_get_type();
97 	}
98 
99 	/**
100 	 * Create a new #GtkVPaned
101 	 *
102 	 * Deprecated: Use gtk_paned_new() with %GTK_ORIENTATION_VERTICAL instead
103 	 *
104 	 * Returns: the new #GtkVPaned
105 	 *
106 	 * Throws: ConstructionException GTK+ fails to create the object.
107 	 */
108 	public this()
109 	{
110 		auto p = gtk_vpaned_new();
111 		
112 		if(p is null)
113 		{
114 			throw new ConstructionException("null returned by new");
115 		}
116 		
117 		this(cast(GtkVPaned*) p);
118 	}
119 }