Salome HOME
suite
[modules/shaper.git] / src / XGUI / XGUI_PropertyPanel.h
index 7743a0ffcb1390de50993063a7c86dcdceb05bb3..d92892ac03d07467f57e319466b350d43e2677eb 100644 (file)
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-/*
- * XGUI_PropertyPanel.h
- *
- *  Created on: Apr 29, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2022  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
+//
 
 #ifndef XGUI_PROPERTYPANEL_H_
 #define XGUI_PROPERTYPANEL_H_
@@ -26,19 +36,22 @@ class ModuleBase_PageWidget;
 class XGUI_OperationMgr;
 
 /// Internal name of property panel widget
-const static char* PROP_PANEL = "property_panel_dock";
+MAYBE_UNUSED const static char* PROP_PANEL = "property_panel_dock";
+
+/// Internal name of Ok button
+MAYBE_UNUSED const static char* PROP_PANEL_OK = "property_panel_ok";
 
 /// Internal name of Ok button
-const static char* PROP_PANEL_OK = "property_panel_ok";
+MAYBE_UNUSED const static char* PROP_PANEL_OK_PLUS = "property_panel_ok_plus";
 
 /// Internal name of Cancel button
-const static char* PROP_PANEL_CANCEL = "property_panel_cancel";
+MAYBE_UNUSED const static char* PROP_PANEL_CANCEL = "property_panel_cancel";
 
 /// Internal name of Help button
-const static char* PROP_PANEL_HELP = "property_panel_help";
+MAYBE_UNUSED const static char* PROP_PANEL_HELP = "property_panel_help";
 
 /// Internal name of Preview button
-const static char* PROP_PANEL_PREVIEW = "property_panel_preview";
+MAYBE_UNUSED const static char* PROP_PANEL_PREVIEW = "property_panel_preview";
 
 /**
 * \ingroup GUI
@@ -73,8 +86,11 @@ Q_OBJECT
   /// Removes all widgets in the widget area of the property panel
   virtual void cleanContent();
 
-  /// Returns currently active widget
-  virtual ModuleBase_ModelWidget* activeWidget() const { return myActiveWidget; }
+  /// Returns currently active widget. This is a widget from internal container of widgets
+  /// (myWidgets) activated/deactivated by focus in property panel. If parameter is true,
+  /// the method finds firstly the custom widget, after the direct active widget.
+  /// \param isUseCustomWidget boolean state if the custom widget might be a result
+  virtual ModuleBase_ModelWidget* activeWidget(const bool isUseCustomWidget = false) const;
 
   /// Activate the next widget in the property panel
   /// \param theWidget a widget. The next widget should be activated
@@ -114,6 +130,22 @@ Q_OBJECT
   /// \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);
+
+  /// The method is called on accepting of operation
+  virtual void onAcceptData();
+
+  /// Set internal active widget, that can be returned as active widget and participate in active
+  /// selection filters/modes in application. It emits signal about property panel activation or
+  /// deactivation and updates selection filters/modes accordingly.
+  /// \param theWidget a widget control to store as internal active widget
+  void setInternalActiveWidget(ModuleBase_ModelWidget* theWidget);
+
+  void updateApplyPlusButton(FeaturePtr theFeature);
+
 public slots:
   /// \brief Update all widgets in property panel with values from the given feature
   /// \param theFeature a Feature to update values in widgets
@@ -127,7 +159,6 @@ public slots:
   /**
   * 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
   */
@@ -147,16 +178,20 @@ signals:
   /// \param theObject a sender of the event
   void enterClicked(QObject* theObject);
 
+  /// Emits on deactivating property panel (e.g. by clearContent)
+  void propertyPanelDeactivated();
+  /// Emits on widget activating
+  void propertyPanelActivated();
+
 protected:
   /// Makes the widget active, deactivate the previous, activate and hightlight the given one
   /// \param theWidget a widget
-  bool setActiveWidget(ModuleBase_ModelWidget* theWidget);
-
+  /// \param isEmitSignal flag whether panel signals should be emitted
+  bool setActiveWidget(ModuleBase_ModelWidget* theWidget, const bool isEmitSignal);
   /// 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
@@ -178,6 +213,8 @@ private:
   ModuleBase_ModelWidget* myActiveWidget;
   /// Currently widget processed by preselection
   ModuleBase_ModelWidget* myPreselectionWidget;
+  /// Some custom widget set from outside
+  ModuleBase_ModelWidget* myInternalActiveWidget;
 
   XGUI_OperationMgr* myOperationMgr;
 };