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.VolumeButton;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.ScaleButton;
30 private import gtk.Widget;
31 private import gtk.c.functions;
32 public  import gtk.c.types;
33 
34 
35 /**
36  * `GtkVolumeButton` is a `GtkScaleButton` subclass tailored for
37  * volume control.
38  * 
39  * ![An example GtkVolumeButton](volumebutton.png)
40  */
41 public class VolumeButton : ScaleButton
42 {
43 	/** the main Gtk struct */
44 	protected GtkVolumeButton* gtkVolumeButton;
45 
46 	/** Get the main Gtk struct */
47 	public GtkVolumeButton* getVolumeButtonStruct(bool transferOwnership = false)
48 	{
49 		if (transferOwnership)
50 			ownedRef = false;
51 		return gtkVolumeButton;
52 	}
53 
54 	/** the main Gtk struct as a void* */
55 	protected override void* getStruct()
56 	{
57 		return cast(void*)gtkVolumeButton;
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (GtkVolumeButton* gtkVolumeButton, bool ownedRef = false)
64 	{
65 		this.gtkVolumeButton = gtkVolumeButton;
66 		super(cast(GtkScaleButton*)gtkVolumeButton, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return gtk_volume_button_get_type();
74 	}
75 
76 	/**
77 	 * Creates a `GtkVolumeButton`.
78 	 *
79 	 * The button has a range between 0.0 and 1.0, with a stepping of 0.02.
80 	 * Volume values can be obtained and modified using the functions from
81 	 * [class@Gtk.ScaleButton].
82 	 *
83 	 * Returns: a new `GtkVolumeButton`
84 	 *
85 	 * Throws: ConstructionException GTK+ fails to create the object.
86 	 */
87 	public this()
88 	{
89 		auto __p = gtk_volume_button_new();
90 
91 		if(__p is null)
92 		{
93 			throw new ConstructionException("null returned by new");
94 		}
95 
96 		this(cast(GtkVolumeButton*) __p);
97 	}
98 }