gtk.HScrollbar 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.HScrollbar;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Adjustment;
30 private import gtk.Scrollbar;
31 private import gtk.Widget;
32 private import gtkc.gtk;
33 public  import gtkc.gtktypes;
34 
35 
36 /**
37  * The #GtkHScrollbar widget is a widget arranged horizontally creating a
38  * scrollbar. See #GtkScrollbar for details on
39  * scrollbars. #GtkAdjustment pointers may be added to handle the
40  * adjustment of the scrollbar or it may be left %NULL in which case one
41  * will be created for you. See #GtkScrollbar for a description of what the
42  * fields in an adjustment represent for a scrollbar.
43  * 
44  * GtkHScrollbar has been deprecated, use #GtkScrollbar instead.
45  */
46 public class HScrollbar : Scrollbar
47 {
48 	/** the main Gtk struct */
49 	protected GtkHScrollbar* gtkHScrollbar;
50 
51 	/** Get the main Gtk struct */
52 	public GtkHScrollbar* getHScrollbarStruct(bool transferOwnership = false)
53 	{
54 		if (transferOwnership)
55 			ownedRef = false;
56 		return gtkHScrollbar;
57 	}
58 
59 	/** the main Gtk struct as a void* */
60 	protected override void* getStruct()
61 	{
62 		return cast(void*)gtkHScrollbar;
63 	}
64 
65 	protected override void setStruct(GObject* obj)
66 	{
67 		gtkHScrollbar = cast(GtkHScrollbar*)obj;
68 		super.setStruct(obj);
69 	}
70 
71 	/**
72 	 * Sets our main struct and passes it to the parent class.
73 	 */
74 	public this (GtkHScrollbar* gtkHScrollbar, bool ownedRef = false)
75 	{
76 		this.gtkHScrollbar = gtkHScrollbar;
77 		super(cast(GtkScrollbar*)gtkHScrollbar, ownedRef);
78 	}
79 
80 
81 	/** */
82 	public static GType getType()
83 	{
84 		return gtk_hscrollbar_get_type();
85 	}
86 
87 	/**
88 	 * Creates a new horizontal scrollbar.
89 	 *
90 	 * Deprecated: Use gtk_scrollbar_new() with %GTK_ORIENTATION_HORIZONTAL instead
91 	 *
92 	 * Params:
93 	 *     adjustment = the #GtkAdjustment to use, or %NULL to create a new adjustment
94 	 *
95 	 * Returns: the new #GtkHScrollbar
96 	 *
97 	 * Throws: ConstructionException GTK+ fails to create the object.
98 	 */
99 	public this(Adjustment adjustment)
100 	{
101 		auto p = gtk_hscrollbar_new((adjustment is null) ? null : adjustment.getAdjustmentStruct());
102 		
103 		if(p is null)
104 		{
105 			throw new ConstructionException("null returned by new");
106 		}
107 		
108 		this(cast(GtkHScrollbar*) p);
109 	}
110 }