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.
189 lines
3.9 KiB
189 lines
3.9 KiB
/*
|
|
kopetegroup.h - Kopete (Meta)Contact Group
|
|
|
|
Copyright (c) 2002-2004 by Olivier Goffart <ogoffart @ kde.org>
|
|
Copyright (c) 2003 by Martijn Klingens <klingens@kde.org>
|
|
|
|
Kopete (c) 2002-2004 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 Lesser General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2 of the License, or (at your option) any later version. *
|
|
* *
|
|
*************************************************************************
|
|
*/
|
|
|
|
#ifndef KOPETEGROUP_H
|
|
#define KOPETEGROUP_H
|
|
|
|
#include "kopetenotifydataobject.h"
|
|
#include "kopetecontactlistelement.h"
|
|
|
|
#include "kopete_export.h"
|
|
|
|
#include <tqptrlist.h>
|
|
|
|
class TQDomElement;
|
|
|
|
|
|
namespace Kopete {
|
|
|
|
|
|
class MetaContact;
|
|
class Message;
|
|
|
|
/**
|
|
* Class which represents the Group.
|
|
*
|
|
* A Group is a ConstacListElement which means plugin can save datas.
|
|
*
|
|
* some static group are availavle from this class: topLevel and temporary
|
|
*
|
|
* @author Olivier Goffart
|
|
*/
|
|
class KOPETE_EXPORT Group : public ContactListElement, public NotifyDataObject
|
|
{
|
|
TQ_PROPERTY( TQString displayName READ displayName WRITE setDisplayName )
|
|
TQ_PROPERTY( uint groupId READ groupId )
|
|
TQ_PROPERTY( bool expanded READ isExpanded WRITE setExpanded )
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
public:
|
|
/** Kinds of groups. */
|
|
enum GroupType { Normal=0, Temporary, TopLevel };
|
|
|
|
/**
|
|
* \brief Create an empty group
|
|
*
|
|
* Note that the constructor will not add the group automatically to the contact list.
|
|
* Use @ref ContactList::addGroup() to add it
|
|
*/
|
|
Group();
|
|
|
|
/**
|
|
* \brief Create a group of the specified type
|
|
*
|
|
* Overloaded constructor to create a group with a display name of the specified type.
|
|
*/
|
|
Group( const TQString &displayName, GroupType type = Normal );
|
|
|
|
~Group();
|
|
|
|
/**
|
|
* \brief Return the group's display name
|
|
*
|
|
* \return the display name of the group
|
|
*/
|
|
TQString displayName() const;
|
|
|
|
/**
|
|
* \brief Rename the group
|
|
*/
|
|
void setDisplayName( const TQString &newName );
|
|
|
|
/**
|
|
* \return the group type
|
|
*/
|
|
GroupType type() const;
|
|
|
|
/**
|
|
* \brief Set the group type
|
|
*/
|
|
void setType( GroupType newType );
|
|
|
|
/**
|
|
* \return the unique id for this group
|
|
*/
|
|
uint groupId() const;
|
|
|
|
/**
|
|
* @brief child metacontact
|
|
* This function is not very efficient - it searches through all the metacontacts in the contact list
|
|
* \return the members of this group
|
|
*/
|
|
TQPtrList<MetaContact> members() const;
|
|
|
|
/**
|
|
* \brief Set if the group is expanded.
|
|
*
|
|
* This is saved to the xml contactlist file
|
|
*/
|
|
void setExpanded( bool expanded );
|
|
|
|
/**
|
|
*
|
|
* \return true if the group is expanded.
|
|
* \return false otherwise
|
|
*/
|
|
bool isExpanded() const;
|
|
|
|
/**
|
|
* \return a Group pointer to the toplevel group
|
|
*/
|
|
static Group *topLevel();
|
|
|
|
/**
|
|
* \return a Group pointer to the temporary group
|
|
*/
|
|
static Group *temporary();
|
|
|
|
|
|
|
|
/**
|
|
* @internal
|
|
* Outputs the group data in XML
|
|
*/
|
|
const TQDomElement toXML();
|
|
|
|
|
|
/**
|
|
* @internal
|
|
* Loads the group data from XML
|
|
*/
|
|
bool fromXML( const TQDomElement &data );
|
|
|
|
|
|
|
|
|
|
public slots:
|
|
/**
|
|
* Send a message to all contacts in the group
|
|
*/
|
|
void sendMessage();
|
|
|
|
|
|
signals:
|
|
/**
|
|
* \brief Emitted when the group has been renamed
|
|
*/
|
|
void displayNameChanged( Kopete::Group *group , const TQString &oldName );
|
|
|
|
|
|
private slots:
|
|
void sendMessage( Kopete::Message& );
|
|
|
|
private:
|
|
static Group *s_topLevel;
|
|
static Group *s_temporary;
|
|
|
|
class Private;
|
|
Private *d;
|
|
|
|
|
|
/**
|
|
* @internal used to get reachabe contact to send message to thom.
|
|
*/
|
|
TQPtrList<MetaContact> onlineMembers() const;
|
|
};
|
|
|
|
} //END namespace Kopete
|
|
|
|
#endif
|
|
|
|
|