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  * Conversion parameters:
26  * inFile  = GtkSpinner.html
27  * outPack = gtk
28  * outFile = Spinner
29  * strct   = GtkSpinner
30  * realStrct=
31  * ctorStrct=
32  * clss    = Spinner
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_spinner_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * structWrap:
47  * module aliases:
48  * local aliases:
49  * overrides:
50  */
51 
52 module gtk.Spinner;
53 
54 public  import gtkc.gtktypes;
55 
56 private import gtkc.gtk;
57 private import glib.ConstructionException;
58 private import gobject.ObjectG;
59 
60 
61 
62 private import gtk.Widget;
63 
64 /**
65  * A GtkSpinner widget displays an icon-size spinning animation.
66  * It is often used as an alternative to a GtkProgressBar for
67  * displaying indefinite activity, instead of actual progress.
68  *
69  * To start the animation, use gtk_spinner_start(), to stop it
70  * use gtk_spinner_stop().
71  */
72 public class Spinner : Widget
73 {
74 	
75 	/** the main Gtk struct */
76 	protected GtkSpinner* gtkSpinner;
77 	
78 	
79 	/** Get the main Gtk struct */
80 	public GtkSpinner* getSpinnerStruct()
81 	{
82 		return gtkSpinner;
83 	}
84 	
85 	
86 	/** the main Gtk struct as a void* */
87 	protected override void* getStruct()
88 	{
89 		return cast(void*)gtkSpinner;
90 	}
91 	
92 	/**
93 	 * Sets our main struct and passes it to the parent class
94 	 */
95 	public this (GtkSpinner* gtkSpinner)
96 	{
97 		super(cast(GtkWidget*)gtkSpinner);
98 		this.gtkSpinner = gtkSpinner;
99 	}
100 	
101 	protected override void setStruct(GObject* obj)
102 	{
103 		super.setStruct(obj);
104 		gtkSpinner = cast(GtkSpinner*)obj;
105 	}
106 	
107 	/**
108 	 */
109 	
110 	/**
111 	 * Returns a new spinner widget. Not yet started.
112 	 * Since 2.20
113 	 * Throws: ConstructionException GTK+ fails to create the object.
114 	 */
115 	public this ()
116 	{
117 		// GtkWidget * gtk_spinner_new (void);
118 		auto p = gtk_spinner_new();
119 		if(p is null)
120 		{
121 			throw new ConstructionException("null returned by gtk_spinner_new()");
122 		}
123 		this(cast(GtkSpinner*) p);
124 	}
125 	
126 	/**
127 	 * Starts the animation of the spinner.
128 	 * Since 2.20
129 	 */
130 	public void start()
131 	{
132 		// void gtk_spinner_start (GtkSpinner *spinner);
133 		gtk_spinner_start(gtkSpinner);
134 	}
135 	
136 	/**
137 	 * Stops the animation of the spinner.
138 	 * Since 2.20
139 	 */
140 	public void stop()
141 	{
142 		// void gtk_spinner_stop (GtkSpinner *spinner);
143 		gtk_spinner_stop(gtkSpinner);
144 	}
145 }