kprotocolinfo.h

/* This file is part of the KDE libraries
   Copyright (C) 1999 Torben Weis <[email protected]>
   Copyright (C) 2000-2001 Waldo Bastian <[email protected]>
   Copyright     2012 David Faure <[email protected]>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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 KPROTOCOLINFO_H
#define KPROTOCOLINFO_H

#include "kiocore_export.h"
#include <QVariant>
#include <QStringList>

class KIOCORE_EXPORT KProtocolInfo
{
public:
    //
    // Static functions:
    //

    static QStringList protocols();

    static bool isKnownProtocol(const QUrl &url);

    static bool isKnownProtocol(const QString &protocol);

    static QString exec(const QString &protocol);

    enum Type { T_STREAM, 
                T_FILESYSTEM, 
                T_NONE,   
                T_ERROR   
              };

    struct ExtraField {

        enum Type { String = QVariant::String, DateTime = QVariant::DateTime, Invalid = QVariant::Invalid };

        ExtraField() : type(Invalid) {}
        ExtraField(const QString &_name, Type _type)
            : name(_name), type(_type)
        {
        }
        QString name;
        Type type;
    };
    typedef QList<ExtraField> ExtraFieldList;
    static ExtraFieldList extraFields(const QUrl &url);

    static bool isHelperProtocol(const QUrl &url);

    static bool isHelperProtocol(const QString &protocol);

    static bool isFilterProtocol(const QUrl &url);

    static bool isFilterProtocol(const QString &protocol);

    static QString icon(const QString &protocol);

    static QString config(const QString &protocol);

    static int maxSlaves(const QString &protocol);

    static int maxSlavesPerHost(const QString &protocol);

    static bool determineMimetypeFromExtension(const QString &protocol);

    static QString defaultMimetype(const QString &protocol);

    static QString docPath(const QString &protocol);

    static QString protocolClass(const QString &protocol);

    static bool showFilePreview(const QString &protocol);

    static QStringList capabilities(const QString &protocol);

    static QStringList archiveMimetypes(const QString &protocol);

    static QStringList slaveHandlesNotify(const QString &protocol);

    static QString proxiedBy(const QString &protocol);

    typedef enum { Name, FromUrl, DisplayName } FileNameUsedForCopying;

private:
    Q_DISABLE_COPY(KProtocolInfo)
};

#endif