ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync * VBox Qt GUI - UIActionPool class declaration.
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync * Copyright (C) 2010-2014 Oracle Corporation
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * available from http://www.virtualbox.org. This file is free software;
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * you can redistribute it and/or modify it under the terms of the GNU
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * General Public License (GPL) as published by the Free Software
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
7b2222e6c060dfe168591f22543d3a80f96112b4vboxsync/* Qt includes: */
7b2222e6c060dfe168591f22543d3a80f96112b4vboxsync/* GUI includes: */
7b2222e6c060dfe168591f22543d3a80f96112b4vboxsync/* Forward declarations: */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Action-pool types. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Action types. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Action indexes. */
1ae2aeb1d8bb1614cf94d8de9a5afed3a2510161vboxsync /* 'Application' menu actions: */
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync#endif /* RT_OS_DARWIN */
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync UIActionIndex_M_Application_S_NetworkAccessManager,
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync#endif /* VBOX_GUI_WITH_NETWORK_MANAGER */
f0821e819e51b95ecaf7b12c742da563b4ddf7e5vboxsync /* 'Window' menu actions: */
1ae2aeb1d8bb1614cf94d8de9a5afed3a2510161vboxsync#endif /* RT_OS_DARWIN */
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync /* 'Help' menu actions: */
1ae2aeb1d8bb1614cf94d8de9a5afed3a2510161vboxsync#endif /* !RT_OS_DARWIN */
36545c63b2aab948161e4a712913a4f2dce17d2fvboxsync /* Maximum index: */
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync/** Restriction levels. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync/** QMenu extension. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Constructor. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Defines whether tool-tip should be shown. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync void setShowToolTip(bool fShowToolTips) { m_fShowToolTip = fShowToolTips; }
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Mac OS X: Returns whether this menu is consumable by the menu-bar. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync bool isConsumable() const { return m_fConsumable; }
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Mac OS X: Defines whether this menu is @a fConsumable by the menu-bar. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync void setConsumable(bool fConsumable) { m_fConsumable = fConsumable; }
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Mac OS X: Returns whether this menu is consumed by the menu-bar. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Mac OS X: Defines whether this menu is @a fConsumed by the menu-bar. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync void setConsumed(bool fConsumed) { m_fConsumed = fConsumed; }
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync#endif /* Q_WS_MAC */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** General event handler. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Holds whether tool-tip should be shown. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Mac OS X: Holds whether this menu can be consumed by the menu-bar. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Mac OS X: Holds whether this menu is consumed by the menu-bar. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync#endif /* Q_WS_MAC */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Abstract QAction extension. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns action type. */
3a1f13012387ed050863b921493a86ce7d6cd4a0vboxsync /** Returns menu contained by this action. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns action-pool this action belongs to. */
4322eab57b88f880a55e6a4ae0cb76b870167f06vboxsync UIActionPool* actionPool() const { return m_pActionPool; }
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Casts action to polymorphic-action. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns current action name. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Defines current action name. */
9027db91ee5567660f982f4fe1cbb25fe32f6c1evboxsync /** Returns action extra-data ID. */
9027db91ee5567660f982f4fe1cbb25fe32f6c1evboxsync /** Returns action extra-data key. */
9027db91ee5567660f982f4fe1cbb25fe32f6c1evboxsync virtual QString extraDataKey() const { return QString(); }
a21d362081e34d2937b7ce524dc2e2f635caeeb0vboxsync /** Returns whether action is allowed. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns extra-data ID to save keyboard shortcut under. */
4322eab57b88f880a55e6a4ae0cb76b870167f06vboxsync virtual QString shortcutExtraDataID() const { return QString(); }
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns default keyboard shortcut for this action. */
4322eab57b88f880a55e6a4ae0cb76b870167f06vboxsync virtual QKeySequence defaultShortcut(UIActionPoolType) const { return QKeySequence(); }
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Defines current keyboard shortcut for this action. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Make action show keyboard shortcut. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Make action hide keyboard shortcut. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Retranslates action. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor. */
4322eab57b88f880a55e6a4ae0cb76b870167f06vboxsync UIAction(UIActionPool *pParent, UIActionType type);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns current action name in menu. */
b213dcb3794ee18b68ffb23498de697dbcbc7f07vboxsync /** Updates action text accordingly. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds the action type. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds the reference to the action-pool this action belongs to. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds the type of the action-pool this action belongs to. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds the action name. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds the action shortcut. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds whether action shortcut hidden. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync/** Abstract UIAction extension for 'Menu' action type. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Constructor, taking normal icon name and name for disabled analog. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync const QString &strIcon = QString(), const QString &strIconDis = QString());
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Constructor, taking copy of existing icon. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Defines whether tool-tip should be shown. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Prepare routine. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Updates action text accordingly. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Abstract UIAction extension for 'Simple' action type. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking normal icon name and name for disabled analog. */
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync const QString &strIcon = QString(), const QString &strIconDisabled = QString());
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking normal, small icon names and names for disabled analogs. */
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync const QString &strIconNormal, const QString &strIconSmall,
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync const QString &strIconNormalDisabled, const QString &strIconSmallDisabled);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking copy of existing icon. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Abstract UIAction extension for 'Toggle' action type. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking normal icon name and name for disabled analog. */
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync const QString &strIcon = QString(), const QString &strIconDisabled = QString());
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking normal on/off icon names and names for disabled analogs. */
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync const QString &strIconOn, const QString &strIconOff,
caf62c8b1a43cb2321f2b9d4e31588e643b89731vboxsync const QString &strIconOnDisabled, const QString &strIconOffDisabled);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking copy of existing icon. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Prepare routine. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync/** Abstract UIAction extension for 'Polymorphic' action type. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Returns current action state. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Defines current action state. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync void setState(int iState) { m_iState = iState; retranslateUi(); }
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking normal icon name and name for disabled analog. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync const QString &strIcon = QString(), const QString &strIconDisabled = QString());
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Constructor, taking normal, small icon names and names for disabled analogs. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync const QString &strIconNormal, const QString &strIconSmall,
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync const QString &strIconNormalDisabled, const QString &strIconSmallDisabled);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor, taking copy of existing icon. */
43ac5db20bd450cb619fb7bc76b4c369cee128c7vboxsync /** Holds current action state. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync/** Abstract QObject extension
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync * representing action-pool interface and factory. */
66c0d2215120f37697a007dedc3e171837935d9fvboxsyncclass UIActionPool : public QIWithRetranslateUI3<QObject>
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Pointer to menu update-handler for this class. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Pointer to menu update-handler for Runtime sub-class. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync typedef void (UIActionPoolRuntime::*PTFActionPoolRuntime)();
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Union for two defines above. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Notifies about menu prepare. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync void sigNotifyAboutMenuPrepare(int iIndex, QMenu *pMenu);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Static factory constructor. */
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync static UIActionPool* create(UIActionPoolType type);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Static factory destructor. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Static factory constructor (temporary),
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync * used to initialize shortcuts-pool from action-pool of passed @a type. */
0190d8632849255f4e53d0010485f6109565513cvboxsync static void createTemporary(UIActionPoolType type);
d22a253d4eb50a2e7341d28d7f7dde3b69b49b0cvboxsync /** Cast action-pool to Runtime one. */
d22a253d4eb50a2e7341d28d7f7dde3b69b49b0cvboxsync /** Cast action-pool to Selector one. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns action-pool type. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns the action for the passed @a iIndex. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync UIAction* action(int iIndex) const { return m_pool.value(iIndex); }
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns all the actions action-pool contains. */
4322eab57b88f880a55e6a4ae0cb76b870167f06vboxsync QList<UIAction*> actions() const { return m_pool.values(); }
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync /** Returns whether the menu with passed @a type is allowed in menu-bar. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync bool isAllowedInMenuBar(UIExtraDataMetaDefs::MenuType type) const;
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync /** Defines menu-bar @a restriction for passed @a level. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync void setRestrictionForMenuBar(UIActionRestrictionLevel level, UIExtraDataMetaDefs::MenuType restriction);
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Returns whether the action with passed @a type is allowed in the 'Application' menu. */
326456b8d1aba5e9371d8ede11afd67ab132f2eavboxsync bool isAllowedInMenuApplication(UIExtraDataMetaDefs::MenuApplicationActionType type) const;
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Defines 'Application' menu @a restriction for passed @a level. */
326456b8d1aba5e9371d8ede11afd67ab132f2eavboxsync void setRestrictionForMenuApplication(UIActionRestrictionLevel level, UIExtraDataMetaDefs::MenuApplicationActionType restriction);
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync /** Mac OS X: Returns whether the action with passed @a type is allowed in the 'Window' menu. */
f0821e819e51b95ecaf7b12c742da563b4ddf7e5vboxsync bool isAllowedInMenuWindow(UIExtraDataMetaDefs::MenuWindowActionType type) const;
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync /** Mac OS X: Defines 'Window' menu @a restriction for passed @a level. */
f0821e819e51b95ecaf7b12c742da563b4ddf7e5vboxsync void setRestrictionForMenuWindow(UIActionRestrictionLevel level, UIExtraDataMetaDefs::MenuWindowActionType restriction);
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync#endif /* Q_WS_MAC */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync /** Returns whether the action with passed @a type is allowed in the 'Help' menu. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync bool isAllowedInMenuHelp(UIExtraDataMetaDefs::MenuHelpActionType type) const;
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync /** Defines 'Help' menu @a restriction for passed @a level. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync void setRestrictionForMenuHelp(UIActionRestrictionLevel level, UIExtraDataMetaDefs::MenuHelpActionType restriction);
d22a253d4eb50a2e7341d28d7f7dde3b69b49b0cvboxsync /** Hot-key processing delegate. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Returns extra-data ID to save keyboard shortcuts under. */
236f71c54929e835b07c91ace8d7009beb6bf4bdvboxsync /** Returns the list of main menus. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Handles menu prepare. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Loads keyboard shortcuts of action-pool into shortcuts-pool. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Constructor of the action-pool of passed @a type. */
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync UIActionPool(UIActionPoolType type, bool fTemporary = false);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Prepare routine. */
236f71c54929e835b07c91ace8d7009beb6bf4bdvboxsync /** Prepare pool routine. */
236f71c54929e835b07c91ace8d7009beb6bf4bdvboxsync /** Prepare connections routine. */
236f71c54929e835b07c91ace8d7009beb6bf4bdvboxsync /** Cleanup connections routine. */
236f71c54929e835b07c91ace8d7009beb6bf4bdvboxsync /** Cleanup pool routine. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Cleanup routine. */
236f71c54929e835b07c91ace8d7009beb6bf4bdvboxsync /** Update configuration routine. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Update menu routine. */
98e2c4b54b8f4f38a9c5a56c7e5d470a6bf8fccbvboxsync /** Update menus routine. */
1ae2aeb1d8bb1614cf94d8de9a5afed3a2510161vboxsync /** Update 'Application' menu routine. */
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync /** Mac OS X: Update 'Window' menu routine. */
1ae2aeb1d8bb1614cf94d8de9a5afed3a2510161vboxsync#endif /* RT_OS_DARWIN */
98e2c4b54b8f4f38a9c5a56c7e5d470a6bf8fccbvboxsync /** Update 'Help' menu routine. */
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync /** Update shortcuts. */
98e2c4b54b8f4f38a9c5a56c7e5d470a6bf8fccbvboxsync /** Translation handler. */
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** General event handler. */
a21d362081e34d2937b7ce524dc2e2f635caeeb0vboxsync /** Adds action into corresponding menu. */
a21d362081e34d2937b7ce524dc2e2f635caeeb0vboxsync bool addAction(UIMenu *pMenu, UIAction *pAction, bool fReallyAdd = true);
a21d362081e34d2937b7ce524dc2e2f635caeeb0vboxsync /** Adds action's menu into corresponding menu list. */
a21d362081e34d2937b7ce524dc2e2f635caeeb0vboxsync bool addMenu(QList<QMenu*> &menuList, UIAction *pAction, bool fReallyAdd = true);
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync /** Holds the action-pool type. */
4429cc47d1e3ca88d6237e5ee7a876dc409cdc24vboxsync /** Holds whether this action-pool is temporary. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Holds the map of actions. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Holds the map of validation handlers. */
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync /** Holds the set of invalidated action indexes. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync /** Holds restricted menu types. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync QMap<UIActionRestrictionLevel, UIExtraDataMetaDefs::MenuType> m_restrictedMenus;
f0821e819e51b95ecaf7b12c742da563b4ddf7e5vboxsync /** Holds restricted action types of the 'Application' menu. */
326456b8d1aba5e9371d8ede11afd67ab132f2eavboxsync QMap<UIActionRestrictionLevel, UIExtraDataMetaDefs::MenuApplicationActionType> m_restrictedActionsMenuApplication;
2e76757ceed513b38c43d0f33cd24cc18baf3ffevboxsync /** Mac OS X: Holds restricted action types of the 'Window' menu. */
f0821e819e51b95ecaf7b12c742da563b4ddf7e5vboxsync QMap<UIActionRestrictionLevel, UIExtraDataMetaDefs::MenuWindowActionType> m_restrictedActionsMenuWindow;
74d2d156cc7889b043a3127ed710ef6d658ca337vboxsync#endif /* Q_WS_MAC */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync /** Holds restricted action types of the Help menu. */
492de26ad701185b6f6cf63eb346b34a4440268dvboxsync QMap<UIActionRestrictionLevel, UIExtraDataMetaDefs::MenuHelpActionType> m_restrictedActionsMenuHelp;
ea45fd67689d7a915b8a1b9f4ab2ba32652cf7b2vboxsync#endif /* !___UIActionPool_h___ */