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