1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef XGUI_PROPERTYPANEL_H_
22 #define XGUI_PROPERTYPANEL_H_
26 #include <ModuleBase_ModelWidget.h>
27 #include <ModuleBase_IPropertyPanel.h>
31 class XGUI_ActionsMgr;
35 class ModuleBase_PageBase;
36 class ModuleBase_PageWidget;
37 class XGUI_OperationMgr;
39 /// Internal name of property panel widget
40 const static char* PROP_PANEL = "property_panel_dock";
42 /// Internal name of Ok button
43 const static char* PROP_PANEL_OK = "property_panel_ok";
45 /// Internal name of Cancel button
46 const static char* PROP_PANEL_CANCEL = "property_panel_cancel";
48 /// Internal name of Help button
49 const static char* PROP_PANEL_HELP = "property_panel_help";
51 /// Internal name of Preview button
52 const static char* PROP_PANEL_PREVIEW = "property_panel_preview";
56 * Realization of Property panel object.
58 class XGUI_EXPORT XGUI_PropertyPanel : public ModuleBase_IPropertyPanel
64 /// \param theParent is a parent of the property panel
65 /// \param theMgr operation manager
66 XGUI_PropertyPanel(QWidget* theParent, XGUI_OperationMgr* theMgr);
68 virtual ~XGUI_PropertyPanel();
70 /// Returns header widget
71 virtual QWidget* headerWidget() const { return myHeaderWidget; }
73 /// Returns main widget of the property panel, which children will be created
74 /// by WidgetFactory using the XML definition
75 ModuleBase_PageBase* contentWidget();
77 /// Brings back all widget created by widget factory for signal/slot
78 /// connections and further processing
79 void setModelWidgets(const QList<ModuleBase_ModelWidget*>& theWidgets);
81 /// Returns all property panel's widget created by WidgetFactory
82 virtual const QList<ModuleBase_ModelWidget*>& modelWidgets() const;
84 /// Removes all widgets in the widget area of the property panel
85 virtual void cleanContent();
87 /// Returns currently active widget
88 virtual ModuleBase_ModelWidget* activeWidget() const { return myActiveWidget; }
90 /// Activate the next widget in the property panel
91 /// \param theWidget a widget. The next widget should be activated
92 virtual void activateNextWidget(ModuleBase_ModelWidget* theWidget);
94 /// Activate the next from current widget in the property panel
95 virtual void activateNextWidget();
97 /// Set focus on the Ok button
98 virtual void setFocusOnOkButton();
100 /// Set Enable/Disable state of Cancel button
101 /// \param theEnabled Enable/Disable state of Cancel button
102 virtual void setCancelEnabled(bool theEnabled);
104 /// \return Enable/Disable state of Cancel button
105 virtual bool isCancelEnabled() const;
107 /// Editing mode depends on mode of current operation. This value is defined by it.
108 /// \param isEditing state of editing mode flag
109 virtual void setEditingMode(bool isEditing);
111 //! Allows to set predefined actions for the property panel fetched from the ActionsMgr
112 void setupActions(XGUI_ActionsMgr* theMgr);
114 /// Returns widget processed by preselection
115 virtual ModuleBase_ModelWidget* preselectionWidget() const;
117 /// Sets widget processed by preselection
118 virtual void setPreselectionWidget(ModuleBase_ModelWidget* theWidget);
120 /// Returns operation manager
121 XGUI_OperationMgr* operationMgr() const { return myOperationMgr; }
123 /// Find under the panel a child button with the parameter name
124 /// \param theInternalName a button object name
125 /// \return button instance or NULL
126 QToolButton* findButton(const char* theInternalName) const;
128 /// Possibility to process focus by method, for example when Tab or SHIF+Tab is pressed
129 /// but property panel is not active widget
130 /// \param theIsNext true, if Tab(to the next widget) or false(moving to the previous)
131 bool setFocusNextPrevChild(bool theIsNext);
134 /// \brief Update all widgets in property panel with values from the given feature
135 /// \param theFeature a Feature to update values in widgets
136 void updateContentWidget(FeaturePtr theFeature);
138 /// \brief If the XML definition of the feature contains information about specific
139 /// content of the property panel, it creates the panel and allow filling it by the given feature
140 /// \param theFeature a Feature to fill property panel
141 void createContentPanel(FeaturePtr theFeature);
144 * Makes the given widget active, highlights it and removes
145 * highlighting from the previous active widget
146 * emits widgetActivated(theWidget) signal
147 * \param theWidget which has to be activated
148 * \param theEmitSignal a flag to prohibit signal emit
150 virtual void activateWidget(ModuleBase_ModelWidget* theWidget, const bool theEmitSignal = true);
152 /// Activates the parameter widget if it can accept focus
153 /// \param theWidget a widget where focus in event happened
154 void onFocusInWidget(ModuleBase_ModelWidget* theWidget);
157 /// Activate next widget
158 /// \param theWidget the current widget
159 void onActivateNextWidget(ModuleBase_ModelWidget* theWidget);
162 /// The signal is emitted if the enter is clicked in the control of the widget
163 /// \param theObject a sender of the event
164 void enterClicked(QObject* theObject);
167 /// Makes the widget active, deactivate the previous, activate and hightlight the given one
168 /// \param theWidget a widget
169 bool setActiveWidget(ModuleBase_ModelWidget* theWidget);
170 /// The parent method that processes the "Tab"/"SHIF + Tab" keyboard events
171 /// Emits a signal about focus change
172 /// If theIsNext is true, this function searches forward, if next is false, it searches backward.
173 virtual bool focusNextPrevChild(bool theIsNext);
174 /// Activate the next widget in the property panel
175 /// \param theWidget a widget. The next widget should be activated
176 /// \param isCheckVisibility flag whether the next widget visibility is checked
177 void activateNextWidget(ModuleBase_ModelWidget* theWidget,
178 const bool isCheckVisibility);
181 /// A method called on the property panel closed
182 /// \param theEvent a close event
183 void closeEvent(QCloseEvent* theEvent);
186 QWidget* myHeaderWidget; ///< A header widget
188 ModuleBase_PageWidget* myPanelPage;
189 QList<ModuleBase_ModelWidget*> myWidgets;
191 /// Currently active widget
192 ModuleBase_ModelWidget* myActiveWidget;
193 /// Currently widget processed by preselection
194 ModuleBase_ModelWidget* myPreselectionWidget;
196 XGUI_OperationMgr* myOperationMgr;
199 #endif /* XGUI_PROPERTYPANEL_H_ */