|
|
This is a basic message object used for exchanging filtering information between the filter plugins and the application whenever the application requires more information about the URI than just a filtered version of it. Any application can create an instance of this class and send it to KURIFilter to have the filter plugins fill the necessary information.
QString text = "kde.org"; KURIFilterData d = text; bool filtered = KURIFilter::self()->filter( d ); if( filtered ) print ( "URI : %s\n"Filtered URI : %s\n URI Type : %i\n"Was Filtered : %i" text.latin1(), d.uri().url().latin1(), d.uriType(), d.hasBeenFiltered() );
The above code should yield the following output:
URI : kde.org Filtered URI : http://kde.org URI Type : 0 <== means NET_PROTOCOL Was Filtered : 1 <== means the URL was successfully filtered
enum |
Describes the type of URI to be filtered.
This enumerator prvoides the return value for uriType. A breif description for each value:
|
Default constructor.
Creates a URIFilterData object.
|
Creates a URIFilterData object from the given URL.
Parameters:
url | is the URL to be filtered. |
|
Creates a URIFilterData object from the given string.
Parameters:
url | is the string to be filtered. |
|
Copy constructor.
Creates a URIFilterData object from another URI filter data object.
Parameters:
data | the uri filter data to be copied. |
~ |
Destructor.
bool |
[const]
Returns true if the URI has been filtered.
This function returns true whenever one of the URI filters plug-ins sucessfully filters the given URL. Use this function to check whether a URL has been filtered or not.
Returns: true if the URL has been filtered.
KURL |
[const]
Returns the filtered or the original URL.
This function returns the filtered url if one of the plugins sucessfully filtered the original URL. Otherwise, it returns the original URL. See hasBeenFiltered() and
Returns: the filtered or original url.
QString |
[const]
Returns an error message.
This functions returns the error message set by the plugin whenever the uri type is set to KURIFilterData::ERROR. Otherwise, it returns a QString::null.
Returns: the error message or a NULL when there is none.
URITypes |
[const]
Returns the URI type.
This method always returns KURIFilterData::UNKNOWN if the given URL was not filtered.
void |
Sets the URL to be filtered.
Use this function to set the string to be filtered when you construct an empty filter object.
Parameters:
url | the string to be filtered. |
void |
Same as above except the argument is a URL.
Use this function to set the string to be filtered when you construct an empty filter object.
Parameters:
url | the URL to be filtered. |
QString |
Returns the name of the icon that matches the current filtered URL.
NOTE that this function will return a NULL string by default and when no associated icon is found.
Returns: the name of the icon associated with the resource
KURIFilterData& |
Overloaded assigenment operator.
This function allows you to easily assign a KURL to a KURIFilterData object.
Returns: an instance of a KURIFilterData object.
KURIFilterData& |
Overloaded assigenment operator.
This function allows you to easily assign a QString to a KURIFilterData object.
Returns: an instance of a KURIFilterData object.
void |
[protected]
Initializes the KURIFilterData on construction.
Generated by: prospector@porky.devel.redhat.com on Thu Aug 24 05:36:06 2000, using kdoc 2.0a36. |