kdatatool.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999, 2000 Torben Weis <weis@kde.org>
   Copyright (C) 2001 David Faure <david@mandrakesoft.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 KDATATOOL_H
#define KDATATOOL_H
 
#include <tqobject.h>
#include <tqvaluelist.h>
 
#include <tdeaction.h>
#include <kservice.h>
 
class KDataTool;
class TQPixmap;
class TQStringList;
class TDEInstance;
 
// If you're only looking at implementing a data-tool, skip directly to the last
// class definition, KDataTool.

class TDEIO_EXPORT KDataToolInfo
{
public:
    KDataToolInfo();
    KDataToolInfo( const KService::Ptr& service, TDEInstance* instance );
    KDataToolInfo( const KDataToolInfo& info );
    KDataToolInfo& operator= ( const KDataToolInfo& info );

    TQString dataType() const;
    TQStringList mimeTypes() const;

    bool isReadOnly() const;

    TQPixmap icon() const TDE_DEPRECATED;
    TQPixmap miniIcon() const TDE_DEPRECATED;
    TQString iconName() const;
    TQStringList userCommands() const;
    TQStringList commands() const;

    KDataTool* createTool( TQObject* parent = 0, const char* name = 0 ) const;

    KService::Ptr service() const;

    TDEInstance* instance() const { return m_instance; }

    bool isValid() const;

    static TQValueList<KDataToolInfo> query( const TQString& datatype, const TQString& mimetype, TDEInstance * instance );
 
private:
    KService::Ptr m_service;
    TDEInstance* m_instance;
private:
    class KDataToolInfoPrivate* d;
};
 

class TDEIO_EXPORT KDataToolAction : public TDEAction
{
    TQ_OBJECT
    
public:
    KDataToolAction( const TQString & text, const KDataToolInfo & info, const TQString & command, TQObject * parent = 0, const char * name = 0);

    static TQPtrList<TDEAction> dataToolActionList( const TQValueList<KDataToolInfo> & tools, const TQObject *receiver, const char* slot );
 
signals:
    void toolActivated( const KDataToolInfo & info, const TQString & command );
 
protected:
    virtual void slotActivated();
 
private:
    TQString m_command;
    KDataToolInfo m_info;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KDataToolActionPrivate* d;
 
};

class TDEIO_EXPORT KDataTool : public TQObject
{
    TQ_OBJECT
    
public:
    KDataTool( TQObject* parent = 0, const char* name = 0 );

    void setInstance( TDEInstance* instance ) { m_instance = instance; }

    TDEInstance* instance() const;

    virtual bool run( const TQString& command, void* data, const TQString& datatype, const TQString& mimetype) = 0;
 
private:
    TDEInstance * m_instance;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KDataToolPrivate;
    KDataToolPrivate * d;
};
 
#endif