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