gtk.CellRendererProgress 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.CellRendererProgress;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.CellRenderer;
30 private import gtk.OrientableIF;
31 private import gtk.OrientableT;
32 private import gtkc.gtk;
33 public  import gtkc.gtktypes;
34 
35 
36 /**
37  * #GtkCellRendererProgress renders a numeric value as a progress par in a cell.
38  * Additionally, it can display a text on top of the progress bar.
39  * 
40  * The #GtkCellRendererProgress cell renderer was added in GTK+ 2.6.
41  */
42 public class CellRendererProgress : CellRenderer, OrientableIF
43 {
44 	/** the main Gtk struct */
45 	protected GtkCellRendererProgress* gtkCellRendererProgress;
46 
47 	/** Get the main Gtk struct */
48 	public GtkCellRendererProgress* getCellRendererProgressStruct(bool transferOwnership = false)
49 	{
50 		if (transferOwnership)
51 			ownedRef = false;
52 		return gtkCellRendererProgress;
53 	}
54 
55 	/** the main Gtk struct as a void* */
56 	protected override void* getStruct()
57 	{
58 		return cast(void*)gtkCellRendererProgress;
59 	}
60 
61 	protected override void setStruct(GObject* obj)
62 	{
63 		gtkCellRendererProgress = cast(GtkCellRendererProgress*)obj;
64 		super.setStruct(obj);
65 	}
66 
67 	/**
68 	 * Sets our main struct and passes it to the parent class.
69 	 */
70 	public this (GtkCellRendererProgress* gtkCellRendererProgress, bool ownedRef = false)
71 	{
72 		this.gtkCellRendererProgress = gtkCellRendererProgress;
73 		super(cast(GtkCellRenderer*)gtkCellRendererProgress, ownedRef);
74 	}
75 
76 	// add the Orientable capabilities
77 	mixin OrientableT!(GtkCellRendererProgress);
78 
79 
80 	/** */
81 	public static GType getType()
82 	{
83 		return gtk_cell_renderer_progress_get_type();
84 	}
85 
86 	/**
87 	 * Creates a new #GtkCellRendererProgress.
88 	 *
89 	 * Returns: the new cell renderer
90 	 *
91 	 * Since: 2.6
92 	 *
93 	 * Throws: ConstructionException GTK+ fails to create the object.
94 	 */
95 	public this()
96 	{
97 		auto p = gtk_cell_renderer_progress_new();
98 		
99 		if(p is null)
100 		{
101 			throw new ConstructionException("null returned by new");
102 		}
103 		
104 		this(cast(GtkCellRendererProgress*) p);
105 	}
106 }