You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdenetwork/kopete/protocols/groupwise/gwprotocol.h

114 lines
3.9 KiB

/*
gwprotocol.h - Kopete GroupWise Protocol
Copyright (c) 2004 SUSE Linux AG http://www.suse.com
Based on Testbed
Copyright (c) 2003 by Will Stephenson <will@stevello.free-online.co.uk>
rtfizeTest from nm_rtfize_text, from Pidgin src/protocols/novell/nmuser.c
Copyright (c) 2004 Novell, Inc. All Rights Reserved
Kopete (c) 2002-2003 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef TESTBEDPROTOCOL_H
#define TESTBEDPROTOCOL_H
#include <kopeteprotocol.h>
#include "kopetecontactproperty.h"
#include "kopeteonlinestatus.h"
/**
* Encapsulates the generic actions associated with this protocol
* @author Will Stephenson
*/
class GroupWiseProtocol : public Kopete::Protocol
{
Q_OBJECT
public:
GroupWiseProtocol(TQObject *parent, const char *name, const TQStringList &args);
~GroupWiseProtocol();
/**
* Convert the serialised data back into a GroupWiseContact and add this
* to its Kopete::MetaContact
*/
virtual Kopete::Contact *deserializeContact(
Kopete::MetaContact *metaContact,
const TQMap< TQString, TQString > & serializedData,
const TQMap< TQString, TQString > & addressBookData
);
/**
* Generate the widget needed to add GroupWiseContacts
*/
virtual AddContactPage * createAddContactWidget( TQWidget *parent, Kopete::Account *account );
/**
* Generate the widget needed to add/edit accounts for this protocol
*/
virtual KopeteEditAccountWidget * createEditAccountWidget( Kopete::Account *account, TQWidget *parent );
/**
* Generate a GroupWiseAccount
*/
virtual Kopete::Account * createNewAccount( const TQString &accountId );
/**
* Access the instance of this protocol
*/
static GroupWiseProtocol *protocol();
/**
* Transform a GroupWise internal status into a Kopete::OnlineStatus
*/
Kopete::OnlineStatus gwStatusToKOS( const int gwInternal );
/**
* Wrap unformatted text in RTF formatting so that other GroupWise clients will display it
* @param plain unformatted text
* @return RTF text (in UCS-4 encoding)
*/
TQString rtfizeText( const TQString & plain );
/**
* Convert full DNs to dotted-untyped format
* Assumes the DN is normalised - comma separated, no spaces between elements
* eg cn=wstephenson,o=suse becomes wstephenson.suse
*/
static TQString dnToDotted( const TQString & dn );
/**
* Online statuses used for contacts' presence
*/
const Kopete::OnlineStatus groupwiseOffline;
const Kopete::OnlineStatus groupwiseAvailable;
const Kopete::OnlineStatus groupwiseBusy;
const Kopete::OnlineStatus groupwiseAway;
const Kopete::OnlineStatus groupwiseAwayIdle;
const Kopete::OnlineStatus groupwiseAppearOffline;
const Kopete::OnlineStatus groupwiseUnknown;
const Kopete::OnlineStatus groupwiseInvalid;
const Kopete::OnlineStatus groupwiseConnecting;
/**
* Contact properties
*/
const Kopete::ContactPropertyTmpl propGivenName;
const Kopete::ContactPropertyTmpl propLastName;
const Kopete::ContactPropertyTmpl propFullName;
const Kopete::ContactPropertyTmpl propAwayMessage;
const Kopete::ContactPropertyTmpl propAutoReply;
const Kopete::ContactPropertyTmpl propCN;
const Kopete::ContactPropertyTmpl propPhoneWork;
const Kopete::ContactPropertyTmpl propPhoneMobile;
const Kopete::ContactPropertyTmpl propEmail;
protected:
static GroupWiseProtocol *s_protocol;
};
#endif