summaryrefslogtreecommitdiffstats
path: root/kdejava/koala/org/kde/koala/KURIFilterPlugin.java
blob: cb80631d308c1c1224697bc444deb93d0e18c18d (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
//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.TQObject;
import org.kde.qt.TQWidget;
import org.kde.qt.TQObject;

/**

 Base class for URI filter plugins.
 This class applies a single filter to a URI.  All plugins designed
 to provide URI filtering service should inherit from this abstract
 class and provide a concrete implementation.
 All inheriting classes need to implement the pure function
 filterURI.
		@short Abstract class for URI filter plugins.

*/
public class KURIFilterPlugin extends TQObject  {
	protected KURIFilterPlugin(Class dummy){super((Class) null);}
	public native TQMetaObject metaObject();
	public native String className();
	/**	
		 Constructs a filter plugin with a given name and
		 priority.
			@param parent the parent object, or 0 for no parent
			@param name the name of the plugin, or 0 for no name
			@param pri the priority of the plugin.
		     		@short    Constructs a filter plugin with a given name and  priority.
	*/
	/**	
		 Returns the filter's name.
				@return A string naming the filter.
     
		@short    Returns the filter's name.
	*/
	public native String name();
	/**	
		 Returns the filter's priority.
			 Each filter has an assigned priority, a float from 0 to 1. Filters
		 with the lowest priority are first given a chance to filter a URI.
				@return The priority of the filter.
     
		@short    Returns the filter's priority.
	*/
	public native double priority();
	/**	
		 Filters a URI.
			@param data the URI data to be filtered.
				@return A boolean indicating whether the URI has been changed.
     
		@short    Filters a URI.
	*/
	public native boolean filterURI(KURIFilterData data);
	/**	
		 Creates a configuration module for the filter.
			 It is the responsibility of the caller to delete the module
		 once it is not needed anymore.
				@return A configuration module, 0 if the filter isn't configurable.
     
		@short    Creates a configuration module for the filter.
	*/
	public native KCModule configModule(TQWidget arg1, String arg2);
	/**	
		 Returns the name of the configuration module for the filter.
				@return the name of a configuration module or null if none.
     
		@short    Returns the name of the configuration module for the filter.
	*/
	public native String configName();
}