include/commonWgt/featureActionManager.h

Go to the documentation of this file.

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


/* This class will allow a developer to add shortcuts or icons tied to a particular
** feature type that can be looked up when creating a menu item.  This class will
** also be used in determing which items can/cannot be used when creating a user
** definable toolbar
*/

#ifndef DTFEATUREACTIONMANAGER_H_
#define DTFEATUREACTIONMANAGER_H_

#include "commonWgt/commonWgtDefines.h"
#include "archiver/archivableObject.h"
#include <QtCore/QString>
#include <QtCore/QHash>
#include <QtGui/QIcon>
#include <QtCore/QVector>

#define DtKeepIcon "DtKeepIcon"
#define DtAssignIconByFeatureName "DtAssignIconByFeatureName"

class QAction;
class DtToolbarCallbackStructure;
class QToolBar;

typedef QWidget* (*DtToolbarWidgetCreatorFcn)(QWidget* parent, QToolBar* bar, const DtToolbarCallbackStructure&);

class DT_DLL_commonWgt DtToolbarCallbackStructure
{
public:
   DtToolbarCallbackStructure();
   DtToolbarCallbackStructure(const DtToolbarCallbackStructure&);
   DtToolbarCallbackStructure& operator=(const DtToolbarCallbackStructure&);
   
   DtToolbarWidgetCreatorFcn myCreator;
   QVector<void*> myUserParameters;
};


class DT_DLL_commonWgt DtFeatureAction
{
public:
   DtFeatureAction();
   virtual ~DtFeatureAction();
   DtFeatureAction(const DtFeatureAction&);
   DtFeatureAction& operator=(const DtFeatureAction&);

   void clearQAction();

   QString  myFeatureName;
   QString  myShortcut;
   QString  myNormalIcon;
   QString  myDisabledIcon;
   QString  myNormalOnIcon;
   QString  myToolTip;
   QString  myDisplayName;
   bool     myIsOverride;
   bool     myCanBePlacedOnToolbar;
   QAction  *myAction;
   int*     myActionRef;
   DtToolbarCallbackStructure myCreator;
};

class DT_DLL_commonWgt DtFeatureActionManager : public DtArchivableObject
{
   Q_OBJECT

public:
   DtFeatureActionManager(const QString& name = "featureActionManager");
   DtFeatureActionManager(const DtFeatureActionManager&);
   virtual ~DtFeatureActionManager();

   virtual bool init();
   virtual void addFeatureAction(const DtFeatureAction&, bool replaceShortcutInAction = true);

   virtual DtFeatureActionManager& operator=(const DtFeatureActionManager&);

   virtual void replaceShortcut(const QString& feature, const QString& shortcut, bool replaceInAction = true);

   virtual void removeFeatureAction(const QString& featureName);
   virtual void addFeatureAction(const QString& feature,
      const QString& shortcut = QString::null, const QString& normalIcon = DtAssignIconByFeatureName,
      const QString& disabledIcon = DtKeepIcon, const QString& normalOnIcon = DtKeepIcon);

   virtual void addFeatureAction(const QString& feature, QObject* slotObj, const char* slot, const QString& displayName,
      bool isToggle = false, const QString& toolTip = QString::null, const QString& normalIcon = DtAssignIconByFeatureName,
      const QString& disabledIcon = DtKeepIcon, const QString& normalOnIcon = DtKeepIcon);

   virtual void addFeatureAction(const QString& feature, const QString& displayName, const DtToolbarCallbackStructure& str);

   virtual bool shortcutInUse(const QString&) const;

   virtual bool hasShortcutOverride(const QString&) const;

   virtual bool hasShortcut(const QString&) const;

   virtual QString shortcutFor(const QString&) const;

   virtual QString iconFor(const QString& feature, QIcon::Mode mode = QIcon::Normal, QIcon::State = QIcon::Off,
      bool useDefault = false) const;

   virtual void setCanBePlacedOnToolbar(const QString& feature, bool);
   virtual bool canBePlacedOnToolbar(const QString& feature) const;

   virtual QString featureUsingShortcut(const QString& shortcut) const;

   static DtFeatureActionManager* create();

   virtual bool shortcutIsUsed(const QString& shortcut);

   virtual void registerAction(const QString& featureName, QAction* act);

   virtual DtFeatureAction featureFor(const QString& feature) const;

   const QHash<QString, DtFeatureAction>& featureActions() const;

   virtual void removeFeatureAction(QAction*);

   virtual void clearQActions();

   virtual DtFeatureActionManager* clone();

   virtual void merge(const DtFeatureActionManager&);

signals:
   void replacedShortcut(const QString&, const QString&, const QString&);

protected:

   virtual void write(QTextStream&);
   virtual void read(QTextStream&);

   virtual QString defaultIcon(const QString& featureName, const QString& iconName) const;

protected:
   QHash<QString, DtFeatureAction>  myFeatureActions;
   QHash<QString, QString>          myShortcutToFeature;
};

inline const QHash<QString, DtFeatureAction>& DtFeatureActionManager::featureActions() const
{
   return myFeatureActions;
}

#endif