kurifilter.h

Go to the documentation of this file.

/*
 *  This file is part of the KDE libraries
 *  Copyright (C) 2000-2001,2003,2010 Dawit Alemayehu <adawit at kde.org>
 *
 *  Original author
 *  Copyright (C) 2000 Yves Arrouye <yves@realnames.com>
 *
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/

#ifndef KURIFILTER_H
#define KURIFILTER_H

#include <kio/kio_export.h>
#include <kurl.h>

#include <QtCore/QObject>
#include <QtCore/QHash>
#include <QtCore/QPair>
#include <QtCore/QStringList>

#ifdef Q_OS_WIN
#undef ERROR
#endif

class KUriFilterPrivate;
class KUriFilterDataPrivate;
class KCModule;

class KIO_EXPORT KUriFilterSearchProvider
{
public:
    KUriFilterSearchProvider();

    KUriFilterSearchProvider(const KUriFilterSearchProvider&);

    virtual ~KUriFilterSearchProvider();

    QString desktopEntryName() const;

    QString name() const;

    QString iconName() const;

    QStringList keys() const;

    QString defaultKey() const;

    KUriFilterSearchProvider& operator=(const KUriFilterSearchProvider&);

protected:
    void setDesktopEntryName(const QString&);
    void setIconName(const QString&);
    void setKeys(const QStringList&);
    void setName(const QString&);

private:
    friend class KUriFilterPlugin;
    class KUriFilterSearchProviderPrivate;
    KUriFilterSearchProviderPrivate * const d;
};

class KIO_EXPORT KUriFilterData
{
public:
    enum UriTypes { NetProtocol=0, LocalFile, LocalDir, Executable, Help, Shell, Blocked, Error, Unknown };

    enum SearchFilterOption
    {
        SearchFilterOptionNone = 0x0,
        RetrieveSearchProvidersOnly = 0x01,
        RetrievePreferredSearchProvidersOnly = 0x02,
        RetrieveAvailableSearchProvidersOnly = (RetrievePreferredSearchProvidersOnly | RetrieveSearchProvidersOnly)
    };
    Q_DECLARE_FLAGS(SearchFilterOptions, SearchFilterOption)

    
    KUriFilterData();

    explicit KUriFilterData( const KUrl& url );

    explicit KUriFilterData( const QString& url );

    KUriFilterData( const KUriFilterData& other );

    ~KUriFilterData();

    KUrl uri() const;

    QString errorMsg() const;

    UriTypes uriType() const;

    QString absolutePath() const;

    bool hasAbsolutePath() const;

    QString argsAndOptions() const;

    bool hasArgsAndOptions() const;

    bool checkForExecutables() const;

    QString typedString() const;

    QString searchTerm() const;

    QChar searchTermSeparator() const;

    QString searchProvider() const;

    QStringList preferredSearchProviders() const;

     KUriFilterSearchProvider queryForSearchProvider(const QString& provider) const;

    QString queryForPreferredSearchProvider(const QString &provider) const;

    QStringList allQueriesForSearchProvider(const QString& provider) const;

    QString iconNameForPreferredSearchProvider(const QString &provider) const;

    QStringList alternateSearchProviders() const;

    QString alternateDefaultSearchProvider() const;

    QString defaultUrlScheme() const;

    SearchFilterOptions searchFilteringOptions() const;

    QString iconName();

    void setCheckForExecutables (bool check);

    void setData( const KUrl& url );

    void setData( const QString& url );

    bool setAbsolutePath( const QString& abs_path );

    void setAlternateSearchProviders(const QStringList &providers);

    void setAlternateDefaultSearchProvider(const QString &provider);

    void setDefaultUrlScheme(const QString&);

    void setSearchFilteringOptions(SearchFilterOptions options);

    KUriFilterData& operator=( const KUrl& url );

    KUriFilterData& operator=( const QString& url );

private:
    friend class KUriFilterPlugin;
    KUriFilterDataPrivate * const d;
};


class KIO_EXPORT KUriFilterPlugin : public QObject
{
    Q_OBJECT

public:
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED typedef QHash<QString, QPair<QString, QString> > ProviderInfoList;
#endif

    explicit KUriFilterPlugin( const QString &name, QObject *parent = 0 );

    virtual bool filterUri( KUriFilterData& data ) const = 0;

    virtual KCModule *configModule( QWidget*, const char* ) const;

    virtual QString configName() const;

protected:
    void setFilteredUri ( KUriFilterData& data, const KUrl& uri ) const;

    void setErrorMsg ( KUriFilterData& data, const QString& errmsg ) const;

    void setUriType ( KUriFilterData& data, KUriFilterData::UriTypes type) const;

    void setArguments( KUriFilterData& data, const QString& args ) const;

    void setSearchProvider( KUriFilterData& data, const QString& provider,
                            const QString& term, const QChar& separator) const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setPreferredSearchProviders(KUriFilterData& data, const ProviderInfoList& providers) const;
#endif

    void setSearchProviders(KUriFilterData& data, const QList<KUriFilterSearchProvider*>& providers) const;

    QString iconNameFor(const KUrl& url, KUriFilterData::UriTypes type) const;

private:
    class KUriFilterPluginPrivate * const d;
};

class KIO_EXPORT KUriFilter
{
public:
    enum SearchFilterType {
        NormalTextFilter = 0x01,
        WebShortcutFilter = 0x02
    };
    Q_DECLARE_FLAGS(SearchFilterTypes, SearchFilterType)

    
    ~KUriFilter ();

    static KUriFilter* self();

    bool filterUri( KUriFilterData& data, const QStringList& filters = QStringList() );

    bool filterUri( KUrl &uri, const QStringList& filters = QStringList() );

    bool filterUri( QString &uri, const QStringList& filters = QStringList() );

    KUrl filteredUri( const KUrl &uri, const QStringList& filters = QStringList() );

    QString filteredUri( const QString &uri, const QStringList& filters = QStringList() );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool filterSearchUri(KUriFilterData &data);
#endif

    bool filterSearchUri(KUriFilterData &data, SearchFilterTypes types);

    QStringList pluginNames() const;

protected:

    KUriFilter();

    void loadPlugins();

private:
    KUriFilterPrivate * const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KUriFilterData::SearchFilterOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(KUriFilter::SearchFilterTypes)

#endif