Minor code correction

[modules/shaper.git] / src / ModuleBase / ModuleBase_IPropertyPanel.h

diff --git a/src/ModuleBase/ModuleBase_IPropertyPanel.h b/src/ModuleBase/ModuleBase_IPropertyPanel.h
index 3a18c858b3b0c7d5031ca2daf8cacd9bcb080844..e2b1010ac167448905bd116c3c781c33b6ba9a70 100644 (file)
--- a/src/ModuleBase/ModuleBase_IPropertyPanel.h
+++ b/src/ModuleBase/ModuleBase_IPropertyPanel.h
@@ -1,11 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_IPropertyPanel.h
- *
- *  Created on: Oct 01, 2014
- *      Author: vsv
- */
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// 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<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef ModuleBase_PROPERTYPANEL_H_
 #define ModuleBase_PROPERTYPANEL_H_
@@ -27,7 +38,10 @@ Q_OBJECT
 public:
   /// Constructor
   /// \param theParent is a parent of the property panel
-  ModuleBase_IPropertyPanel(QWidget* theParent) : QDockWidget(theParent), myIsEditing(false) {}
+  ModuleBase_IPropertyPanel(QWidget* theParent);
+
+  /// Returns header widget
+  virtual QWidget* headerWidget() const = 0;
 
   /// Returns currently active widget
   virtual ModuleBase_ModelWidget* activeWidget() const = 0;
@@ -35,6 +49,10 @@ public:
   /// Returns all property panel's widget created by WidgetFactory
   virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const = 0;
 
+  /// Returns widget, that has the given attribute index
+  /// \param theAttributeId an attribute from XML
+  virtual ModuleBase_ModelWidget* modelWidget(const std::string& theAttributeId) const;
+
   /// Removes all widgets in the widget area of the property panel
   virtual void cleanContent() = 0;
 
@@ -45,6 +63,9 @@ public:
   /// \return State of editing mode flag
   bool isEditingMode() const { return myIsEditing; }
 
+  /// Set focus on the Ok button
+  virtual void setFocusOnOkButton() = 0;
+
   /// Set Enable/Disable state of Cancel button
   /// \param theEnabled Enable/Disable state of Cancel button
   virtual void setCancelEnabled(bool theEnabled) = 0;
@@ -52,10 +73,26 @@ public:
   /// \return Enable/Disable state of Cancel button
   virtual bool isCancelEnabled() const = 0;
 
+  /// Returns widget processed by preselection
+  virtual ModuleBase_ModelWidget* preselectionWidget() const = 0;
+
+  /// Sets widget processed by preselection
+  virtual void setPreselectionWidget(ModuleBase_ModelWidget* theWidget) = 0;
+
+  /// Returns the first widget, where canAcceptFocus returns true
+  /// \return a widget or null
+  ModuleBase_ModelWidget* findFirstAcceptingValueWidget();
+
+  /// Returns the first widget, where canAcceptFocus returns true
+  /// \return a widget or null
+  static ModuleBase_ModelWidget* findFirstAcceptingValueWidget(
+                          const QList<ModuleBase_ModelWidget*>& theWidgets);
+
 signals:
   /// The signal about key release on the control, that corresponds to the attribute
+  /// \param theObject a sender of the event
   /// \param theEvent key release event
-  void keyReleased(QKeyEvent* theEvent);
+  void keyReleased(QObject* theObject, QKeyEvent* theEvent);
 
   /// The signal about the widget activation
   /// \param theWidget the activated widget
@@ -66,7 +103,8 @@ signals:
   void widgetActivated(ModuleBase_ModelWidget* theWidget);
 
   /// Emited when there is no next widget
-  void noMoreWidgets();
+  /// \param thePreviousAttributeID an attribute key of the previous active widget
+  void noMoreWidgets(const std::string& thePreviousAttributeID);
 
 public slots:
   /// Activate the next widget in the property panel
@@ -81,8 +119,10 @@ public slots:
   * highlighting from the previous active widget
   * emits widgetActivated(theWidget) signal
   * \param theWidget which has to be activated
+  * \param theEmitSignal a flag to prohibit signal emit
   */
-  virtual void activateWidget(ModuleBase_ModelWidget* theWidget) = 0;
+  virtual void activateWidget(ModuleBase_ModelWidget* theWidget,
+                              const bool theEmitSignal = true) = 0;
 
 protected: