gtk.VolumeButton 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.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 gtkc.gtk;
32 public  import gtkc.gtktypes;
33 
34 
35 /**
36  * #GtkVolumeButton is a subclass of #GtkScaleButton that has
37  * been tailored for use as a volume control widget with suitable
38  * icons, tooltips and accessible labels.
39  */
40 public class VolumeButton : ScaleButton
41 {
42 	/** the main Gtk struct */
43 	protected GtkVolumeButton* gtkVolumeButton;
44 
45 	/** Get the main Gtk struct */
46 	public GtkVolumeButton* getVolumeButtonStruct()
47 	{
48 		return gtkVolumeButton;
49 	}
50 
51 	/** the main Gtk struct as a void* */
52 	protected override void* getStruct()
53 	{
54 		return cast(void*)gtkVolumeButton;
55 	}
56 
57 	protected override void setStruct(GObject* obj)
58 	{
59 		gtkVolumeButton = cast(GtkVolumeButton*)obj;
60 		super.setStruct(obj);
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (GtkVolumeButton* gtkVolumeButton, bool ownedRef = false)
67 	{
68 		this.gtkVolumeButton = gtkVolumeButton;
69 		super(cast(GtkScaleButton*)gtkVolumeButton, ownedRef);
70 	}
71 
72 	/**
73 	 */
74 
75 	public static GType getType()
76 	{
77 		return gtk_volume_button_get_type();
78 	}
79 
80 	/**
81 	 * Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
82 	 * a stepping of 0.02. Volume values can be obtained and modified using
83 	 * the functions from #GtkScaleButton.
84 	 *
85 	 * Return: a new #GtkVolumeButton
86 	 *
87 	 * Since: 2.12
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this()
92 	{
93 		auto p = gtk_volume_button_new();
94 		
95 		if(p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 		
100 		this(cast(GtkVolumeButton*) p);
101 	}
102 }