include/commonWgt/menuWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: menuWidget.h,v $ $Revision: 1.29 $ $State: Exp $
*******************************************************************************/


#ifndef QTMENUWIDGET_H
#define QTMENUWIDGET_H

#include <QtGui/QMenuBar>

#include "commonWgt/commonWgtDefines.h"
#include "commonWgt/popupMenu.h"

#include "ngutil/dtqlist.h"
#include <QtCore/QHash>

class DtFeatureActionManager;


const int DtAfterMenu         = 0x80000000;
const int DtSwapMenu          = 0x40000000;
const int DtReconfigureMenu   = 0x20000000;
const int DtByPosition        = 0x10000000;


class DT_DLL_commonWgt DtGlobalChange
{
public:
   virtual bool operator==(const DtGlobalChange&) const;

public:
   DtMainMenuType          myPos;
   DtMainMenuType          myType;
   DtMainMenuType          myReplace;
   QList<DtMenuItemType>   myKeepOnlyItems;
   DtPopupMenuCreatorFcn   myFcn;
};

class DT_DLL_commonWgt DtPopupCreator
{
public:
   DtPopupCreator(DtPopupMenuCreatorFcn fcn) : myFcn(fcn) {};
   DtPopupCreator(const DtPopupCreator& orig) : myFcn(orig.myFcn) {};

   DtPopupMenuCreatorFcn myFcn;
};

class DT_DLL_commonWgt DtMenuWidget : public QMenuBar
{
   Q_OBJECT

public:
  
   DtMenuWidget(QWidget* parent = NULL);

   virtual ~DtMenuWidget();

   virtual bool init(DtFeatureActionManager*);
   virtual bool createMenuSystem();

   virtual DtMenuItemType typeFromAction(QAction* action);

   virtual DtPopupMenu* menuFromAction(QAction*);

   virtual QAction* menuItemForType(DtMenuItemType iType);

   virtual DtPopupMenu* menuForType(DtMainMenuType iType);

   virtual DtPopupMenu* menuThatHasMenuType(DtMenuItemType iType);

   virtual DtPopupMenu* menuThatHasActionGroupType(DtMenuItemType iType);

   virtual DtPopupMenu* createMenuOfType(DtMainMenuType iType, QWidget* owner);

   virtual DtPopupMenu* initializeMenuOfType(DtMainMenuType iType, QWidget* owner);

   virtual bool createMenu(DtPopupMenu* newMenu);

   virtual void updateMenuItems();

   virtual DtPopupMenu* menuWithName(const QString&);

   virtual DtMenuItemType uniqueId() const;

   virtual DtMainMenuType uniqueMenuId() const;

   virtual DtMainMenuType insertItem(DtPopupMenu* menu, int index = -1);

   virtual QAction* addMenuItem(const QString& featureName, const QString& item, 
      const QString& addToMenu, DtMenuItemType& retId,
      bool toggle = false, QObject* actionReceiver = NULL, 
      const char* action = NULL, QObject* validationReceiver = NULL,
      const char* validation = NULL, const QString& tooltip = QString::null, 
      const QString& accelerator = QString::null, bool addSep = false);

   virtual void appendMenuValidator(const QString& menuName, const QString& itemName,
      QObject* validatorReceiver, char* validator);

   virtual bool removeMenuItem(const QString& item);

   virtual bool removeMenuGroup(const QString& group);

   virtual void recreateMenu(DtMainMenuType menu, bool useBaseMenuIfExists = true);

   DtFeatureActionManager* featureActionManager() const;
   void setFeatureActionManager(DtFeatureActionManager*);

   virtual DtPopupMenu* menuAt(int iPos);

   virtual QString menuTextForAction(QAction*);

public:
   virtual int insertPopupMenu(DtMainMenuType iType, DtPopupMenuCreatorFcn fcn, DtMainMenuType iPos = DtNoMenu);

   virtual int replacePopupMenu(DtMainMenuType iType, DtPopupMenuCreatorFcn with);

   virtual bool removePopupMenu(DtMainMenuType iType, bool permenant = true);

   virtual DtPopupMenu* restoreMenu(DtMainMenuType type);

   virtual void removeMenuAtPosition(int iPos, bool freeMemory = false);

   virtual QHash<DtMainMenuType, DtPopupMenu*>& popupMenus();

   virtual void swapMenus(DtMainMenuType iA, DtMainMenuType iB);

public:

   static void globalInsertPopupMenu(DtMainMenuType iType, DtPopupMenuCreatorFcn fcn, DtMainMenuType iAfterType = DtNoMenu);

   static void globalReplacePopupMenu(DtMainMenuType iType, DtPopupMenuCreatorFcn with);

   static void globalRemovePopupMenu(DtMainMenuType iType);

   static void globalSwapMenuPositions(DtMainMenuType iA, DtMainMenuType iB);

   static void globalCreateOnlyItemsForMenu(DtMainMenuType iType, QList<DtMenuItemType> menuItems);

public:
   static DtMenuWidget* create(QWidget* parent = NULL);

protected:
   virtual void modifyLocalMenuWithGlobalChanges();

   virtual DtPopupMenu* createMenu(DtPopupMenuCreatorFcn fcn, DtMainMenuType iType, int iPos = -1, bool initializeOnly = false,
      DtPopupMenu* menuBase = NULL);

   virtual int positionOfCreator(DtPopupMenuCreatorFcn fcn);
   virtual int positionOfCreator(DtMainMenuType iType);

   virtual DtMainMenuType typeForCreator(DtPopupMenuCreatorFcn fcn);

   virtual void removeOrderedCreator(int iPos);

   virtual void insertOrderedCreator(DtPopupMenuCreatorFcn, int iPos);

signals:

   void validate();

   void menuRecreated(DtMainMenuType);

public slots:
   virtual void validateMenuItems();

protected:
   QList<DtPopupMenuCreatorFcn> myOrderedCreators;
   QHash<DtMainMenuType, DtPopupCreator> myPopupMenuCreators;
   QHash<DtMainMenuType, DtPopupMenu*> myPopupMenus;
   bool myCreated;
   QWidget* myOwner;
   bool myGloballyModified;
   DtFeatureActionManager* myFeatureActionManager;
   static QList<DtGlobalChange> myGlobalPopups;
};

inline DtFeatureActionManager* DtMenuWidget::featureActionManager() const
{
   return myFeatureActionManager;
}

inline void DtMenuWidget::setFeatureActionManager(DtFeatureActionManager* m)
{
   myFeatureActionManager = m;
}

#endif