peas.ConfigurableIF 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.ConfigurableIF;
26 
27 private import gobject.ObjectG;
28 private import gtk.Widget;
29 private import peasc.peas;
30 public  import peasc.peastypes;
31 
32 
33 /**
34  * Interface for configurable plugins.
35  */
36 public interface ConfigurableIF{
37 	/** Get the main Gtk struct */
38 	public PeasGtkConfigurable* getConfigurableStruct(bool transferOwnership = false);
39 
40 	/** the main Gtk struct as a void* */
41 	protected void* getStruct();
42 
43 
44 	/**
45 	 * Creates the configure widget for the plugin. The returned widget
46 	 * should allow configuring all the relevant aspects of the plugin, and should
47 	 * allow instant-apply, as promoted by the Gnome Human Interface Guidelines.
48 	 *
49 	 * #PeasGtkPluginManager will embed the returned widget into a dialog box,
50 	 * but you shouldn't take this behaviour for granted as other implementations
51 	 * of a plugin manager UI might do otherwise.
52 	 *
53 	 * This method should always return a valid #GtkWidget instance, never %NULL.
54 	 *
55 	 * Returns: A #GtkWidget used for configuration.
56 	 */
57 	public Widget createConfigureWidget();
58 }