peas.PluginManager 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 peas.PluginManager;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Box;
30 private import gtk.BuildableIF;
31 private import gtk.BuildableT;
32 private import gtk.OrientableIF;
33 private import gtk.OrientableT;
34 private import gtk.Widget;
35 private import peas.Engine;
36 private import peas.c.functions;
37 public  import peas.c.types;
38 
39 
40 /**
41  * The #PeasGtkPluginManager structure contains only private data
42  * and should only be accessed using the provided API.
43  */
44 public class PluginManager : Box
45 {
46 	/** the main Gtk struct */
47 	protected PeasGtkPluginManager* peasGtkPluginManager;
48 
49 	/** Get the main Gtk struct */
50 	public PeasGtkPluginManager* getPluginManagerStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return peasGtkPluginManager;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)peasGtkPluginManager;
61 	}
62 
63 	/**
64 	 * Sets our main struct and passes it to the parent class.
65 	 */
66 	public this (PeasGtkPluginManager* peasGtkPluginManager, bool ownedRef = false)
67 	{
68 		this.peasGtkPluginManager = peasGtkPluginManager;
69 		super(cast(GtkBox*)peasGtkPluginManager, ownedRef);
70 	}
71 
72 
73 	/** */
74 	public static GType getType()
75 	{
76 		return peas_gtk_plugin_manager_get_type();
77 	}
78 
79 	/**
80 	 * Creates a new plugin manager for the given #PeasEngine.
81 	 *
82 	 * If @engine is %NULL, then the default engine will be used.
83 	 *
84 	 * Params:
85 	 *     engine = A #PeasEngine, or %NULL.
86 	 *
87 	 * Returns: the new #PeasGtkPluginManager.
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this(Engine engine)
92 	{
93 		auto p = peas_gtk_plugin_manager_new((engine is null) ? null : engine.getEngineStruct());
94 
95 		if(p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 
100 		this(cast(PeasGtkPluginManager*) p);
101 	}
102 
103 	/**
104 	 * Returns the #PeasGtkPluginManagerView of @pm.
105 	 *
106 	 * Returns: the #GtkTreeView of @pm.
107 	 */
108 	public Widget getView()
109 	{
110 		auto p = peas_gtk_plugin_manager_get_view(peasGtkPluginManager);
111 
112 		if(p is null)
113 		{
114 			return null;
115 		}
116 
117 		return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
118 	}
119 }