src/Qtx/QtxActionMgr.h

   1 // Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 // File:      QtxActionMgr.h
  24 // Author:    Alexander SOLOVYOV, Sergey TELKOV
  25 //
  26 #ifndef QTXACTIONMGR_H
  27 #define QTXACTIONMGR_H
  28
  29 #include "Qtx.h"
  30
  31 #include <QMap>
  32 #include <QObject>
  33 #include <QPointer>
  34
  35 class QTimer;
  36 class QAction;
  37 class QDomNode;
  38
  39 #ifdef WIN32
  40 #pragma warning( disable:4251 )
  41 #endif
  42
  43
  44 class QTX_EXPORT QtxActionMgr : public QObject
  45 {
  46   Q_OBJECT
  47
  48   class SeparatorAction;
  49
  50 public:
  51   class Reader;
  52   class XMLReader;
  53
  54 protected:
  55   class Creator;
  56
  57 public:
  58   QtxActionMgr( QObject* parent );
  59   virtual ~QtxActionMgr();
  60
  61   virtual int      registerAction( QAction*, const int = -1 );
  62   virtual void     unRegisterAction( const int );
  63
  64   QAction*         action( const int ) const;
  65   int              actionId( const QAction* ) const;
  66   bool             contains( const int ) const;
  67
  68   int              count() const;
  69   bool             isEmpty() const;
  70   QIntList         idList() const;
  71
  72   bool             isUpdatesEnabled() const;
  73   virtual void     setUpdatesEnabled( const bool );
  74
  75   virtual bool     isVisible( const int, const int ) const;
  76   virtual void     setVisible( const int, const int, const bool );
  77
  78   void             update();
  79
  80   virtual bool     isEnabled( const int ) const;
  81   virtual void     setEnabled( const int, const bool );
  82
  83   static QAction*  separator( const bool = false );
  84
  85 protected:
  86   virtual void     internalUpdate();
  87   int              generateId() const;
  88
  89   void             triggerUpdate();
  90   virtual void     updateContent();
  91   virtual void     actionChanged( int );
  92
  93 private slots:
  94   void             onActionChanged();
  95   void             onUpdateContent();
  96
  97 private:
  98   typedef QPointer<QAction>    ActionPtr; //!< Action guarded pointer
  99   typedef QMap<int, ActionPtr> ActionMap; //!< Actions map
 100
 101 private:
 102   bool             myUpdate;     //!< update flag
 103   ActionMap        myActions;    //!< actions map
 104   QTimer*          myUpdTimer;   //!< update timer
 105 };
 106
 107
 108 QTX_EXPORT typedef QMap<QString, QString> ItemAttributes; //!< attributes map
 109
 110 class QTX_EXPORT QtxActionMgr::Creator
 111 {
 112 public:
 113   Creator( QtxActionMgr::Reader* );
 114   virtual ~Creator();
 115
 116   Reader* reader() const;
 117
 118   virtual int    append( const QString&, const bool,
 119                          const ItemAttributes&, const int ) = 0;
 120   virtual void   connect( QAction* ) const;
 121
 122   virtual bool   loadPixmap( const QString&, QPixmap& ) const;
 123
 124 protected:
 125   static int     intValue( const ItemAttributes&, const QString&, const int );
 126   static QString strValue( const ItemAttributes&, const QString&,
 127                            const QString& = QString() );
 128 private:
 129   QtxActionMgr::Reader*  myReader;  //!< actions reader
 130 };
 131
 132 class QTX_EXPORT QtxActionMgr::Reader
 133 {
 134 public:
 135   Reader();
 136   virtual ~Reader();
 137
 138   QStringList    options() const;
 139   QString        option( const QString&, const QString& = QString() ) const;
 140   void           setOption( const QString&, const QString& );
 141
 142   virtual bool   read( const QString&, Creator& ) const = 0;
 143
 144 private:
 145   QMap< QString, QString > myOptions;  //!< options map
 146 };
 147
 148 class QTX_EXPORT QtxActionMgr::XMLReader : public Reader
 149 {
 150 public:
 151   XMLReader( const QString&, const QString&, const QString& );
 152   virtual ~XMLReader();
 153
 154   virtual bool   read( const QString&, Creator& ) const;
 155
 156 protected:
 157   virtual void   read( const QDomNode&, const int, Creator& ) const;
 158   virtual bool   isNodeSimilar( const QDomNode&, const QString& ) const;
 159 };
 160
 161
 162 #endif