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.CellRendererSpinner;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.CellRenderer;
30 private import gtkc.gtk;
31 public  import gtkc.gtktypes;
32 
33 
34 /**
35  * GtkCellRendererSpinner renders a spinning animation in a cell, very
36  * similar to #GtkSpinner. It can often be used as an alternative
37  * to a #GtkCellRendererProgress for displaying indefinite activity,
38  * instead of actual progress.
39  * 
40  * To start the animation in a cell, set the #GtkCellRendererSpinner:active
41  * property to %TRUE and increment the #GtkCellRendererSpinner:pulse property
42  * at regular intervals. The usual way to set the cell renderer properties
43  * for each cell is to bind them to columns in your tree model using e.g.
44  * gtk_tree_view_column_add_attribute().
45  */
46 public class CellRendererSpinner : CellRenderer
47 {
48 	/** the main Gtk struct */
49 	protected GtkCellRendererSpinner* gtkCellRendererSpinner;
50 
51 	/** Get the main Gtk struct */
52 	public GtkCellRendererSpinner* getCellRendererSpinnerStruct()
53 	{
54 		return gtkCellRendererSpinner;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)gtkCellRendererSpinner;
61 	}
62 
63 	protected override void setStruct(GObject* obj)
64 	{
65 		gtkCellRendererSpinner = cast(GtkCellRendererSpinner*)obj;
66 		super.setStruct(obj);
67 	}
68 
69 	/**
70 	 * Sets our main struct and passes it to the parent class.
71 	 */
72 	public this (GtkCellRendererSpinner* gtkCellRendererSpinner, bool ownedRef = false)
73 	{
74 		this.gtkCellRendererSpinner = gtkCellRendererSpinner;
75 		super(cast(GtkCellRenderer*)gtkCellRendererSpinner, ownedRef);
76 	}
77 
78 	/**
79 	 */
80 
81 	public static GType getType()
82 	{
83 		return gtk_cell_renderer_spinner_get_type();
84 	}
85 
86 	/**
87 	 * Returns a new cell renderer which will show a spinner to indicate
88 	 * activity.
89 	 *
90 	 * Return: a new #GtkCellRenderer
91 	 *
92 	 * Since: 2.20
93 	 *
94 	 * Throws: ConstructionException GTK+ fails to create the object.
95 	 */
96 	public this()
97 	{
98 		auto p = gtk_cell_renderer_spinner_new();
99 		
100 		if(p is null)
101 		{
102 			throw new ConstructionException("null returned by new");
103 		}
104 		
105 		this(cast(GtkCellRendererSpinner*) p);
106 	}
107 }