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