gtk.VSeparator 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.VSeparator;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Separator;
30 private import gtk.Widget;
31 private import gtk.c.functions;
32 public  import gtk.c.types;
33 public  import gtkc.gtktypes;
34 
35 
36 /**
37  * The #GtkVSeparator widget is a vertical separator, used to group the
38  * widgets within a window. It displays a vertical line with a shadow to
39  * make it appear sunken into the interface.
40  * 
41  * GtkVSeparator has been deprecated, use #GtkSeparator instead.
42  */
43 public class VSeparator : Separator
44 {
45 	/** the main Gtk struct */
46 	protected GtkVSeparator* gtkVSeparator;
47 
48 	/** Get the main Gtk struct */
49 	public GtkVSeparator* getVSeparatorStruct(bool transferOwnership = false)
50 	{
51 		if (transferOwnership)
52 			ownedRef = false;
53 		return gtkVSeparator;
54 	}
55 
56 	/** the main Gtk struct as a void* */
57 	protected override void* getStruct()
58 	{
59 		return cast(void*)gtkVSeparator;
60 	}
61 
62 	/**
63 	 * Sets our main struct and passes it to the parent class.
64 	 */
65 	public this (GtkVSeparator* gtkVSeparator, bool ownedRef = false)
66 	{
67 		this.gtkVSeparator = gtkVSeparator;
68 		super(cast(GtkSeparator*)gtkVSeparator, ownedRef);
69 	}
70 
71 
72 	/** */
73 	public static GType getType()
74 	{
75 		return gtk_vseparator_get_type();
76 	}
77 
78 	/**
79 	 * Creates a new #GtkVSeparator.
80 	 *
81 	 * Deprecated: Use gtk_separator_new() with %GTK_ORIENTATION_VERTICAL instead
82 	 *
83 	 * Returns: a new #GtkVSeparator.
84 	 *
85 	 * Throws: ConstructionException GTK+ fails to create the object.
86 	 */
87 	public this()
88 	{
89 		auto p = gtk_vseparator_new();
90 
91 		if(p is null)
92 		{
93 			throw new ConstructionException("null returned by new");
94 		}
95 
96 		this(cast(GtkVSeparator*) p);
97 	}
98 }