kimiface.h

/*
    kimiface.h - KDE Instant Messenger DCOP Interface
 
    Copyright (c) 2004-5 Will Stephenson   <lists@stevello.free-online.co.uk>
 
    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 KIMIFACE_H
#define KIMIFACE_H
 
#include <tqpixmap.h>
#include <dcopobject.h>
#include <tqstringlist.h>
#include <kurl.h>
 
class KIMIface : virtual public DCOPObject
{
    K_DCOP
 
k_dcop:
// ACCESSORS
// contact list
    virtual TQStringList allContacts() = 0;
 
    virtual TQStringList reachableContacts() = 0;
 
    virtual TQStringList onlineContacts() = 0;
 
    virtual TQStringList fileTransferContacts() = 0;
 
// individual
    virtual bool isPresent( const TQString & uid ) = 0;
 
    virtual TQString displayName( const TQString & uid ) = 0;
 
    virtual TQString presenceString( const TQString & uid ) = 0;
 
    virtual int presenceStatus( const TQString & uid ) = 0;
 
    virtual bool canReceiveFiles( const TQString & uid ) = 0;
 
    virtual bool canRespond( const TQString & uid ) = 0;
 
    virtual TQString locate( const TQString & contactId, const TQString & protocol ) = 0;
 
// metadata
    virtual TQPixmap icon( const TQString & uid ) = 0;
 
    virtual TQString context( const TQString & uid ) = 0;
 
// App capabilities
    virtual TQStringList protocols() = 0;
 
// ACTORS
    virtual void messageContact( const TQString &uid, const TQString& message ) = 0;
 
    virtual void messageNewContact( const TQString &contactId, const TQString &protocol ) = 0;
 
    virtual void chatWithContact( const TQString &uid ) = 0;
 
    virtual void sendFile(const TQString &uid, const KURL &sourceURL,
        const TQString &altFileName = TQString::null, uint fileSize = 0) = 0;
 
// MUTATORS
// Contact list
    virtual bool addContact( const TQString &contactId, const TQString &protocol ) = 0;
 
// SIGNALS
k_dcop_signals:
    void contactPresenceChanged( TQString uid, TQCString appId, int presence );
};
 
#endif