KviIconManager.h

Go to the documentation of this file.

#ifndef _KVI_ICONMANAGER_H_
#define _KVI_ICONMANAGER_H_

//=============================================================================
//
//   File : KviIconManager.h
//   Creation date : Sat Jun 24 2000 14:49:24 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2000-2010 Szymon Stefanek (pragma at kvirc dot net)
//   Copyright (C) 2011 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 "kvi_settings.h"
#include "KviCString.h"
#include "KviAvatar.h"
#include "KviTimeUtils.h"
#include "KviPointerHashTable.h"

#include <QPixmap>
#include <QObject>
#include <QWidget>

#define KVI_BIGICON_DISCONNECTED "kvi_bigicon_disconnected.png"
#define KVI_BIGICON_CONNECTING "kvi_bigicon_connecting.png"
#define KVI_BIGICON_CONNECTED "kvi_bigicon_connected.png"
#define KVI_BIGICON_TOOLS "kvi_bigicon_tools.png"
#define KVI_BIGICON_ACTIONS "kvi_bigicon_actions.png"
#define KVI_BIGICON_USERACTION "kvi_bigicon_useraction.png"
#define KVI_BIGICON_FOLDER "kvi_bigicon_folder.png"
#define KVI_BIGICON_UNKNOWN "kvi_bigicon_unknown.png"
#define KVI_BIGICON_SEPARATOR "kvi_bigicon_separator.png"
#define KVI_BIGICON_KVS "kvi_bigicon_kvs.png"
#define KVI_BIGICON_THEME "kvi_bigicon_theme.png"
#define KVI_BIGICON_ADDONS "kvi_bigicon_addons.png"

#define KVI_BIGICON_HELP "kvi_bigicon_help.png"
#define KVI_BIGICON_HELPINDEX "kvi_bigicon_helpindex.png"
#define KVI_BIGICON_HELPBACK "kvi_bigicon_helpback.png"
#define KVI_BIGICON_HELPFORWARD "kvi_bigicon_helpforward.png"
#define KVI_BIGICON_HELPCLOSE "kvi_bigicon_helpclose.png"
#define KVI_BIGICON_HELPSEARCH "kvi_bigicon_helpsearch.png"

#define KVI_BIGICON_OPEN "kvi_bigicon_open.png"
#define KVI_BIGICON_SAVE "kvi_bigicon_save.png"
#define KVI_BIGICON_REMOVE "kvi_bigicon_remove.png"
#define KVI_BIGICON_WWW "kvi_bigicon_www.png"
#define KVI_BIGICON_PACK "kvi_bigicon_pack.png"
#define KVI_BIGICON_SCREENSHOT "kvi_bigicon_screenshot.png"
#define KVI_BIGICON_REGUSERS "kvi_bigicon_regusers.png"

#define KVI_SMALLICONS_SUBDIRECTORY "coresmall"
#define KVI_SMALLICONS_PREFIX "kcs_"

// FIXME: this should be removed
#define KVI_SMALLICONS_IMAGELIB_PREFIX "kvi_smallicon_"

#define KVI_USERCHANSTATE_IMAGE_NAME "kvi_userchanstate.png"
#define KVI_ACTIVITYMETER_IMAGE_NAME "kvi_activitymeter.png"

#define KVI_REFRESH_IMAGE_NAME "kvi_icon_refresh.png"

class KVIRC_API KviIconWidget;

class KVIRC_API KviCachedPixmap
{
public:
        KviCachedPixmap(QPixmap * pPix, const QString & szPath);

        ~KviCachedPixmap();

private:
        QString m_szPath;
        kvi_time_t m_tLastAccess;
        QPixmap * m_pPixmap;
        unsigned int m_uSize;

public:
        QPixmap * pixmap() { return m_pPixmap; };

        const QString & path() { return m_szPath; };

        unsigned int size() { return m_uSize; };

        kvi_time_t lastAccessTime() { return m_tLastAccess; };

        void updateLastAccessTime();
};

class KVIRC_API KviIconManager : public QObject
{
        Q_OBJECT
public:
        enum SmallIcon
        {
                None = 0,
                Close = 1,
                History = 2,
                HistoryOff = 3,
                UserMode = 4,
                DefaultIcon = 5,
                Dock = 6,
                UnDock = 7,
                QuitApp = 8,
                Console = 9,
                Save = 10,
                ParserError = 11,
                ParserWarning = 12,
                Server = 13,
                World = 14,
                Proxy = 15,
                KVIrc = 16,
                Cut = 17,
                Copy = 18,
                Paste = 19,
                Options = 20,
                SocketMessage = 21,
                SocketWarning = 22,
                SocketError = 23,
                SystemError = 24,
                Raw = 25,
                SystemWarning = 26,
                SystemMessage = 27,
                UnHandled = 28,
                ServerInfo = 29,
                Motd = 30,
                Channel = 31,
                HideDoubleView = 32,
                ShowDoubleView = 33,
                Op = 34,
                Voice = 35,
                ServerPing = 36,
                ShowListView = 37,
                HideListView = 38,
                Join = 39,
                Part = 40,
                Unrecognized = 41,
                Topic = 42,
                Accept = 43,
                Discard = 44,
                OwnPrivMsg = 45,
                ChanPrivMsg = 46,
                Query = 47,
                QueryPrivMsg = 48,
                Help = 49,
                QuestionMark = 50,
                CtcpReply = 51,
                CtcpRequestReplied = 52,
                CtcpRequestIgnored = 53,
                CtcpRequestFlood = 54,
                CtcpRequestUnknown = 55,
                Action = 56,
                Avatar = 57,
                Quit = 58,
                Split = 59,
                QuitSplit = 60,
                Nick = 61,
                DeOp = 62,
                DeVoice = 63,
                Mode = 64,
                Key = 65,
                Limit = 66,
                Ban = 67,
                UnBan = 68,
                BanExcept = 69,
                BanUnExcept = 70,
                InviteExcept = 71,
                InviteUnExcept = 72,
                ChanMode = 73,
                ChanModeHide = 74,
                Who = 75,
                Editor = 76,
                DccRequest = 77,
                DccMsg = 78,
                DccError = 79,
                IconManager = 80,
                ScriptCenter = 81,
                Bomb = 82,
                Event = 83,
                EventNoHandlers = 84,
                Handler = 85,
                HandlerDisabled = 86,
                NickNameProblem = 87,
                WhoisUser = 88,
                WhoisChannels = 89,
                WhoisIdle = 90,
                WhoisServer = 91,
                WhoisOther = 92,
                Time = 93,
                NotifyOnLine = 94,
                NotifyOffLine = 95,
                Locked = 96,
                UnLocked = 97,
                LockedOff = 98,
                UnLockedOff = 99,
                OwnPrivMsgCrypted = 100,
                ChanPrivMsgCrypted = 101,
                QueryPrivMsgCrypted = 102,
                DccChatMsg = 103,
                DccChatMsgCrypted = 104,
                Irc = 105,
                Folder = 106,
                Home = 107,
                BookMarks = 108,
                Spy = 109,
                Kick = 110,
                Linux = 111,
                Links = 112,
                RegUsers = 113,
                TrayIcon = 114,
                UnsetMode = 115,
                Favorite = 116,
                Toolbar = 117,
                ServerFavorite = 118,
                Log = 119,
                Remove = 120,
                File = 121,
                Icq = 122,
                IcqYellow = 123,
                IcqRed = 124,
                IcqBlue = 125,
                IcqLightGreen = 126,
                IcqLightYellow = 127,
                Message = 128,
                MessageSent = 129,
                BlueSquare = 130,
                VioletSquare = 131,
                YellowSquare = 132,
                GreenSquare = 133,
                BlackSquare = 134,
                RedSquare = 135,
                CyanSquare = 136,
                DarkGreenSquare = 137,
                Terminal = 138,
                WallOps = 139,
                Invisible = 140,
                ServerNotice = 141,
                Gnutella = 142,
                Search = 143,
                Files = 144,
                NewNetwork = 145,
                Package = 146,
                NewServer = 147,
                Idea = 148,
                Colors = 149,
                Gui = 150,
                IrcView = 151,
                Alias = 152,
                ChannelNotice = 153,
                ChannelNoticeCrypted = 154,
                QueryNotice = 155,
                QueryNoticeCrypted = 156,
                MenuBar = 157,
                Popup = 158,
                Prologue = 159,
                Epilogue = 160,
                SharedFiles = 161,
                CtcpReplyUnknown = 162,
                Canvas = 163,
                NickServ = 164,
                ChanServ = 165,
                DccVoice = 166,
                Play = 167,
                Record = 168,
                KickOff = 169,
                Away = 170,
                Ident = 171,
                HomePage = 172,
                List = 173,
                HalfOp = 174,
                HalfDeOp = 175,
                Invite = 176,
                MultiMedia = 177,
                User = 178,
                Input = 179,
                Messages = 180,
                QueryTrace = 181,
                NoChannel = 182,
                BroadcastPrivMsg = 183,
                BroadcastNotice = 184,
                Url = 185,
                RawEvent = 186,
                RawEventNoHandlers = 187,
                MeKick = 188,
                MeOp = 189,
                MeVoice = 190,
                MeDeOp = 191,
                MeDeVoice = 192,
                MeHalfOp = 193,
                MeDeHalfOp = 194,
                MeBan = 195,
                MeUnBan = 196,
                MeBanExcept = 197,
                MeBanUnExcept = 198,
                MeInviteExcept = 199,
                MeInviteUnExcept = 200,
                ClassicWindowList = 201,
                TreeWindowList = 202,
                Ignore = 203,
                UserList = 204,
                Stats = 205,
                PopupMenu = 206,
                ServerConfiguration = 207,
                Irc0 = 208,
                Irc1 = 209,
                Irc2 = 210,
                Irc3 = 211,
                Irc4 = 212,
                Irc5 = 213,
                Heart = 214,
                HeartBroken = 215,
                Rose = 216,
                BigGrin = 217,
                BigGrinGlasses = 218,
                BigGrinEyes = 219,
                TextExclamative = 220,
                TextPoints = 221,
                Kiss = 222,
                Surprised1 = 223,
                Ugly = 224,
                Angry = 225,
                Surprised2 = 226,
                Smile = 227,
                Tongue = 228,
                Ssl = 229,
                Cry = 230,
                Eye = 231,
                DeadChannel = 232,
                DeadQuery = 233,
                Sound = 234,
                ToolBarEditor = 235,
                TextEncoding = 236,
                NewItem = 237,
                NewItemByWizard = 238,
                DeleteItem = 239,
                EditItem = 240,
                FileTransfer = 241,
                ChanAdmin = 242,
                ChanUnAdmin = 243,
                MeChanAdmin = 244,
                MeChanUnAdmin = 245,
                UserOp = 246,
                DeUserOp = 247,
                MeUserOp = 248,
                MeDeUserOp = 249,
                Applet = 250,
                Spam = 251,
                Transparent = 252,
                Notifier = 253,
                UserWindow = 254,
                StatusBar = 255,
                NotAway = 256,
                Plus = 257,
                Minus = 258,
                BinaryText = 259,
                ChanOwner = 260,
                ChanUnOwner = 261,
                MeChanOwner = 262,
                MeChanUnOwner = 263,
                Afraid = 264,
                Teeth = 265,
                SysMonitor = 266,
                SayColors = 267,
                Finger = 268,
                HighlightText = 269,
                TearSmile = 270,
                Shy = 271,
                ServerError = 272,
                Cafe = 273,
                Addons = 274,
                ChanOwnerAway = 275,
                OpAway = 276,
                VoiceAway = 277,
                ChanAdminAway = 278,
                UserOpAway = 279,
                HalfOpAway = 280,
                ClassEditor = 281,
                Demoralized = 282,
                Slurp = 283,
                NameSpace = 284,
                SaySmile = 285,
                SayKvs = 286,
                ThemeOptions = 287,
                Bug = 288,
                Refresh = 289,
                Theme = 290,
                ScreenShot = 291,
                Update = 292,
                NotUpdate = 293,
                FailUpdate = 294,
                UnreadText = 295,
                IrcOp = 296,
                IrcOpAway = 297,
                DeIrcOp = 298,
                MeIrcOp = 299,
                MeDeIrcOp = 300,
                Angel = 301,
                Clown = 302,
                Devil = 303,
                InLove = 304,
                Ninja = 305,
                Pirate = 306,
                Puke = 307,
                Rage = 308,
                Class = 309,
                ClassNotBuilt = 310,
                Function = 311,
                SexMale = 312,
                SexFemale = 313,
                IrcBot = 314,
                AlienIrcOp = 315,
                MemoServ = 316,
                Info = 317,
                Warning = 318,
                Shield = 319,
                RawEventEditor = 320,
                EventEditor = 321,
                ActionEditor = 322,
                AliasEditor = 323,
                PopupEditor = 324,
                Dcc = 325,
                Socket = 326,
                Cake = 327,
                HandIly = 328,
                ThumbDown = 329,
                ThumbUp = 330,
                FacePalm = 331,
                Identity = 332,
                NickPopup = 333,
                Tools = 334,
                FavoriteOff = 335,
                NewProxy = 336,
                IconCount = 337
        };

        KviIconManager();

        ~KviIconManager();

private:
        QPixmap * m_smallIcons[IconCount];
        KviIconWidget * m_pIconWidget;
        KviPointerHashTable<QString, KviCachedPixmap> * m_pCachedImages;
        KviPointerHashTable<QString, int> * m_pIconNames;
        unsigned int m_uCacheTotalSize;
        unsigned int m_uCacheMaxSize;

public:
        QPixmap * getImage(const QString & szId, bool bCanBeNumber = true, QString * pRetPath = 0);

        KviCachedPixmap * getPixmapWithCache(const QString & szName);

        KviCachedPixmap * getPixmapWithCacheScaleOnLoad(const QString & szName, int iMaxWidth, int iMaxHeight);

        QPixmap * getPixmap(const QString & szName)
        {
                KviCachedPixmap * pPix = getPixmapWithCache(szName);
                return pPix ? pPix->pixmap() : 0;
        };

        QPixmap * getBigIcon(const QString & szName);

        QPixmap * getSmallIcon(SmallIcon eIcon) { return eIcon < IconCount ? (m_smallIcons[eIcon] ? m_smallIcons[eIcon] : loadSmallIcon(eIcon)) : 0; };

        QPixmap * getSmallIcon(int iIcon) { return iIcon < IconCount ? (m_smallIcons[iIcon] ? m_smallIcons[iIcon] : loadSmallIcon(iIcon)) : 0; };

        const char * getSmallIconName(SmallIcon eIcon);

        const char * getSmallIconName(int iIcon);

        QString getSmallIconResourceName(SmallIcon eIcon);

        SmallIcon iconName(int iIcon);

        int getSmallIconIdFromName(const QString & szName);

        KviAvatar * getAvatar(const QString & szLocalPath, const QString & szName);

        void urlToCachedFileName(QString & szName);

        void clearCache();

        void reloadImages();

        //void cacheCleanup();
protected:
        void addToCache(const QString & szName, KviCachedPixmap * pPix);

        QPixmap * loadSmallIcon(int iIdx);

        void initQResourceBackend();
public slots:
        void showIconWidget();
protected slots:
        void iconWidgetClosed();
};

class KVIRC_API KviIconWidget : public QWidget
{
        Q_OBJECT
public:
        KviIconWidget();

        KviIconWidget(QWidget * pPar);

        ~KviIconWidget();

protected:
        void init();

        virtual void closeEvent(QCloseEvent * pEvent);
        virtual bool eventFilter(QObject * pObject, QEvent * pEvent);
signals:
        void closed();

        void selected(KviIconManager::SmallIcon eIcon);
};

extern KVIRC_API KviIconManager * g_pIconManager;

#endif //_KVI_ICONMANAGER_H_