src/ModuleBase/ModuleBase_WidgetExprEditor.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetExprEditor.h
   5  *
   6  *  Created on: Oct 8, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef MODULEBASE_WIDGETEXPREDITOR_H_
  11 #define MODULEBASE_WIDGETEXPREDITOR_H_
  12
  13 #include <ModuleBase.h>
  14 #include <ModuleBase_ModelWidget.h>
  15
  16 #include <QList>
  17 #include <QLabel>
  18 #include <QString>
  19 #include <QStringList>
  20 #include <QPlainTextEdit>
  21
  22 class QWidget;
  23 class QStringListModel;
  24 class QCompleter;
  25
  26 /**
  27 * \ingroup GUI
  28 * A multi-line text editor which lets to input formula and provides a list of completion strings
  29 */
  30 class ExpressionEditor: public QPlainTextEdit
  31 {
  32   Q_OBJECT
  33  public:
  34    /// Constructor
  35    /// \param theParent a parent widget
  36   explicit ExpressionEditor(QWidget* theParent = 0);
  37   virtual ~ExpressionEditor();
  38
  39   /// Set list of completion strings
  40   void setCompletionList(QStringList&);
  41
  42   /// Set a text which will be shown when the listr is empty
  43   void setPlaceHolderText( const QString& );
  44
  45   /// Returns placeholder list
  46   QString placeHolderText() const;
  47
  48   // Returns true if the current value is modified by has not been applyed yet
  49   bool isModified() const;
  50
  51   // Clears modified state
  52   void clearModified();
  53
  54  public slots:
  55   /// Insert additional string for completion
  56   /// \param theCompletion a string to insert
  57   /// \param isSingleWord a flag shows that inserted string is single word or not
  58   void insertCompletion(const QString& theCompletion, bool isSingleWord = false);
  59
  60   /// Perform completion
  61   void performCompletion();
  62
  63   /// A slot for processing text changed event
  64   void onTextChanged();
  65
  66 signals:
  67   void valueModified();
  68   /// A signal that is emitted by the "Tab" key event. It is emitted before the key is processed.
  69   //void valueStored();
  70   //void focusNextPrev();
  71
  72   /// The signal about key release on the control, that corresponds to the attribute
  73   /// \param theEvent key release event
  74   void keyReleased(QKeyEvent* theEvent);
  75
  76  protected:
  77   /// Perform completion by prefix
  78   /// \param theCompletionPrefix a prefix for looking for completion
  79   void performCompletion(const QString& theCompletionPrefix);
  80
  81   /// Redefinition of virtual method
  82   /// \param theEvent a key press event
  83   virtual void keyPressEvent(QKeyEvent* theEvent);
  84
  85   /// Key events processing
  86   /// theEvent a key event
  87   bool handledCompletedAndSelected(QKeyEvent* theEvent);
  88
  89   /// Redefinition of virtual method
  90   virtual void paintEvent( QPaintEvent* );
  91
  92   /// The parent method that processes the "Tab"/"SHIF + Tab" keyboard events
  93   /// Emits a signal about focus change
  94   /// If theIsNext is true, this function searches forward, if next is false, it searches backward.
  95   virtual bool focusNextPrevChild(bool theIsNext);
  96
  97  private:
  98   QStringListModel* myCompleterModel;
  99   QCompleter* myCompleter;
 100   bool myCompletedAndSelected;
 101   QString myPlaceHolderText;
 102
 103   /// Boolean value whether the spin box content is modified
 104   bool myIsModified;
 105 };
 106
 107 /**
 108 * \ingroup GUI
 109 * A Widget which provides an input of an expression
 110 */
 111 class MODULEBASE_EXPORT ModuleBase_WidgetExprEditor : public ModuleBase_ModelWidget
 112 {
 113   Q_OBJECT
 114  public:
 115   /// Constructor
 116   /// \param theParent the parent object
 117   /// \param theData the widget configuration.
 118   /// \param theParentId is Id of a parent of the current attribute
 119   /// \param thePlaceHolder a placeholder string
 120   ModuleBase_WidgetExprEditor( QWidget* theParent,
 121                                const Config_WidgetAPI* theData,
 122                                const std::string& theParentId,
 123                                const std::string& thePlaceHolder );
 124   virtual ~ModuleBase_WidgetExprEditor();
 125
 126   /// Redefinition of virtual method
 127   virtual QList<QWidget*> getControls() const;
 128
 129   /// Returns true if the event is processed.
 130   virtual bool processEnter();
 131
 132 protected slots:
 133   /// A slot for processing text changed event
 134   void onTextChanged();
 135
 136 protected:
 137   /// Do not initialize value on the widget activation
 138   virtual void initializeValueByActivate();
 139
 140   /// Saves the internal parameters to the given feature
 141   /// \return True in success
 142   virtual bool storeValueCustom() const;
 143
 144   /// Redefinition of virtual method
 145   virtual bool restoreValueCustom();
 146
 147 private:
 148    /// A line edit control
 149   QLabel* myResultLabel;
 150   ExpressionEditor* myEditor;
 151 };
 152
 153 #endif /* MODULEBASE_WIDGETEXPREDITOR_H_ */