Salome HOME
Activation objects redesign.
[modules/shaper.git] / src / XGUI / XGUI_PropertyPanel.h
index a40ff085b2ca961b14718c56c870afba7a61adef..d2b5b4966aa75ccc1ba7d35a5a52a4cb148fd661 100644 (file)
@@ -1,11 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-/*
- * XGUI_PropertyPanel.h
- *
- *  Created on: Apr 29, 2014
- *      Author: sbh
- */
+// 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 XGUI_PROPERTYPANEL_H_
 #define XGUI_PROPERTYPANEL_H_
@@ -20,6 +31,7 @@
 class XGUI_ActionsMgr;
 class QKeyEvent;
 class QGridLayout;
+class QToolButton;
 class ModuleBase_PageBase;
 class ModuleBase_PageWidget;
 class XGUI_OperationMgr;
@@ -36,6 +48,9 @@ const static char* PROP_PANEL_CANCEL = "property_panel_cancel";
 /// Internal name of Help button
 const static char* PROP_PANEL_HELP = "property_panel_help";
 
+/// Internal name of Preview button
+const static char* PROP_PANEL_PREVIEW = "property_panel_preview";
+
 /**
 * \ingroup GUI
 * Realization of Property panel object.
@@ -105,42 +120,74 @@ Q_OBJECT
   /// Returns operation manager
   XGUI_OperationMgr* operationMgr() const { return myOperationMgr; }
 
-public slots:
+  /// Find under the panel a child button with the parameter name
+  /// \param theInternalName a button object name
+  /// \return button instance or NULL
+  QToolButton* findButton(const char* theInternalName) const;
+
+  /// Possibility to process focus by method, for example when Tab or SHIF+Tab is pressed
+  /// but property panel is not active widget
+  /// \param theIsNext true, if Tab(to the next widget) or false(moving to the previous)
+  bool setFocusNextPrevChild(bool theIsNext);
 
-   /// \brief Update all widgets in property panel with values from the given feature
-   /// \param theFeature a Feature to update values in widgets
+public slots:
+  /// \brief Update all widgets in property panel with values from the given feature
+  /// \param theFeature a Feature to update values in widgets
   void updateContentWidget(FeaturePtr theFeature);
 
+  /// \brief If the XML definition of the feature contains information about specific
+  /// content of the property panel, it creates the panel and allow filling it by the given feature
+  /// \param theFeature a Feature to fill property panel
+  void createContentPanel(FeaturePtr theFeature);
+
   /**
   * Makes the given widget active, highlights it and removes
   * 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);
+  virtual void activateWidget(ModuleBase_ModelWidget* theWidget, const bool theEmitSignal = true);
+
+   /// Activates the parameter widget if it can accept focus
+   /// \param theWidget a widget where focus in event happened
+  void onFocusInWidget(ModuleBase_ModelWidget* theWidget);
+
+
+  /// Activate next widget
+  /// \param theWidget the current widget
+  void onActivateNextWidget(ModuleBase_ModelWidget* theWidget);
 
 signals:
-  void enterClicked();
+  /// The signal is emitted if the enter is clicked in the control of the widget
+  /// \param theObject a sender of the event
+  void enterClicked(QObject* theObject);
+
+  /// Emits on clear content
+  void propertyPanelDeactivated();
 
 protected:
   /// Makes the widget active, deactivate the previous, activate and hightlight the given one
   /// \param theWidget a widget
   bool setActiveWidget(ModuleBase_ModelWidget* theWidget);
-
   /// The parent method that processes the "Tab"/"SHIF + Tab" keyboard events
   /// Emits a signal about focus change
   /// If theIsNext is true, this function searches forward, if next is false, it searches backward.
   virtual bool focusNextPrevChild(bool theIsNext);
+  /// Activate the next widget in the property panel
+  /// \param theWidget a widget. The next widget should be activated
+  /// \param isCheckVisibility flag whether the next widget visibility is checked
+  void activateNextWidget(ModuleBase_ModelWidget* theWidget,
+                          const bool isCheckVisibility);
 
  protected:
    /// A method called on the property panel closed
    /// \param theEvent a close event
    void closeEvent(QCloseEvent* theEvent);
 
-  /// A header widget
-  QWidget* myHeaderWidget;
+private:
+  QWidget* myHeaderWidget;  ///< A header widget
 
- private:
   ModuleBase_PageWidget* myPanelPage;
   QList<ModuleBase_ModelWidget*> myWidgets;