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  * # CSS nodes
43  * 
44  * GtkSeparator has a single CSS node with name separator. The node
45  * gets one of the .horizontal or .vertical style classes.
46  */
47 public class Separator : Widget, OrientableIF
48 {
49 	/** the main Gtk struct */
50 	protected GtkSeparator* gtkSeparator;
51 
52 	/** Get the main Gtk struct */
53 	public GtkSeparator* getSeparatorStruct(bool transferOwnership = false)
54 	{
55 		if (transferOwnership)
56 			ownedRef = false;
57 		return gtkSeparator;
58 	}
59 
60 	/** the main Gtk struct as a void* */
61 	protected override void* getStruct()
62 	{
63 		return cast(void*)gtkSeparator;
64 	}
65 
66 	protected override void setStruct(GObject* obj)
67 	{
68 		gtkSeparator = cast(GtkSeparator*)obj;
69 		super.setStruct(obj);
70 	}
71 
72 	/**
73 	 * Sets our main struct and passes it to the parent class.
74 	 */
75 	public this (GtkSeparator* gtkSeparator, bool ownedRef = false)
76 	{
77 		this.gtkSeparator = gtkSeparator;
78 		super(cast(GtkWidget*)gtkSeparator, ownedRef);
79 	}
80 
81 	// add the Orientable capabilities
82 	mixin OrientableT!(GtkSeparator);
83 
84 
85 	/** */
86 	public static GType getType()
87 	{
88 		return gtk_separator_get_type();
89 	}
90 
91 	/**
92 	 * Creates a new #GtkSeparator with the given orientation.
93 	 *
94 	 * Params:
95 	 *     orientation = the separator’s orientation.
96 	 *
97 	 * Returns: a new #GtkSeparator.
98 	 *
99 	 * Since: 3.0
100 	 *
101 	 * Throws: ConstructionException GTK+ fails to create the object.
102 	 */
103 	public this(GtkOrientation orientation)
104 	{
105 		auto p = gtk_separator_new(orientation);
106 		
107 		if(p is null)
108 		{
109 			throw new ConstructionException("null returned by new");
110 		}
111 		
112 		this(cast(GtkSeparator*) p);
113 	}
114 }