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