kopetegroup.h

Go to the documentation of this file.

/*
    kopetegroup.h - Kopete (Meta)Contact Group

    Copyright (c) 2002-2005 by Olivier Goffart       <ogoffart@kde.org>
    Copyright (c) 2003      by Martijn Klingens      <klingens@kde.org>

    Kopete    (c) 2002-2005 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 <QtCore/QList>

#include "kopetecontactlistelement.h"

#include "kopete_export.h"


namespace Kopete {


class MetaContact;
class Message;

class KOPETE_EXPORT Group : public ContactListElement
{
    Q_PROPERTY( QString displayName READ displayName WRITE setDisplayName )
    Q_PROPERTY( uint groupId READ groupId )
    Q_PROPERTY( bool expanded READ isExpanded WRITE setExpanded )

    Q_OBJECT

public:
    typedef QList<Group*> List;

    enum GroupType { Normal=0, Temporary, TopLevel, Offline };

    Group();

    explicit Group( const QString &displayName );

    ~Group();

    QString displayName() const;

    void setDisplayName( const QString &newName );

    GroupType type() const;

    uint groupId() const;

    QList<MetaContact *> members() const;

    void setExpanded( bool expanded );

    bool isExpanded() const;

    static Group *topLevel();

    static Group *temporary();

    static Group *offline();

    void setGroupId( uint groupId );

    uint uniqueGroupId() const;
    void setUniqueGroupId( uint uniqueGroupId );

public slots:
    void sendMessage();


signals:
    void displayNameChanged( Kopete::Group *group , const QString &oldName );

    
private slots:
    void sendMessage( Kopete::Message& );

private:
    Group( const QString &displayName, GroupType type );

    static Group *s_topLevel;
    static Group *s_temporary;
    static Group *s_offline;

    class Private;
    Private * const d;

    QList<MetaContact *> onlineMembers() const;
};

} //END namespace Kopete 

#endif