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 editingFinished();
  68   void valueModified();
  69   /// A signal that is emitted by the "Tab" key event. It is emitted before the key is processed.
  70   void valueStored();
  71   void focusNextPrev();
  72
  73  protected:
  74   /// Perform completion by prefix
  75   /// \param theCompletionPrefix a prefix for looking for completion
  76   void performCompletion(const QString& theCompletionPrefix);
  77
  78   /// Redefinition of virtual method
  79   /// \param theEvent a key press event
  80   virtual void keyPressEvent(QKeyEvent* theEvent);
  81
  82   /// Key events processing
  83   /// theEvent a key event
  84   bool handledCompletedAndSelected(QKeyEvent* theEvent);
  85
  86   /// Redefinition of virtual method
  87   virtual void paintEvent( QPaintEvent* );
  88
  89   /// The parent method that processes the "Tab"/"SHIF + Tab" keyboard events
  90   /// Emits a signal about focus change
  91   /// If theIsNext is true, this function searches forward, if next is false, it searches backward.
  92   virtual bool focusNextPrevChild(bool theIsNext);
  93
  94  private:
  95   QStringListModel* myCompleterModel;
  96   QCompleter* myCompleter;
  97   bool myCompletedAndSelected;
  98   QString myPlaceHolderText;
  99
 100   /// Boolean value whether the spin box content is modified
 101   bool myIsModified;
 102 };
 103
 104 /**
 105 * \ingroup GUI
 106 * A Widget which provides an input of an expression
 107 */
 108 class MODULEBASE_EXPORT ModuleBase_WidgetExprEditor : public ModuleBase_ModelWidget
 109 {
 110   Q_OBJECT
 111  public:
 112   /// Constructor
 113   /// \param theParent the parent object
 114   /// \param theData the widget configuration.
 115   /// \param theParentId is Id of a parent of the current attribute
 116   /// \param thePlaceHolder a placeholder string
 117   ModuleBase_WidgetExprEditor( QWidget* theParent,
 118                                const Config_WidgetAPI* theData,
 119                                const std::string& theParentId,
 120                                const std::string& thePlaceHolder );
 121   virtual ~ModuleBase_WidgetExprEditor();
 122
 123   /// Redefinition of virtual method
 124   virtual QList<QWidget*> getControls() const;
 125
 126   /// Returns true if the event is processed.
 127   virtual bool processEnter();
 128
 129 protected slots:
 130   /// A slot for processing text changed event
 131   void onTextChanged();
 132
 133 protected:
 134   /// Saves the internal parameters to the given feature
 135   /// \return True in success
 136   virtual bool storeValueCustom() const;
 137
 138   /// Redefinition of virtual method
 139   virtual bool restoreValueCustom();
 140
 141 private:
 142    /// A line edit control
 143   QLabel* myResultLabel;
 144   ExpressionEditor* myEditor;
 145 };
 146
 147 #endif /* MODULEBASE_WIDGETEXPREDITOR_H_ */