KviIrcUserEntry.h

Go to the documentation of this file.

#ifndef _KVI_IRCUSER_ENTRY_H_
#define _KVI_IRCUSER_ENTRY_H_

//=============================================================================
//
//   File : KviIrcUserEntry.h
//   Creation date : Tue Jan 04 2010 22:45:12 by Elvio Basello
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2010 Elvio Basello (hellvis69 at gmail dot com)
//
//   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 <memory>

#include "kvi_settings.h"
#include "KviAvatar.h"

class KVILIB_API KviIrcUserEntry
{
        friend class KviIrcUserDataBase;

public:
        enum Gender
        {
                Male = 0,   
                Female = 1, 
                Unknown = 3 
        };

        enum UserMode
        {
                UserOp = 1,     
                Voice = 2,      
                HalfOp = 4,     
                Op = 8,         
                ChanAdmin = 16, 
                ChanOwner = 32, 
                ModeMask = UserOp | Voice | HalfOp | Op | ChanAdmin | ChanOwner
        };

        KviIrcUserEntry(const QString & user, const QString & host);

protected:
        QString m_szUser;
        QString m_szHost;

        QString m_szServer;
        QString m_szRealName;
        int m_iHops;
        Gender m_eGender;
        QString m_szUserFlags;

        bool m_bAway;
        bool m_bIrcOp;

        std::unique_ptr<KviAvatar> m_upAvatar;

        int m_nRefs;
        bool m_bBot;
        bool m_bAvatarRequested;

        bool m_bNotFoundRegUserLookup; //wtf?
        QString m_szRegisteredUserName;
        QString m_szLastRegisteredMatchNick;

        QColor m_cachedColor;
        bool m_bUseCustomColor;

        int m_iSmartNickColor;
        QString m_szAccountName;

public:
        int smartNickColor() { return m_iSmartNickColor; };

        void setSmartNickColor(const int iColor) { m_iSmartNickColor = iColor; };

        Gender gender() { return m_eGender; };

        void setBot(bool bIsBot) { m_bBot = bIsBot; };

        void setGender(Gender g) { m_eGender = g; };

        void setUser(const QString & szUser) { m_szUser = szUser; };

        void setServer(const QString & szServ) { m_szServer = szServ; };

        void setRealName(const QString & szReal);

        void setHops(int iHops) { m_iHops = iHops; };

        void setHost(const QString & szHost) { m_szHost = szHost; };

        void setAway(bool bAway) { m_bAway = bAway; };

        void setIrcOp(bool bIrcOp) { m_bIrcOp = bIrcOp; };

        void setAvatar(std::unique_ptr<KviAvatar> upAvatar = nullptr);

        void setAvatar(KviAvatar * upAvatar = nullptr);

        void setUserFlags(const QString & szFlags) { m_szUserFlags = szFlags; };

        bool isBot() { return m_bBot; };

        bool isAway() const { return m_bAway; };

        bool isIrcOp() const { return m_bIrcOp; };

        bool hasUser() { return (!m_szUser.isEmpty()); };

        bool hasHost() { return (!m_szHost.isEmpty()); };

        bool hasServer() { return (!m_szServer.isEmpty()); };

        bool hasRealName() { return (!m_szRealName.isEmpty()); };

        bool hasHops() { return m_iHops >= 0; };

        const QString & user() { return m_szUser; };

        const QString & host() { return m_szHost; };

        const QString & server() { return m_szServer; };

        const QString & realName() { return m_szRealName; };

        const QString & userFlags() { return m_szUserFlags; };

        int hops() { return m_iHops; };

        KviAvatar * avatar() { return m_upAvatar.get(); };

        int nRefs() { return m_nRefs; };

        std::unique_ptr<KviAvatar> forgetAvatar();

        bool avatarRequested() const { return m_bAvatarRequested; };

        void setAvatarRequested() { m_bAvatarRequested = true; };

        const QString & accountName() { return m_szAccountName; };

        void setAccountName(const QString & szAccountName) { m_szAccountName = szAccountName; };

        bool hasAccountName() { return (!m_szAccountName.isEmpty()); };
};

#endif // _KVI_IRCUSER_ENTRY_H_