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  * # CSS nodes
43  * 
44  * GtkSpinner has a single CSS node with the name spinner.
45  */
46 public class Spinner : Widget
47 {
48 	/** the main Gtk struct */
49 	protected GtkSpinner* gtkSpinner;
50 
51 	/** Get the main Gtk struct */
52 	public GtkSpinner* getSpinnerStruct()
53 	{
54 		return gtkSpinner;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gtkSpinner;
61 	}
62 
63 	protected override void setStruct(GObject* obj)
64 	{
65 		gtkSpinner = cast(GtkSpinner*)obj;
66 		super.setStruct(obj);
67 	}
68 
69 	/**
70 	 * Sets our main struct and passes it to the parent class.
71 	 */
72 	public this (GtkSpinner* gtkSpinner, bool ownedRef = false)
73 	{
74 		this.gtkSpinner = gtkSpinner;
75 		super(cast(GtkWidget*)gtkSpinner, ownedRef);
76 	}
77 
78 
79 	/** */
80 	public static GType getType()
81 	{
82 		return gtk_spinner_get_type();
83 	}
84 
85 	/**
86 	 * Returns a new spinner widget. Not yet started.
87 	 *
88 	 * Return: a new #GtkSpinner
89 	 *
90 	 * Since: 2.20
91 	 *
92 	 * Throws: ConstructionException GTK+ fails to create the object.
93 	 */
94 	public this()
95 	{
96 		auto p = gtk_spinner_new();
97 		
98 		if(p is null)
99 		{
100 			throw new ConstructionException("null returned by new");
101 		}
102 		
103 		this(cast(GtkSpinner*) p);
104 	}
105 
106 	/**
107 	 * Starts the animation of the spinner.
108 	 *
109 	 * Since: 2.20
110 	 */
111 	public void start()
112 	{
113 		gtk_spinner_start(gtkSpinner);
114 	}
115 
116 	/**
117 	 * Stops the animation of the spinner.
118 	 *
119 	 * Since: 2.20
120 	 */
121 	public void stop()
122 	{
123 		gtk_spinner_stop(gtkSpinner);
124 	}
125 }