include/commonWgt/toolbarFactoryManager.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: toolbarFactoryManager.h,v $ $Revision: 1.6 $ $State: Exp $
*********************************************************************/


/* This class will allow a developer to add toolbars that can be created
*  based on features found in the supplied DtFeatureActionManager
*/

#ifndef DTTOOLBARFACTOYMANAGER_H_
#define DTTOOLBARFACTOYMANAGER_H_

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

class QAction;
class QToolBar;
class QWidget;
class DtFeatureActionManager;
class QTextStream;
class QContextMenuEvent;

static const char* DtKeepTooltip = "___DtKeepTooltip___";
static const char* DtToolbarSeparator            = "ToolbarSeparator";

class DT_DLL_commonWgt DtToolbarItem : public DtArchivableObject
{
public:
   DtToolbarItem();
   DtToolbarItem(const DtToolbarItem&);

   DtToolbarItem& operator=(const DtToolbarItem&);
   bool operator==(const DtToolbarItem&) const;
   bool operator!=(const DtToolbarItem& rhs) const { return !(*this == rhs); };

   QString           myFeatureName;
   QString           myToolTip;
   QVector<QString>  myChildren;
};

class DT_DLL_commonWgt DtFeatureToolbar : public DtArchivableObject
{
   Q_OBJECT

public:
   DtFeatureToolbar();
   DtFeatureToolbar(const DtFeatureToolbar&);

   DtFeatureToolbar& operator=(const DtFeatureToolbar&);

   bool operator==(const DtFeatureToolbar&) const;
   bool operator!=(const DtFeatureToolbar& rhs) const { return !(*this == rhs); };

   static DtArchivableObject* create();

   DECLARE_ARCHIVABLE_CREATOR()

protected slots:
   virtual void toolbarDestroyed();

public:
   QString                       myToolbarName;
   QString                       myToolbarTitle;
   QString                       myToolTip;
   QVector<DtToolbarItem>        myToolbarItems;
   bool                          myIsEditable;
   QToolBar*                     myCreatedToolbar;
};


class DT_DLL_commonWgt DtToolbarFactoryManager : public DtArchivableObject
{
   Q_OBJECT

public:
   DtToolbarFactoryManager(const QString& name = "toolbarFactoryManager");
   DtToolbarFactoryManager(const DtToolbarFactoryManager&);

   virtual ~DtToolbarFactoryManager();

   virtual bool init(DtFeatureActionManager*);

   static DtToolbarFactoryManager* create();

   void setUserToolbarSystemEnabled(bool);
   bool userToolbarSystemEnabled() const;

   DtToolbarFactoryManager& operator=(const DtToolbarFactoryManager&);

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

   virtual void clear();

public:
   
   virtual void addToolbar(const QString& toolbar, const QString& windowTitle, const QString& toolTip = DtKeepTooltip,
      bool editable = false);
   virtual void addToolbar(const DtFeatureToolbar&);

   virtual void addToolbarButton(const QString& toolbar, const QString& feature);

   virtual void addToolbarButtons(const QString& toolbar, const QVector<QString>& features);

   virtual void addToolbarMenu(const QString& toolbar, const QString& feature, const QVector<QString>& features,
      const QString& toolTip = DtKeepTooltip);
   virtual void addToolbarMenuItem(const QString& toolbar, const QString& feature, const QString& itemToAdd,
      const QString& before = QString::null);
   virtual void removeToolbarMenuItem(const QString& toolbar, const QString& feature, const QString& item);

   virtual void setToolbarIsEditable(const QString& toolbar, bool);

   virtual void removeToolbar(const QString& toolbar);

   virtual void removeToolbarButton(const QString& toolbar, const QString& feature);
   virtual void removeToolbarButton(const QString& toolbar, int iIndex);
   virtual void removeToolbarButtons(const QString& toolbar, const QVector<QString>& features);

   virtual void removeAllToolbarButtons(const QString& toolbar);

   virtual void addFeatureToToolbar(const DtToolbarItem& feature, QToolBar* tool, QWidget* parent);

   virtual DtFeatureToolbar toolbarFor(const QString& toolbar) const;

   virtual QToolBar* createToolBar(const QString& toolbar, QWidget* parent = NULL);

   virtual QVector<QToolBar*> createUserCreatedToolbars(QWidget* parent);

   virtual QString keyForToolBar(QToolBar*) const;

   virtual void setChecked(const QString& feature, bool checked);

   virtual bool toolbarExists(const QString& toolbar) const;

   virtual bool hasToolbarNamed(const QString& name) const;

   virtual QString keyForToolBar(const QString& name) const;

   virtual QString uniqueToolbarId() const;

   virtual void merge(const DtToolbarFactoryManager&, bool removeMissingToolbars = true);

   const QHash<QString, DtFeatureToolbar>& featureToolbars() const;

   virtual void merge(const QString& toolbar, const DtFeatureToolbar&);

   virtual DtToolbarFactoryManager* clone();

signals:
   void contextMenuEvent(QWidget*, QContextMenuEvent*);

protected:
   virtual int indexOfFeature(const QString& toolbar, const QString& feature) const;

   virtual bool eventFilter(QObject*, QEvent*);

protected:
   QHash<QString, DtFeatureToolbar> myFeatureToolbars;
   DtFeatureActionManager*          myFeatureActionManager;
   bool                             myUserToolbarSystemEnabled;
   QVector<QString>                 myToolbarsRemoved;
};

inline const QHash<QString, DtFeatureToolbar>& DtToolbarFactoryManager::featureToolbars() const
{
   return myFeatureToolbars;
}

inline void DtToolbarFactoryManager::setUserToolbarSystemEnabled(bool b)
{
   myUserToolbarSystemEnabled = b;
}

inline bool DtToolbarFactoryManager::userToolbarSystemEnabled() const
{
   return myUserToolbarSystemEnabled;
}

#endif