KviUserListView.h

Go to the documentation of this file.

#ifndef _KVI_USERLISTVIEW_H_
#define _KVI_USERLISTVIEW_H_
//=============================================================================
//
//   File : KviUserListView.h
//   Creation date : Tue Aug 1 2000 21:03:41 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2000-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   This program 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.
//
//   This program is distributed in the HOPE that it will be USEFUL,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include "kvi_settings.h"
#include "KviPointerList.h"
#include "KviPointerHashTable.h"
#include "KviWindowToolWidget.h"
#include "KviCString.h"
#include "KviIrcUserDataBase.h"
#include "KviIrcMask.h"
#include "KviTimeUtils.h"
#include "KviTalToolTip.h"

#include <time.h>

#include <QWidget>

class QLabel;
class QScrollBar;
class KviUserListView;
class KviUserListViewArea;
class KviConsoleWindow;
class KviWindow;

#define KVI_USERLISTVIEW_GRIDTYPE_3DGRID 0
#define KVI_USERLISTVIEW_GRIDTYPE_3DBUTTONS 1
#define KVI_USERLISTVIEW_GRIDTYPE_PLAINGRID 2
#define KVI_USERLISTVIEW_GRIDTYPE_DOTGRID 3
#define KVI_USERLISTVIEW_GRIDTYPE_MAXIMUM 3
#define KVI_USERLISTVIEW_GRIDTYPE_DEFAULT 0

typedef struct _KviUserListViewUserStats
{
        unsigned int uTotal;     
        unsigned int uActive;    
        unsigned int uActiveOp;  
        unsigned int uHot;       
        unsigned int uHotOp;     
        unsigned int uIrcOp;     
        unsigned int uChanOwner; 
        unsigned int uChanAdmin; 
        unsigned int uOp;        
        unsigned int uHalfOp;    
        unsigned int uVoiced;    
        unsigned int uUserOp;    
        int iAvgTemperature;     
} KviUserListViewUserStats;

class KVIRC_API KviUserListToolTip : public KviTalToolTip
{
public:
        KviUserListToolTip(KviUserListView * pView, KviUserListViewArea * pArea);

        virtual ~KviUserListToolTip();

private:
        KviUserListView * m_pListView;

public:
        virtual void maybeTip(const QPoint & pnt);

        void doTip(const QRect & rect, const QString & szStr) { tip(rect, szStr); };
};

class KVIRC_API KviUserListEntry : public QObject
{
        Q_OBJECT
        friend class KviUserListView;
        friend class KviUserListViewArea;

public:
        KviUserListEntry(KviUserListView * pParent, const QString & szNick, KviIrcUserEntry * pEntry, short int iFlags, bool bJoinTimeUnknown = true);

        ~KviUserListEntry();

protected:
        KviUserListView * m_pListView;
        QString m_szNick;
        KviIrcUserEntry * m_pGlobalData;
        short int m_iFlags;
        short int m_iTemperature; // user temperature : 0 = neutral
        kvi_time_t m_lastActionTime;
        kvi_time_t m_joinTime;

        int m_iHeight;
        bool m_bSelected;
        KviUserListEntry * m_pNext;
        KviUserListEntry * m_pPrev;
        KviAnimatedPixmap * m_pAvatarPixmap;

public:
        short int flags() const { return m_iFlags; };

        KviIrcUserEntry * globalData() { return m_pGlobalData; };

        const QString & nick() const { return m_szNick; };

        KviUserListEntry * next() { return m_pNext; };

        bool color(QColor & color);

        void updateAvatarData();
        void detachAvatarData();

protected:
        void recalcSize();
private slots:
        void avatarFrameChanged();
        void avatarDestroyed();
};

class KVIRC_API KviUserListView : public KviWindowToolWidget
{
        friend class KviUserListEntry;
        friend class KviUserListViewArea;
        friend class KviUserListToolTip;
        friend class KviConsoleWindow;
        friend class KviChannelWindow;
        friend class KviQueryWindow;
        Q_OBJECT
public:
        KviUserListView(QWidget * pParent, KviWindowToolPageButton * pButton, KviIrcUserDataBase * pDb, KviWindow * pWnd, int iDictSize = 5, const QString & szTextLabel = QString(), const char * pName = "userslistview");

        ~KviUserListView();

protected:
        KviPointerHashTable<QString, KviUserListEntry> * m_pEntryDict;
        KviUserListEntry * m_pTopItem;
        KviUserListEntry * m_pHeadItem;
        KviUserListEntry * m_pTailItem;
        KviUserListEntry * m_pIterator;
        QLabel * m_pUsersLabel;
        KviUserListViewArea * m_pViewArea;
        KviIrcUserDataBase * m_pIrcUserDataBase;
        int m_iSelectedCount;
        int m_iIrcOpCount;
        int m_iChanOwnerCount;
        int m_iChanAdminCount;
        int m_iOpCount;
        int m_iHalfOpCount;
        int m_iVoiceCount;
        int m_iUserOpCount;
        int m_iTotalHeight;
        int m_iFontHeight;
        KviUserListToolTip * m_pToolTip;
        int m_ibEntries;
        int m_ieEntries;
        int m_iIEntries;
        KviWindow * m_pKviWindow;

public:
        void updateArea();

        void select(const QString & szNick);

        void ensureVisible(const QString & szNick);

        void applyOptions();

        KviPointerHashTable<QString, KviUserListEntry> * entryDict() { return m_pEntryDict; };

        KviUserListEntry * firstItem() { return m_pHeadItem; };

        KviUserListEntry * itemAt(const QPoint & pnt, QRect * pRect = 0);

        bool itemVisible(KviUserListEntry * pEntry);

        KviWindow * window() { return m_pKviWindow; };

        unsigned int count() { return m_pEntryDict->count(); };

        int selectedCount() { return m_iSelectedCount; };

        int ircOpCount() { return m_iIrcOpCount; };

        int chanOwnerCount() { return m_iChanOwnerCount; };

        int chanAdminCount() { return m_iChanAdminCount; };

        int opCount() { return m_iOpCount; };

        int halfOpCount() { return m_iHalfOpCount; };

        int voiceCount() { return m_iVoiceCount; };

        int userOpCount() { return m_iUserOpCount; };

        KviUserListEntry * findEntry(const QString & szNick) { return szNick.isEmpty() ? 0 : m_pEntryDict->find(szNick); };

        void appendSelectedNicknames(QString & szBuffer);

        QString * firstSelectedNickname();

        QString * nextSelectedNickname();

        void partAll();

        void partAllButOne(const QString & szWhoNot);

        void userStats(KviUserListViewUserStats * pStats);

        int getUserModeLevel(const QString & szNick);

        kvi_time_t getUserJoinTime(const QString & szNick);

        kvi_time_t getUserLastActionTime(const QString & szNick);

        char getUserFlag(KviUserListEntry * pEntry);

        char getUserFlag(const QString & szNick) { return getUserFlag(m_pEntryDict->find(szNick)); };

        bool part(const QString & szNick) { return partInternal(szNick, true); };

        void prependUserFlag(const QString & szNick, QString & szBuffer);

        int flags(const QString & szNick);

        bool isChanOwner(const QString & szNick, bool bAtLeast = false);

        bool isChanAdmin(const QString & szNick, bool bAtLeast = false);

        bool isOp(const QString & szNick, bool bAtLeast = false);

        bool isHalfOp(const QString & szNick, bool bAtLeast = false);

        bool isVoice(const QString & szNick, bool bAtLeast = false);

        bool isUserOp(const QString & szNick, bool bAtLeast = false);

        bool setChanOwner(const QString & szNick, bool bChanOwner);

        bool setChanAdmin(const QString & szNick, bool bChanAdmin);

        bool setOp(const QString & szNick, bool bOp);

        bool setHalfOp(const QString & szNick, bool bHalfOp);

        bool setVoice(const QString & szNick, bool bVoice);

        bool setUserOp(const QString & szNick, bool bUserOp);

        bool userActionVerifyMask(const QString & szNick, const QString & szUser, const QString & szHost, int iActionTemperature, QString & szOldUser, QString & szOldHost);

        void userAction(KviIrcMask * pUser, int iActionTemperature);

        void userAction(const QString & szNick, const QString & szUser, const QString & szHost, int iActionTemperature);

        void userAction(const QString & szNick, int iActionTemperature);

        bool nickChange(const QString & szOldNick, const QString & szNewNick);

        KviUserListEntry * join(const QString & szNick, const QString & szUser = QString(), const QString & szHost = QString(), int iFlags = 0);

        bool avatarChanged(const QString & szNick);

        void enableUpdates(bool bEnable);

        void setMaskEntries(char cType, int iNum);

        void emitRightClick();

        void emitDoubleClick();

        bool completeNickStandard(const QString & szBegin, const QString & szSkipAfter, QString & szBuffer, bool bAppendMask);

        void completeNickBashLike(const QString & szBegin, KviPointerList<QString> * pList, bool bAppendMask);

protected:
        void maybeTip(KviUserListToolTip * pTip, const QPoint & pnt);

        void triggerUpdate();

        void updateUsersLabel();

        void insertUserEntry(const QString & szNick, KviUserListEntry * pEntry);

        void removeAllEntries();

        bool partInternal(const QString & szNick, bool bRemove = true);

        void setUserDataBase(KviIrcUserDataBase * pDb) { m_pIrcUserDataBase = pDb; };

        void updateScrollBarRange();

        virtual void resizeEvent(QResizeEvent * e);
public slots:
        void animatedAvatarUpdated(KviUserListEntry * e);
};

class KVIRC_API KviUserListViewArea : public QWidget
{
        friend class KviUserListView;

        Q_OBJECT
        Q_PROPERTY(int TransparencyCapable READ dummyRead)
public:
        KviUserListViewArea(KviUserListView * pPar);

        ~KviUserListViewArea();

public:
        int dummyRead() const { return 0; };
protected:
        KviUserListView * m_pListView;
        KviUserListEntry * m_pLastEntryUnderMouse;
        QScrollBar * m_pScrollBar;
        int m_iLastScrollBarVal;
        int m_iTopItemOffset;
        bool m_bIgnoreScrollBar;

protected:
        virtual void paintEvent(QPaintEvent * e);
        virtual void resizeEvent(QResizeEvent * e);
        virtual void mousePressEvent(QMouseEvent * e);
        virtual void mouseMoveEvent(QMouseEvent * e);
        virtual void mouseReleaseEvent(QMouseEvent * e);
        virtual void mouseDoubleClickEvent(QMouseEvent * e);
        virtual void wheelEvent(QWheelEvent * e);
        virtual void keyPressEvent(QKeyEvent * e);
protected slots:
        void scrollBarMoved(int iNewVal);
};

#endif //_KVI_USERLISTVIEW_H_