KviAction.h

Go to the documentation of this file.

#ifndef _KVI_ACTION_H_
#define _KVI_ACTION_H_
//=============================================================================
//
//   File : KviAction.h
//   Creation date : Sun 21 Nov 2004 03:36:34 by Szymon Stefanek
//
//   This file is part of the KVIrc IRC Client distribution
//   Copyright (C) 2004-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 "KviIconManager.h"

#include <QObject>
#include <QPointer>
#include <QShortcut>

class QShortcut;
class QPixmap;
class QMenu;
class KviCustomToolBar;

#undef None

class KVIRC_API KviActionCategory
{
protected:
        QString m_szName;
        QString m_szVisibleName;
        QString m_szDescription;

public:
        KviActionCategory(const QString & szName, const QString & szVisibleName, const QString & szDescription);

        ~KviActionCategory();

public:
        const QString & name() { return m_szName; };

        const QString & visibleName() { return m_szVisibleName; };

        const QString & description() { return m_szDescription; };
};

class KVIRC_API KviAction : public QObject
{
        friend class KviActionManager;
        Q_OBJECT
public:
        enum InternalFlags
        {
                Enabled = 1,  
                SetupDone = 2 
        };

        enum Flags
        {
                NeedsContext = 1,                                                                 
                NeedsConnection = 2,                                                              
                WindowConsole = 4,                                                                
                WindowChannel = 8,                                                                
                WindowQuery = 16,                                                                 
                WindowDccChat = 32,                                                               
                InternalWindowMask = WindowConsole | WindowChannel | WindowQuery | WindowDccChat, 
                EnableAtLogin = 64,                                                               
                WindowOnlyIfUsersSelected = 128                                                   
        };

        KviAction(
            QObject * pParent,
            const QString & szName,
            const QString & szVisibleName,
            const QString & szDescription,
            KviActionCategory * pCategory = NULL,
            const QString & szBigIconId = QString(),
            const QString & szSmallIconId = QString(),
            unsigned int uFlags = 0,
            const QString & szKeySequence = QString());

        KviAction(
            QObject * pParent,
            const QString & szName,
            const QString & szVisibleName,
            const QString & szDescription,
            KviActionCategory * pCategory = NULL,
            const QString & szBigIconId = QString(),
            KviIconManager::SmallIcon eSmallIcon = KviIconManager::None,
            unsigned int uFlags = 0,
            const QString & szKeySequence = QString());

        virtual ~KviAction();

protected:
        QString m_szName;
        QString m_szVisibleName;
        QString m_szDescription;
        KviActionCategory * m_pCategory;
        QString m_szBigIconId;
        QString m_szSmallIconId; // this is alternative to m_eSmallIcon
        KviIconManager::SmallIcon m_eSmallIcon;
        KviPointerList<QAction> * m_pActionList;
        unsigned short int m_uInternalFlags;
        unsigned int m_uFlags;
        QString m_szKeySequence;
        QPointer<QShortcut> m_pAccel;

public:
        static int validateFlags(int iFlagsToValidate);

        const QString & name() const { return m_szName; };

        virtual const QString & visibleName();

        virtual const QString & description();

        const QString & keySequence() const { return m_szKeySequence; };

        const QString & bigIconId() const { return m_szBigIconId; };

        const QString & smallIconId() const { return m_szSmallIconId; };

        KviActionCategory * category() const { return m_pCategory; };

        bool isEnabled() const { return (m_uInternalFlags & KviAction::Enabled); };

        unsigned int flags() { return m_uFlags; };

        virtual bool isKviUserActionNeverOverrideThis();

        virtual void setEnabled(bool bEnabled);

        QPixmap * smallIcon();

        QPixmap * bigIcon();

        virtual bool addToPopupMenu(QMenu * pMenu);

        virtual QAction * addToCustomToolBar(KviCustomToolBar * pParentToolBar);

        void suicide() { delete this; };
protected:
        bool setupDone() const { return (m_uInternalFlags & KviAction::SetupDone); };

        virtual void setup();

        KviPointerList<QAction> * actionList() { return m_pActionList; };

        void registerAccelerator();

        void unregisterAccelerator();

        void registerAction(QAction * pAction);
public slots:
        virtual void activate();
protected slots:
        virtual void actionDestroyed();

        virtual void reloadImages();

        virtual void activeContextChanged();

        virtual void activeContextStateChanged();

        virtual void activeWindowChanged();

        virtual void activeWindowSelectionStateChanged(bool bSelectedNow);
signals:
        void activated();
};

#endif // _KVI_ACTION_H_