• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • interfaces
 

interfaces

  • interfaces
  • tdeimproxy
  • interface
kimiface.h
1 /*
2  kimiface.h - KDE Instant Messenger DCOP Interface
3 
4  Copyright (c) 2004-5 Will Stephenson <lists@stevello.free-online.co.uk>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Library General Public
8  License as published by the Free Software Foundation; either
9  version 2 of the License, or (at your option) any later version.
10 
11  This library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  Library General Public License for more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to
18  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  Boston, MA 02110-1301, USA.
20 */
21 
22 #ifndef KIMIFACE_H
23 #define KIMIFACE_H
24 
25 #include <tqpixmap.h>
26 #include <dcopobject.h>
27 #include <tqstringlist.h>
28 #include <kurl.h>
29 
85 class KIMIface : virtual public DCOPObject
86 {
87  K_DCOP
88 
89 k_dcop:
90 // ACCESSORS
91 // contact list
105  virtual TQStringList allContacts() = 0;
106 
125  virtual TQStringList reachableContacts() = 0;
126 
143  virtual TQStringList onlineContacts() = 0;
144 
168  virtual TQStringList fileTransferContacts() = 0;
169 
170 // individual
185  virtual bool isPresent( const TQString & uid ) = 0;
186 
203  virtual TQString displayName( const TQString & uid ) = 0;
204 
220  virtual TQString presenceString( const TQString & uid ) = 0;
221 
250  virtual int presenceStatus( const TQString & uid ) = 0;
251 
261  virtual bool canReceiveFiles( const TQString & uid ) = 0;
262 
279  virtual bool canRespond( const TQString & uid ) = 0;
280 
296  virtual TQString locate( const TQString & contactId, const TQString & protocol ) = 0;
297 
298 // metadata
315  virtual TQPixmap icon( const TQString & uid ) = 0;
316 
330  virtual TQString context( const TQString & uid ) = 0;
331 
332 // App capabilities
352  virtual TQStringList protocols() = 0;
353 
354 // ACTORS
377  virtual void messageContact( const TQString &uid, const TQString& message ) = 0;
378 
397  virtual void messageNewContact( const TQString &contactId, const TQString &protocol ) = 0;
398 
415  virtual void chatWithContact( const TQString &uid ) = 0;
416 
441  virtual void sendFile(const TQString &uid, const KURL &sourceURL,
442  const TQString &altFileName = TQString::null, uint fileSize = 0) = 0;
443 
444 // MUTATORS
445 // Contact list
463  virtual bool addContact( const TQString &contactId, const TQString &protocol ) = 0;
464 
465 // SIGNALS
466 k_dcop_signals:
485  void contactPresenceChanged( TQString uid, TQCString appId, int presence );
486 };
487 
488 #endif
KURL
KIMIface::context
virtual TQString context(const TQString &uid)=0
Obtain the given contact's current context (home, work, or any)
KIMIface::icon
virtual TQPixmap icon(const TQString &uid)=0
Obtain the icon representing the IM presence for the specified contact.
KIMIface::sendFile
virtual void sendFile(const TQString &uid, const KURL &sourceURL, const TQString &altFileName=TQString::null, uint fileSize=0)=0
Send a file to the contact.
KIMIface::messageContact
virtual void messageContact(const TQString &uid, const TQString &message)=0
Send a single message to the specified contact.
KIMIface::isPresent
virtual bool isPresent(const TQString &uid)=0
Confirm if a given contact is known to the IM application.
KIMIface::messageNewContact
virtual void messageNewContact(const TQString &contactId, const TQString &protocol)=0
Send a single message to a contact given only its protocol specific identifier.
KIMIface::protocols
virtual TQStringList protocols()=0
Obtain a list of supported IM services/protocols.
KIMIface::canReceiveFiles
virtual bool canReceiveFiles(const TQString &uid)=0
Indicate if a given contact can receive files.
KIMIface
Generic DCOP interface for KDE instant messenger applications.
Definition: kimiface.h:85
KIMIface::presenceStatus
virtual int presenceStatus(const TQString &uid)=0
Obtain the IM presence as a number for the specified contact.
KIMIface::allContacts
virtual TQStringList allContacts()=0
Obtain a list of IM-contacts that are known to the application.
KIMIface::presenceString
virtual TQString presenceString(const TQString &uid)=0
Obtain the IM presence as a i18ned string for the specified contact.
KIMIface::fileTransferContacts
virtual TQStringList fileTransferContacts()=0
Obtain a list of IM-contacts who may receive file transfers.
KIMIface::addContact
virtual bool addContact(const TQString &contactId, const TQString &protocol)=0
Add a new contact given its protocol specific identifier.
KIMIface::reachableContacts
virtual TQStringList reachableContacts()=0
Obtain a list of IM-contacts that are currently reachable.
KIMIface::displayName
virtual TQString displayName(const TQString &uid)=0
Obtain the IM app's idea of the contact's display name.
DCOPObject
KIMIface::chatWithContact
virtual void chatWithContact(const TQString &uid)=0
Start a chat session with the specified contact.
KIMIface::locate
virtual TQString locate(const TQString &contactId, const TQString &protocol)=0
Obtain the KABC UID corresponding to the given IM address.
KIMIface::canRespond
virtual bool canRespond(const TQString &uid)=0
Indicate if a given contact will be able to respond.
KIMIface::onlineContacts
virtual TQStringList onlineContacts()=0
Obtain a list of IM-contacts that are currently online.

interfaces

Skip menu "interfaces"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

interfaces

Skip menu "interfaces"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  •     tdecore
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  • tdeioslave
  •   http
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for interfaces by doxygen 1.8.8
This website is maintained by Timothy Pearson.