peas.ExtensionBase 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.ExtensionBase;
26 
27 private import glib.Str;
28 private import gobject.ObjectG;
29 private import peas.PluginInfo;
30 private import peas.c.functions;
31 public  import peas.c.types;
32 
33 
34 /**
35  * Base class for C extensions.
36  */
37 public class ExtensionBase : ObjectG
38 {
39 	/** the main Gtk struct */
40 	protected PeasExtensionBase* peasExtensionBase;
41 
42 	/** Get the main Gtk struct */
43 	public PeasExtensionBase* getExtensionBaseStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return peasExtensionBase;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)peasExtensionBase;
54 	}
55 
56 	protected override void setStruct(GObject* obj)
57 	{
58 		peasExtensionBase = cast(PeasExtensionBase*)obj;
59 		super.setStruct(obj);
60 	}
61 
62 	/**
63 	 * Sets our main struct and passes it to the parent class.
64 	 */
65 	public this (PeasExtensionBase* peasExtensionBase, bool ownedRef = false)
66 	{
67 		this.peasExtensionBase = peasExtensionBase;
68 		super(cast(GObject*)peasExtensionBase, ownedRef);
69 	}
70 
71 
72 	/** */
73 	public static GType getType()
74 	{
75 		return peas_extension_base_get_type();
76 	}
77 
78 	/**
79 	 * Get the path of the directory where the plugin should look for
80 	 * its data files.
81 	 *
82 	 * Returns: A newly allocated string with the path of the
83 	 *     directory where the plugin should look for its data files
84 	 */
85 	public string getDataDir()
86 	{
87 		auto retStr = peas_extension_base_get_data_dir(peasExtensionBase);
88 
89 		scope(exit) Str.freeString(retStr);
90 		return Str.toString(retStr);
91 	}
92 
93 	/**
94 	 * Get information relative to @extbase.
95 	 *
96 	 * Returns: the #PeasPluginInfo relative
97 	 *     to the #PeasExtensionBase.
98 	 */
99 	public PluginInfo getPluginInfo()
100 	{
101 		auto p = peas_extension_base_get_plugin_info(peasExtensionBase);
102 
103 		if(p is null)
104 		{
105 			return null;
106 		}
107 
108 		return ObjectG.getDObject!(PluginInfo)(cast(PeasPluginInfo*) p);
109 	}
110 }