gtk.Spinner 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.Spinner;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Widget;
30 private import gtkc.gtk;
31 public  import gtkc.gtktypes;
32 
33 
34 /**
35  * A GtkSpinner widget displays an icon-size spinning animation.
36  * It is often used as an alternative to a #GtkProgressBar for
37  * displaying indefinite activity, instead of actual progress.
38  * 
39  * To start the animation, use gtk_spinner_start(), to stop it
40  * use gtk_spinner_stop().
41  */
42 public class Spinner : Widget
43 {
44 	/** the main Gtk struct */
45 	protected GtkSpinner* gtkSpinner;
46 
47 	/** Get the main Gtk struct */
48 	public GtkSpinner* getSpinnerStruct()
49 	{
50 		return gtkSpinner;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gtkSpinner;
57 	}
58 
59 	protected override void setStruct(GObject* obj)
60 	{
61 		gtkSpinner = cast(GtkSpinner*)obj;
62 		super.setStruct(obj);
63 	}
64 
65 	/**
66 	 * Sets our main struct and passes it to the parent class.
67 	 */
68 	public this (GtkSpinner* gtkSpinner, bool ownedRef = false)
69 	{
70 		this.gtkSpinner = gtkSpinner;
71 		super(cast(GtkWidget*)gtkSpinner, ownedRef);
72 	}
73 
74 	/**
75 	 */
76 
77 	public static GType getType()
78 	{
79 		return gtk_spinner_get_type();
80 	}
81 
82 	/**
83 	 * Returns a new spinner widget. Not yet started.
84 	 *
85 	 * Return: a new #GtkSpinner
86 	 *
87 	 * Since: 2.20
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this()
92 	{
93 		auto p = gtk_spinner_new();
94 		
95 		if(p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 		
100 		this(cast(GtkSpinner*) p);
101 	}
102 
103 	/**
104 	 * Starts the animation of the spinner.
105 	 *
106 	 * Since: 2.20
107 	 */
108 	public void start()
109 	{
110 		gtk_spinner_start(gtkSpinner);
111 	}
112 
113 	/**
114 	 * Stops the animation of the spinner.
115 	 *
116 	 * Since: 2.20
117 	 */
118 	public void stop()
119 	{
120 		gtk_spinner_stop(gtkSpinner);
121 	}
122 }