source: vbox/trunk/src/VBox/Frontends/VirtualBox/src/globals/UIActionPool.h@ 42533

/** @file
 *
 * VBox frontends: Qt GUI ("VirtualBox"):
 * UIActionPool class declaration
 */

/*
 * Copyright (C) 2010-2012 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#ifndef __UIActionPool_h__
#define __UIActionPool_h__

/* Global includes: */
#include <QAction>
#include <QMenu>

/* Local includes: */
#include "QIWithRetranslateUI.h"

/* Action types: */
enum UIActionType
{
    UIActionType_Simple,
    UIActionType_State,
    UIActionType_Toggle,
    UIActionType_Menu
};

/* Action keys: */
enum UIActionIndex
{
    /* Various dialog actions: */
    UIActionIndex_Simple_LogDialog,

    /* 'Help' menu actions: */
    UIActionIndex_Menu_Help,
    UIActionIndex_Simple_Contents,
    UIActionIndex_Simple_WebSite,
    UIActionIndex_Simple_ResetWarnings,
    UIActionIndex_Simple_NetworkAccessManager,
    UIActionIndex_Simple_CheckForUpdates,
    UIActionIndex_Simple_About,

    /* Maximum index: */
    UIActionIndex_Max
};

/* Basic abstract QAction reimplemetation, extending interface: */
class UIAction : public QIWithRetranslateUI3<QAction>
{
    Q_OBJECT;

public:

    UIActionType type() const { return m_type; }
    virtual void setState(int /* iState */) {}
    virtual void updateAppearance() {}

    void showShortcut();
    void hideShortcut();

protected:

    UIAction(QObject *pParent, UIActionType type);

    QString menuText(const QString &strText);

private:

    UIActionType m_type;
    QKeySequence m_shortcut;
};

/* Basic QMenu reimplemetation, extending interface: */
class UIMenu : public QMenu
{
    Q_OBJECT;

public:

    UIMenu();

    void setShowToolTips(bool fShowToolTips) { m_fShowToolTips = fShowToolTips; }
    bool isToolTipsShown() const { return m_fShowToolTips; }

private:

    bool event(QEvent *pEvent);

    bool m_fShowToolTips;
};

/* Abstract extention for UIAction, describing 'simple' action type: */
class UIActionSimple : public UIAction
{
    Q_OBJECT;

protected:

    UIActionSimple(QObject *pParent,
                   const QString &strIcon = QString(), const QString &strIconDis = QString());
    UIActionSimple(QObject *pParent,
                   const QSize &normalSize, const QSize &smallSize,
                   const QString &strNormalIcon, const QString &strSmallIcon,
                   const QString &strNormalIconDis = QString(), const QString &strSmallIconDis = QString());
    UIActionSimple(QObject *pParent, const QIcon& icon);
};

/* Abstract extention for UIAction, describing 'state' action type: */
class UIActionState : public UIAction
{
    Q_OBJECT;

protected:

    UIActionState(QObject *pParent,
                  const QString &strIcon = QString(), const QString &strIconDis = QString());
    UIActionState(QObject *pParent,
                  const QSize &normalSize, const QSize &smallSize,
                  const QString &strNormalIcon, const QString &strSmallIcon,
                  const QString &strNormalIconDis = QString(), const QString &strSmallIconDis = QString());
    UIActionState(QObject *pParent, const QIcon& icon);
    void setState(int iState) { m_iState = iState; retranslateUi(); }

    int m_iState;
};

/* Abstract extention for UIAction, describing 'toggle' action type: */
class UIActionToggle : public UIAction
{
    Q_OBJECT;

protected:

    UIActionToggle(QObject *pParent, const QString &strIcon = QString(), const QString &strIconDis = QString());
    UIActionToggle(QObject *pParent,
                   const QSize &normalSize, const QSize &smallSize,
                   const QString &strNormalIcon, const QString &strSmallIcon,
                   const QString &strNormalIconDis = QString(), const QString &strSmallIconDis = QString());
    UIActionToggle(QObject *pParent, const QString &strIconOn, const QString &strIconOff, const QString &strIconOnDis, const QString &strIconOffDis);
    UIActionToggle(QObject *pParent, const QIcon &icon);
    void updateAppearance() { sltUpdateAppearance(); }

private slots:

    void sltUpdateAppearance();

private:

    void init();
};

/* Abstract extention for UIAction, describing 'menu' action type: */
class UIActionMenu : public UIAction
{
    Q_OBJECT;

protected:

    UIActionMenu(QObject *pParent, const QString &strIcon = QString(), const QString &strIconDis = QString());
    UIActionMenu(QObject *pParent, const QIcon &icon);
};

/* Action pool types: */
enum UIActionPoolType
{
    UIActionPoolType_Selector,
    UIActionPoolType_Runtime
};

/* Singleton action pool: */
class UIActionPool : public QObject
{
    Q_OBJECT;

public:

    /* Singleton methods: */
    static UIActionPool* instance();

    /* Constructor/destructor: */
    UIActionPool(UIActionPoolType type);
    ~UIActionPool();

    /* Prepare/cleanup: */
    void prepare();
    void cleanup();

    /* Return corresponding action: */
    UIAction* action(int iIndex) const { return m_pool[iIndex]; }

    /* Helping stuff: */
    void recreateMenus() { createMenus(); }
    bool processHotKey(const QKeySequence &key);

    /* Action pool type: */
    UIActionPoolType type() const { return m_type; }

protected:

    /* Virtual helping stuff: */
    virtual void createActions();
    virtual void createMenus();
    virtual void destroyPool();

    /* Event handler: */
    bool event(QEvent *pEvent);

    /* Instance: */
    static UIActionPool *m_pInstance;

    /* Action pool type: */
    UIActionPoolType m_type;

    /* Actions pool itself: */
    QMap<int, UIAction*> m_pool;
};

#define gActionPool UIActionPool::instance()

#endif /* __UIActionPool_h__ */