summaryrefslogtreecommitdiffstats
path: root/kdejava/koala/org/kde/koala/KPluginSelector.java
blob: f40c903e03d357aa86a7808def16b89f48ea7d7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
//Auto-generated by kalyptus. DO NOT EDIT.
package org.kde.koala;

import org.kde.qt.Qt;
import org.kde.qt.TQMetaObject;
import org.kde.qt.QtSupport;
import org.kde.qt.TQWidget;
import org.kde.qt.TQWidget;

/**

 It shows the list of available plugins on top (if there's more than one
 category this is a TabWidget) and the configuration of the selected plugin
 below that.
 Since the user needs a way to know what a specific plugin does every plugin
 sould install a desktop file containing a name, comment and category field.
 The category is usefull for applications that can use different kinds of
 plugins like a playlist, skin or visualization.
 The location of these desktop files is the
 share/apps/<instancename>/<plugindir> directory. But if you need
 you may use a different directory.
 Often a program has more than one kind of plugin. In that case you want to
 make a visible distinction between those plugins. All you have to do is to
 create a KPluginSelectionWidget for every category and then add them all
 to the KPluginSelector.
 See {@link KPluginSelectorSignals} for signals emitted by KPluginSelector
		@author Matthias Kretz <kretz@kde.org>

		@short A widget to select what plugins to load and configure the plugins.

*/
public class KPluginSelector extends TQWidget  {
	protected KPluginSelector(Class dummy){super((Class) null);}
	public native TQMetaObject metaObject();
	public native String className();
	/**	
		 Create a new KPluginSelector.
		         		@short    Create a new KPluginSelector.
	*/
	public KPluginSelector(TQWidget parent, String name) {
		super((Class) null);
		newKPluginSelector(parent,name);
	}
	private native void newKPluginSelector(TQWidget parent, String name);
	public KPluginSelector(TQWidget parent) {
		super((Class) null);
		newKPluginSelector(parent);
	}
	private native void newKPluginSelector(TQWidget parent);
	/**	
		 Add a list of KParts plugins
			 If you want to support non-KParts plugins use the following
		 function.
			 The information about the plugins will be loaded from the
		 share/apps/&lt;instancename&gt;/kpartplugins directory.
			@param instanceName The name of the TDEInstance of the plugin's parent.
			@param catname The translated name of the category. This is the
		                     name that is shown in the TabWidget if there is
		                     more than one category.
			@param category When you have different categories of KParts
		                     plugins you distinguish between the plugins using
		                     the Category key in the .desktop file. Use this
		                     parameter to select only those KParts plugins
		                     with the Category key == <code>category.</code> If <code>category</code> is not set the Category key is ignored
		                     and all plugins are shown.
			@param config The KConfig object that holds the state of the
		                     plugins being enabled or not. By default it should
		                     be instance.config(). It is recommended to
		                     always pass a KConfig object if you use
		                     KSettings.PluginPage since you never know from where the
		                     page will be called (think global config app).
		                     For example KViewCanvas passes KSimpleConfig(
		                     "kviewcanvas" ).
		         		@short    Add a list of KParts plugins
	*/
	public native void addPlugins(String instanceName, String catname, String category, KConfig config);
	public native void addPlugins(String instanceName, String catname, String category);
	public native void addPlugins(String instanceName, String catname);
	public native void addPlugins(String instanceName);
	/**	
		 Add a list of KParts plugins. Convenience method for the one above.
		 If not set explicitely, <code>config</code> is set to instance.config().
		         		@short    Add a list of KParts plugins.
	*/
	public native void addPlugins(TDEInstanceInterface instance, String catname, String category, KConfig config);
	public native void addPlugins(TDEInstanceInterface instance, String catname, String category);
	public native void addPlugins(TDEInstanceInterface instance, String catname);
	public native void addPlugins(TDEInstanceInterface instance);
	/**	
		 Add a list of non-KParts plugins
			@param plugininfos A list of KPluginInfo objects containing the
		                     necessary information for the plugins you want to
		                     add to the list.
			@param catname The translated name of the category. This is the
		                     name that is shown in the TabWidget if there is
		                     more than one category.
			@param category When you have different categories of KParts
		                     plugins you distinguish between the plugins using
		                     the Category key in the .desktop file. Use this
		                     parameter to select only those KParts plugins
		                     with the Category key == <code>category.</code> If <code>category</code> is not set the Category key is ignored
		                     and all plugins are shown.
			@param config The KConfig object that holds the state of the
		                     plugins being enabled or not. By default it will
		                     use TDEGlobal.config(). It is recommended to
		                     always pass a KConfig object if you use
		                     KSettings.PluginPage since you never know from where the
		                     page will be called (think global config app).
		                     For example KViewCanvas passes KSimpleConfig(
		                     "kviewcanvas" ).
		         		@short    Add a list of non-KParts plugins
	*/
	// void addPlugins(const TQValueList<KPluginInfo*>& arg1,const TQString& arg2,const TQString& arg3,KConfig* arg4); >>>> NOT CONVERTED
	// void addPlugins(const TQValueList<KPluginInfo*>& arg1,const TQString& arg2,const TQString& arg3); >>>> NOT CONVERTED
	// void addPlugins(const TQValueList<KPluginInfo*>& arg1,const TQString& arg2); >>>> NOT CONVERTED
	// void addPlugins(const TQValueList<KPluginInfo*>& arg1); >>>> NOT CONVERTED
	/**	
		 Set whether the area for showing the KCMs of the plugins should be
		 hidden if the plugin doesn't have a KCM or whether the layout should
		 rather stay static and only an message should be shown.
			 By default the config page is not hidden.
		         		@short    Set whether the area for showing the KCMs of the plugins should be  hidden if the plugin doesn't have a KCM or whether the layout should  rather stay static and only an message should be shown.
	*/
	public native void setShowEmptyConfigPage(boolean arg1);
	/**	
		 Load the state of the plugins (selected or not) from the KPluginInfo
		 objects. For KParts plugins everything should work automatically. For
		 your own type of plugins you might need to reimplement the
		 KPluginInfo.isPluginEnabled() method. If that doesn't fit your needs
		 you can also reimplement this method.
		         		@short    Load the state of the plugins (selected or not) from the KPluginInfo  objects.
	*/
	public native void load();
	/**	
		 Save the configuration
		         		@short    Save the configuration
	*/
	public native void save();
	/**	
		 Change to applications defaults
		         		@short    Change to applications defaults
	*/
	public native void defaults();
	/** Deletes the wrapped C++ instance */
	protected native void finalize() throws InternalError;
	/** Delete the wrapped C++ instance ahead of finalize() */
	public native void dispose();
	/** Has the wrapped C++ instance been deleted? */
	public native boolean isDisposed();
}