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  * Conversion parameters:
26  * inFile  = GtkCellRendererSpinner.html
27  * outPack = gtk
28  * outFile = CellRendererSpinner
29  * strct   = GtkCellRendererSpinner
30  * realStrct=
31  * ctorStrct=GtkCellRenderer
32  * clss    = CellRendererSpinner
33  * interf  = 
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_cell_renderer_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.CellRendererSpinner;
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.CellRenderer;
63 
64 /**
65  * GtkCellRendererSpinner renders a spinning animation in a cell, very
66  * similar to GtkSpinner. It can often be used as an alternative
67  * to a GtkCellRendererProgress for displaying indefinite activity,
68  * instead of actual progress.
69  *
70  * To start the animation in a cell, set the "active"
71  * property to TRUE and increment the "pulse" property
72  * at regular intervals. The usual way to set the cell renderer properties
73  * for each cell is to bind them to columns in your tree model using e.g.
74  * gtk_tree_view_column_add_attribute().
75  */
76 public class CellRendererSpinner : CellRenderer
77 {
78 	
79 	/** the main Gtk struct */
80 	protected GtkCellRendererSpinner* gtkCellRendererSpinner;
81 	
82 	
83 	/** Get the main Gtk struct */
84 	public GtkCellRendererSpinner* getCellRendererSpinnerStruct()
85 	{
86 		return gtkCellRendererSpinner;
87 	}
88 	
89 	
90 	/** the main Gtk struct as a void* */
91 	protected override void* getStruct()
92 	{
93 		return cast(void*)gtkCellRendererSpinner;
94 	}
95 	
96 	/**
97 	 * Sets our main struct and passes it to the parent class
98 	 */
99 	public this (GtkCellRendererSpinner* gtkCellRendererSpinner)
100 	{
101 		super(cast(GtkCellRenderer*)gtkCellRendererSpinner);
102 		this.gtkCellRendererSpinner = gtkCellRendererSpinner;
103 	}
104 	
105 	protected override void setStruct(GObject* obj)
106 	{
107 		super.setStruct(obj);
108 		gtkCellRendererSpinner = cast(GtkCellRendererSpinner*)obj;
109 	}
110 	
111 	/**
112 	 */
113 	
114 	/**
115 	 * Returns a new cell renderer which will show a spinner to indicate
116 	 * activity.
117 	 * Since 2.20
118 	 * Throws: ConstructionException GTK+ fails to create the object.
119 	 */
120 	public this ()
121 	{
122 		// GtkCellRenderer * gtk_cell_renderer_spinner_new (void);
123 		auto p = gtk_cell_renderer_spinner_new();
124 		if(p is null)
125 		{
126 			throw new ConstructionException("null returned by gtk_cell_renderer_spinner_new()");
127 		}
128 		this(cast(GtkCellRendererSpinner*) p);
129 	}
130 }