|
|
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(), filtered ); |
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:
|
Creates a URIFilterData object from the given string.
Parameters:
|
Copy constructor.
Creates a URIFilterData object from another URI filter data object.
Parameters:
~ |
Destructor.
bool |
[const]
This method has been deprecated and will always return TRUE. You should instead use the result from the KURIFilter::filterURI() calls.
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:
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:
bool |
Sets the absolute path to be used whenever the supplied data is a relative local URL.
NOTE: This function works only for a local resource and expects the absolute path to the relative URL set in this meta object. If you are extracting the absolute path from a KURL object, make sure you always set the argument below using KURL::path() instead of KURL::url() so that "file:/" would not be appended! Otherwise, the filter might not be able to make correct determination whether the relative URL locally exists!
Parameters:
Returns: true if absolute path is successfully set. Otherwise, false.
QString |
[const]
Returns the absolute path if one has already been set.
bool |
[const]
Returns true if the supplied data has an absolute path.
QString |
[const]
Returns the command line options and arguments for a local resource when present.
Returns: options and arguments when present, otherwise QString::null
bool |
[const]
Returns true if the current data is a local resource with command line options and arguments.
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: baudens@ke.mandrakesoft.com on Thu Oct 26 17:36:34 2000, using kdoc 2.0a40. |