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=GtkWidget
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 
63 
64 private import gtk.DrawingArea;
65 
66 /**
67  * Description
68  * A GtkSpinner widget displays an icon-size spinning animation.
69  * It is often used as an alternative to a GtkProgressBar for
70  * displaying indefinite activity, instead of actual progress.
71  * To start the animation, use gtk_spinner_start(), to stop it
72  * use gtk_spinner_stop().
73  */
74 public class Spinner : DrawingArea
75 {
76 	
77 	/** the main Gtk struct */
78 	protected GtkSpinner* gtkSpinner;
79 	
80 	
81 	public GtkSpinner* getSpinnerStruct()
82 	{
83 		return gtkSpinner;
84 	}
85 	
86 	
87 	/** the main Gtk struct as a void* */
88 	protected override void* getStruct()
89 	{
90 		return cast(void*)gtkSpinner;
91 	}
92 	
93 	/**
94 	 * Sets our main struct and passes it to the parent class
95 	 */
96 	public this (GtkSpinner* gtkSpinner)
97 	{
98 		super(cast(GtkDrawingArea*)gtkSpinner);
99 		this.gtkSpinner = gtkSpinner;
100 	}
101 	
102 	protected override void setStruct(GObject* obj)
103 	{
104 		super.setStruct(obj);
105 		gtkSpinner = cast(GtkSpinner*)obj;
106 	}
107 	
108 	/**
109 	 */
110 	
111 	/**
112 	 * Returns a new spinner widget. Not yet started.
113 	 * Since 2.20
114 	 * Throws: ConstructionException GTK+ fails to create the object.
115 	 */
116 	public this ()
117 	{
118 		// GtkWidget * gtk_spinner_new (void);
119 		auto p = gtk_spinner_new();
120 		if(p is null)
121 		{
122 			throw new ConstructionException("null returned by gtk_spinner_new()");
123 		}
124 		this(cast(GtkSpinner*) p);
125 	}
126 	
127 	/**
128 	 * Starts the animation of the spinner.
129 	 * Since 2.20
130 	 */
131 	public void start()
132 	{
133 		// void gtk_spinner_start (GtkSpinner *spinner);
134 		gtk_spinner_start(gtkSpinner);
135 	}
136 	
137 	/**
138 	 * Stops the animation of the spinner.
139 	 * Since 2.20
140 	 */
141 	public void stop()
142 	{
143 		// void gtk_spinner_stop (GtkSpinner *spinner);
144 		gtk_spinner_stop(gtkSpinner);
145 	}
146 }