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.CallbackAction;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.ShortcutAction;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 
33 
34 /**
35  * A `GtkShortcutAction` that invokes a callback.
36  */
37 public class CallbackAction : ShortcutAction
38 {
39 	/** the main Gtk struct */
40 	protected GtkCallbackAction* gtkCallbackAction;
41 
42 	/** Get the main Gtk struct */
43 	public GtkCallbackAction* getCallbackActionStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gtkCallbackAction;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gtkCallbackAction;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GtkCallbackAction* gtkCallbackAction, bool ownedRef = false)
60 	{
61 		this.gtkCallbackAction = gtkCallbackAction;
62 		super(cast(GtkShortcutAction*)gtkCallbackAction, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gtk_callback_action_get_type();
70 	}
71 
72 	/**
73 	 * Create a custom action that calls the given @callback when
74 	 * activated.
75 	 *
76 	 * Params:
77 	 *     callback = the callback to call
78 	 *     data = the data to be passed to @callback
79 	 *     destroy = the function to be called when the
80 	 *         callback action is finalized
81 	 *
82 	 * Returns: A new shortcut action
83 	 *
84 	 * Throws: ConstructionException GTK+ fails to create the object.
85 	 */
86 	public this(GtkShortcutFunc callback, void* data, GDestroyNotify destroy)
87 	{
88 		auto __p = gtk_callback_action_new(callback, data, destroy);
89 
90 		if(__p is null)
91 		{
92 			throw new ConstructionException("null returned by new");
93 		}
94 
95 		this(cast(GtkCallbackAction*) __p, true);
96 	}
97 }