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