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