kdatatool.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 1998, 1999, 2000 Torben Weis <weis@kde.org>
   Copyright (C) 2001 David Faure <faure@kde.org>

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

#include <kio/kio_export.h>
#include <QtCore/QObject>
#include <QtCore/QString>

#include <kaction.h>
#include <kservice.h>
#include <kcomponentdata.h>

class KDataTool;
class QPixmap;
class QStringList;
class KActionCollection;

// If you're only looking at implementing a data-tool, skip directly to the last
// class definition, KDataTool.

class KIO_EXPORT KDataToolInfo
{
public:
    KDataToolInfo();
    KDataToolInfo(const KService::Ptr& service, const KComponentData &instance);
    ~KDataToolInfo();
    KDataToolInfo( const KDataToolInfo& info );
    KDataToolInfo& operator= ( const KDataToolInfo& info );

    QString dataType() const;
    QStringList mimeTypes() const;

    bool isReadOnly() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QPixmap icon() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QPixmap miniIcon() const;
#endif

    QString iconName() const;
    QStringList userCommands() const;
    QStringList commands() const;

    KDataTool* createTool( QObject* parent = 0 ) const;

    KService::Ptr service() const;

    KComponentData componentData() const;

    bool isValid() const;

    static QList<KDataToolInfo> query(const QString& datatype, const QString& mimetype, const KComponentData &instance);

private:
    class KDataToolInfoPrivate;
    KDataToolInfoPrivate * const d;
};


class KIO_EXPORT KDataToolAction : public KAction
{
    Q_OBJECT
public:
    KDataToolAction( const QString & text, const KDataToolInfo & info, const QString & command, QObject *parent );

    ~KDataToolAction();

    static QList<QAction*> dataToolActionList( const QList<KDataToolInfo> & tools, const QObject *receiver, const char* slot, KActionCollection* parent );

Q_SIGNALS:
    void toolActivated( const KDataToolInfo & info, const QString & command );

protected:
    virtual void slotActivated();

private:
    class KDataToolActionPrivate;
    KDataToolActionPrivate * const d;

};

class KIO_EXPORT KDataTool : public QObject
{
    Q_OBJECT
public:
    KDataTool( QObject* parent = 0 );

    ~KDataTool();

    void setComponentData(const KComponentData &componentData);

    const KComponentData &componentData() const;

    virtual bool run( const QString& command, void* data, const QString& datatype, const QString& mimetype) = 0;

private:
    class KDataToolPrivate;
    KDataToolPrivate * const d;
};

#endif