The nicklist is back! We now have a NickModel that can be attached to an IrcChannel

[quassel.git] / src / client / nickmodel.h

diff --git a/src/client/nickmodel.h b/src/client/nickmodel.h
index 313c678..b49ebf1 100644 (file)
--- a/src/client/nickmodel.h
+++ b/src/client/nickmodel.h
@@ -22,47 +22,51 @@
 #define _NICKMODEL_H_
 
 #include <QAbstractItemModel>
+#include <QVector>
 
 class IrcChannel;
+class IrcUser;
 
-/*
-//! Represents a single IrcUser within a NickTreeModel.
-class NickTreeItem : public TreeItem {
+//! Represents the IrcUsers in a given IrcChannel.
+/** This model is a wrapper around the nicks/IrcUsers stored in an IrcChannel. It provides a tree with two,
+ *  levels, where the top-level items are the categories (such as Ops, Voiced etc), and the second-level items
+ *  the actual nicks/users. Several roles are provided to access information about a nick.
+ *
+ *  Note that the nicks are not sorted in any way. Use a QSortFilterProxyModel to do that instead.
+ */
+class NickModel : public QAbstractItemModel {
   Q_OBJECT
 
   public:
-    NickTreeItem(IrcUser *ircuser, TreeItem *parent = 0);
-
-    //virtual QVariant data(int column, int row) const;
-
-  private:
+    NickModel(IrcChannel *channel = 0, QObject *parent = 0);
+    virtual ~NickModel();
 
-};
+    virtual QModelIndex index(int row, int col, const QModelIndex &parent) const;
+    virtual QModelIndex parent(const QModelIndex &index) const;
+    virtual int rowCount(const QModelIndex &) const;
+    virtual int columnCount(const QModelIndex &) const;
+    virtual QVariant data(const QModelIndex &, int role) const;
+    virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
 
-//! Represents a group of nicks, such as Ops, Voiced etc.
-class NickTreeGroupItem : public TreeItem {
-  Q_OBJECT
+    IrcChannel *ircChannel() const;
 
-  public:
-    NickTreeGroupItem(const QString &title, TreeItem *parent = 0);
+    QModelIndex indexOfUser(IrcUser *) const;
+    int categoryFromModes(const QString &modes) const;
+    int categoryFromIndex(const QModelIndex &index) const;
+    int userCategory(IrcUser *) const;
 
-    //virtual QVariant data(int column, int row) const;
+  public slots:
+    void setIrcChannel(IrcChannel *);
+    void addUser(IrcUser *);
+    void removeUser(IrcUser *);
+    void removeUser(const QModelIndex &);
+    void renameUser(IrcUser *);
+    void changeUserModes(IrcUser *);
 
   private:
 
-};
-*/
-
-//! Represents the IrcUsers in a given IrcChannel.
-class NickModel : public QAbstractItemModel {
-  Q_OBJECT
-
-  public:
-    NickModel(IrcChannel *);
-    virtual ~NickModel();
-
-  private:
-    
+    IrcChannel *_ircChannel;
+    QVector<QList<IrcUser *> > users;
 
 };