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.CellRendererAccel;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gobject.Signals;
31 private import gtk.CellRenderer;
32 private import gtk.CellRendererText;
33 private import gtk.c.functions;
34 public  import gtk.c.types;
35 private import std.algorithm;
36 
37 
38 /**
39  * Renders a keyboard accelerator in a cell
40  * 
41  * #GtkCellRendererAccel displays a keyboard accelerator (i.e. a key
42  * combination like `Control + a`). If the cell renderer is editable,
43  * the accelerator can be changed by simply typing the new combination.
44  */
45 public class CellRendererAccel : CellRendererText
46 {
47 	/** the main Gtk struct */
48 	protected GtkCellRendererAccel* gtkCellRendererAccel;
49 
50 	/** Get the main Gtk struct */
51 	public GtkCellRendererAccel* getCellRendererAccelStruct(bool transferOwnership = false)
52 	{
53 		if (transferOwnership)
54 			ownedRef = false;
55 		return gtkCellRendererAccel;
56 	}
57 
58 	/** the main Gtk struct as a void* */
59 	protected override void* getStruct()
60 	{
61 		return cast(void*)gtkCellRendererAccel;
62 	}
63 
64 	/**
65 	 * Sets our main struct and passes it to the parent class.
66 	 */
67 	public this (GtkCellRendererAccel* gtkCellRendererAccel, bool ownedRef = false)
68 	{
69 		this.gtkCellRendererAccel = gtkCellRendererAccel;
70 		super(cast(GtkCellRendererText*)gtkCellRendererAccel, ownedRef);
71 	}
72 
73 
74 	/** */
75 	public static GType getType()
76 	{
77 		return gtk_cell_renderer_accel_get_type();
78 	}
79 
80 	/**
81 	 * Creates a new #GtkCellRendererAccel.
82 	 *
83 	 * Returns: the new cell renderer
84 	 *
85 	 * Throws: ConstructionException GTK+ fails to create the object.
86 	 */
87 	public this()
88 	{
89 		auto __p = gtk_cell_renderer_accel_new();
90 
91 		if(__p is null)
92 		{
93 			throw new ConstructionException("null returned by new");
94 		}
95 
96 		this(cast(GtkCellRendererAccel*) __p);
97 	}
98 
99 	/**
100 	 * Gets emitted when the user has removed the accelerator.
101 	 *
102 	 * Params:
103 	 *     pathString = the path identifying the row of the edited cell
104 	 */
105 	gulong addOnAccelCleared(void delegate(string, CellRendererAccel) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
106 	{
107 		return Signals.connect(this, "accel-cleared", dlg, connectFlags ^ ConnectFlags.SWAPPED);
108 	}
109 
110 	/**
111 	 * Gets emitted when the user has selected a new accelerator.
112 	 *
113 	 * Params:
114 	 *     pathString = the path identifying the row of the edited cell
115 	 *     accelKey = the new accelerator keyval
116 	 *     accelMods = the new acclerator modifier mask
117 	 *     hardwareKeycode = the keycode of the new accelerator
118 	 */
119 	gulong addOnAccelEdited(void delegate(string, uint, GdkModifierType, uint, CellRendererAccel) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
120 	{
121 		return Signals.connect(this, "accel-edited", dlg, connectFlags ^ ConnectFlags.SWAPPED);
122 	}
123 }