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