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