-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_WidgetMultiSelector.h
- *
- * Created on: Oct 8, 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 MODULEBASE_WIDGETMULTISELECTOR_H_
#define MODULEBASE_WIDGETMULTISELECTOR_H_
#include <QMap>
class QWidget;
-class QListWidget;
class QComboBox;
+class ModuleBase_ListView;
class ModuleBase_IWorkshop;
-class QAction;
-
/**
* \ingroup GUI
/// This value should be processed in the widget according to the needs
/// \param theValues the wrapped selection values
/// \param theToValidate a validation of the values flag
- virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
+ virtual bool setSelection(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues,
const bool theToValidate);
/// Returns values which should be highlighted when the whidget is active
/// \param theValues a list of presentations
- virtual void getHighlighted(QList<ModuleBase_ViewerPrs>& theValues);
+ virtual void getHighlighted(QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
+
+ /// Returns true if the action can be processed. By default it is empty and returns false.
+ /// \param theActionType an action type
+ /// \param isActionEnabled if true, the enable state of the action
+ virtual bool canProcessAction(ModuleBase_ActionType theActionType, bool& isActionEnabled);
+
+ /// Returns true if the event is processed. The default implementation is empty, returns false.
+ virtual bool processAction(ModuleBase_ActionType theActionType,
+ const ActionParamPtr& theParam = ActionParamPtr());
+
+ /// Activate or deactivate selection and selection filters
+ virtual void updateSelectionModesAndFilters(bool toActivate);
/// Checks the widget validity. By default, it returns true.
/// \param thePrs a selected presentation in the view
/// \return a boolean value
- virtual bool isValidSelectionCustom(const ModuleBase_ViewerPrs& thePrs);
+ virtual bool isValidSelectionCustom(const std::shared_ptr<ModuleBase_ViewerPrs>& thePrs);
- /// Returns true if the event is processed. The default implementation is empty, returns false.
- virtual bool processDelete();
+ /// Returns list of accessible actions for Undo/Redo commands. By default it returns empty list.
+ /// \param theActionType type of action. It can be ActionUndo or ActionRedo.
+ virtual QList<ActionInfo> actionsList(ModuleBase_ActionType theActionType) const;
public slots:
/// Slot is called on selection type changed
void onSelectionTypeChanged();
-protected slots:
- /// Slot for copy command in a list pop-up menu
- void onCopyItem();
+protected:
+ /// Returns true if envent is processed.
+ /// Redefined to process XML state about clear selection in neutral point
+ virtual bool processSelection();
+protected slots:
/// Slot for delete command in a list pop-up menu
void onDeleteItem();
void onListSelection();
protected:
+ /// Returns true if the event is processed. The default implementation is empty, returns false.
+ virtual bool processDelete();
+
/// The methiod called when widget is activated
virtual void activateCustom();
/// Saves the internal parameters to the given feature
/// \return True in success
- virtual bool storeValueCustom() const;
+ virtual bool storeValueCustom();
+ /// restire type of selection by feature attribute
virtual bool restoreValueCustom();
- /// Creates a backup of the current values of the attribute
- /// It should be realized in the specific widget because of different
- /// parameters of the current attribute
- virtual void storeAttributeValue();
+ /// Creates an element of the attribute current selection if history is empty
+ virtual void appendFirstSelectionInHistory();
+
+ /// Create an element in the history that stores the current selection,
+ /// position in the history is incremented
+ void appendSelectionInHistory();
+
+ /// Clear list of stored selected items, reset current position into '-1'
+ void clearSelectedHistory();
/// Set the focus on the last item in the list
virtual void updateFocus();
/// Computes and updates name of selected object in the widget
virtual void updateSelectionName();
+ /// Emits model changed info, updates the current control by selection change
+ /// \param theDone a state whether the selection is set
+ virtual void updateOnSelectionChanged(const bool theDone);
+
/// Retunrs a list of possible shape types
/// \return a list of shapes
- virtual QIntList getShapeTypes() const;
-
- /// Creates a backup of the current values of the attribute
- /// It should be realized in the specific widget because of different
- /// parameters of the current attribute
- /// \param theValid a boolean flag, if restore happens for valid parameters
- virtual void restoreAttributeValue(const bool theValid);
+ virtual QIntList shapeTypes() const;
/// Set current shape type for selection
- void setCurrentShapeType(const TopAbs_ShapeEnum theShapeType);
+ void setCurrentShapeType(const int theShapeType);
/// Return the attribute values wrapped in a list of viewer presentations
/// \return a list of viewer presentations, which contains an attribute result and
/// a shape. If the attribute do not uses the shape, it is empty
- virtual QList<ModuleBase_ViewerPrs> getAttributeSelection() const;
+ virtual QList<std::shared_ptr<ModuleBase_ViewerPrs>> getAttributeSelection() const;
/// Fills the list control by the attribute values
void updateSelectionList();
/// For example, the "Edges" is converted to "edge"
std::string validatorType(const QString& theType) const;
+ /// Clear selection in the viewer. The content of the widget is cleared also
+ void clearSelection();
+
protected:
- /// Returns attribute indices selected in the widget selection list
+ /// Returns attribute indices selected in the widget selection list
/// \param theIndices a list of indices
void getSelectedAttributeIndices(std::set<int>& theIndices);
/// \param theAttributeIds indices in attribute list to be returned
/// \param theValues the result presentations, filled with object and shape of an attribute item
void convertIndicesToViewerSelection(std::set<int> theAttributeIds,
- QList<ModuleBase_ViewerPrs>& theValues) const;
+ QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) const;
/// Iterates throgh the model attribute list and remove elements which do not present in the list
/// \param theValues the wrapped selection values
- virtual void removeUnusedAttributeObjects(QList<ModuleBase_ViewerPrs>& theValues);
+ /// \return true if at least one object is removed
+ virtual bool removeUnusedAttributeObjects(
+ QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
/// Converts viewer presentation selection list to objects and shapes map
/// \param theValues the wrapped selection values
/// \return selection list
std::map<ObjectPtr, std::set<GeomShapePtr> > convertSelection
- (QList<ModuleBase_ViewerPrs>& theValues);
+ (QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
/// Returns true if the object and shape present in the container
/// \param theObject a model object, a set of shapes is searched by it
/// \param theShape a shape to be in the set of the object shapes
/// \param theGeomSelection a map built on selection
+ /// \param theWorkshop a current workshop
/// \return boolean result
static bool findInSelection(const ObjectPtr& theObject,
- const GeomShapePtr& theShape,
- const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection);
+ GeomShapePtr theShape,
+ const std::map<ObjectPtr, std::set<GeomShapePtr> >& theGeomSelection,
+ ModuleBase_IWorkshop* theWorkshop);
protected:
- /// List control
- QListWidget* myListControl;
-
- /// Combobox of types
- QComboBox* myTypeCombo;
-
- /// Provides correspondance between Result object and its shape
- typedef QPair<ResultPtr, GeomShapePtr> GeomSelection;
-
- /// An action for pop-up menu in a list control
- QAction* myCopyAction;
- QAction* myDeleteAction;
+ ModuleBase_ListView* myListView; ///< List control
+ QComboBox* myTypeCombo; ///< Combobox of types
+ bool myIsUseChoice; /// A flag to store use_choice parameter state
- /// backup parameters of the model attribute. The class processes three types of attribute:
- /// Reference, RefAttr and Selection. Depending on the attribute type, only the attribute parameter
- /// values are reserved in the backup
- /// Variable of selection type
- std::string mySelectionType;
+ /// A flag to clear selection by click in empty place in the viewer
+ bool myIsNeutralPointClear;
- /// Variable of GeomSelection
- int mySelectionCount; // number of elements in the attribute selection list when store
+ /// A flag to block set selection perform if the method is in process
+ bool myIsSetSelectionBlocked;
- /// A flag to store use_choice parameter state
- bool myIsUseChoice;
+ /// A container of selected objects
+ QList<QList<std::shared_ptr<ModuleBase_ViewerPrs> > > mySelectedHistoryValues;
+ /// Position in a container of selected values
+ int myCurrentHistoryIndex;
};
#endif /* MODULEBASE_WIDGETFILESELECTOR_H_ */
