gtk.Separator 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.Separator;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.OrientableIF;
30 private import gtk.OrientableT;
31 private import gtk.Widget;
32 private import gtkc.gtk;
33 public  import gtkc.gtktypes;
34 
35 
36 /**
37  * GtkSeparator is a horizontal or vertical separator widget, depending on the
38  * value of the #GtkOrientable:orientation property, used to group the widgets
39  * within a window. It displays a line with a shadow to make it appear sunken
40  * into the interface.
41  */
42 public class Separator : Widget, OrientableIF
43 {
44 	/** the main Gtk struct */
45 	protected GtkSeparator* gtkSeparator;
46 
47 	/** Get the main Gtk struct */
48 	public GtkSeparator* getSeparatorStruct()
49 	{
50 		return gtkSeparator;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gtkSeparator;
57 	}
58 
59 	protected override void setStruct(GObject* obj)
60 	{
61 		gtkSeparator = cast(GtkSeparator*)obj;
62 		super.setStruct(obj);
63 	}
64 
65 	/**
66 	 * Sets our main struct and passes it to the parent class.
67 	 */
68 	public this (GtkSeparator* gtkSeparator, bool ownedRef = false)
69 	{
70 		this.gtkSeparator = gtkSeparator;
71 		super(cast(GtkWidget*)gtkSeparator, ownedRef);
72 	}
73 
74 	// add the Orientable capabilities
75 	mixin OrientableT!(GtkSeparator);
76 
77 	/**
78 	 */
79 
80 	public static GType getType()
81 	{
82 		return gtk_separator_get_type();
83 	}
84 
85 	/**
86 	 * Creates a new #GtkSeparator with the given orientation.
87 	 *
88 	 * Params:
89 	 *     orientation = the separator’s orientation.
90 	 *
91 	 * Return: a new #GtkSeparator.
92 	 *
93 	 * Since: 3.0
94 	 *
95 	 * Throws: ConstructionException GTK+ fails to create the object.
96 	 */
97 	public this(GtkOrientation orientation)
98 	{
99 		auto p = gtk_separator_new(orientation);
100 		
101 		if(p is null)
102 		{
103 			throw new ConstructionException("null returned by new");
104 		}
105 		
106 		this(cast(GtkSeparator*) p);
107 	}
108 }