Salome HOME
updated copyright message
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetLineEdit.h
index 09d02fae3dda726b77069c7d06698577806b09a3..69148e19cb70e18791d7b515b95fa876996a25e1 100644 (file)
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_WidgetLineEdit.h
- *
- *  Created on: Oct 8, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef MODULEBASE_WIDGETLINEEDIT_H_
 #define MODULEBASE_WIDGETLINEEDIT_H_
 class QWidget;
 class QLineEdit;
 
+/**
+* \ingroup GUI
+* Implementation of model widget for line edit widget.
+* It can be defined with "stringvalue" keyword.
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetLineEdit : public ModuleBase_ModelWidget
 {
   Q_OBJECT
  public:
-  ModuleBase_WidgetLineEdit(QWidget* theParent,
-                                const Config_WidgetAPI* theData,
-                                const std::string& theParentId);
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theData the widget configuration.
+  /// \param thePlaceHolder a string of placeholder
+  ModuleBase_WidgetLineEdit( QWidget* theParent,
+                             const Config_WidgetAPI* theData,
+                             const std::string& thePlaceHolder );
   virtual ~ModuleBase_WidgetLineEdit();
 
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
+  /// Redefinition of virtual method
+  virtual QList<QWidget*> getControls() const;
 
-  virtual bool restoreValue();
+  /// Returns True if data of its feature was modified during operation
+  virtual bool isModified() const;
 
-  /// Returns the internal parent wiget control, that can be shown anywhere
-  /// \returns the widget
-  QWidget* getControl() const;
+protected:
+  /// Returns true if the event is processed.
+  virtual bool processEnter();
 
-  /// Returns list of widget controls
-  /// \return a control list
-  virtual QList<QWidget*> getControls() const;
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom();
 
- public slots:
-  void onTextChanged();
+  /// Redefinition of virtual method
+  virtual bool restoreValueCustom();
 
- private:
+   /// A line edit control
   QLineEdit* myLineEdit;
-  QWidget* myMainWidget;
 };
 
 #endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */