1 // Copyright (C) 2014-2015 EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 // Lesser General Public License for more details.
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #include "HYDROGUI_OrderedListWidget.h"
21 #include "HYDROGUI_ListModel.h"
23 #include <SUIT_Session.h>
24 #include <SUIT_ResourceMgr.h>
28 #include <QPushButton>
29 #include <QSignalMapper>
30 #include <QSortFilterProxyModel>
35 @param theParent the parent widget
36 @param theIconSize the icon size for arrow buttons
38 HYDROGUI_OrderedListWidget::HYDROGUI_OrderedListWidget( QWidget* theParent, int theArrowIconSize )
39 : QWidget( theParent )
42 QHBoxLayout* aMainLayout = new QHBoxLayout( this );
43 aMainLayout->setMargin( 0 );
44 aMainLayout->setSpacing( 5 );
47 myList = new QListView( this );
48 myList->setSelectionMode( QAbstractItemView::ExtendedSelection );
49 // enable drag and drop
50 myList->setDragEnabled( true );
51 myList->setAcceptDrops( true );
52 // configure drag and drop
53 myList->setDropIndicatorShown( true );
54 myList->setDragDropMode( QAbstractItemView::InternalMove );
56 // Set the custom model
57 HYDROGUI_ListModel* aModel = new HYDROGUI_ListModel();
58 QSortFilterProxyModel* aFilteredModel = new QSortFilterProxyModel();
59 aFilteredModel->setSourceModel( aModel );
60 aFilteredModel->setFilterKeyColumn( 0 );
61 aFilteredModel->setFilterRole( HYDROGUI_VisibleRole );
63 myList->setModel( aFilteredModel );
65 // Add list to the main layout
66 aMainLayout->addWidget( myList );
68 // Buttons top, up, down, bottom
69 if ( theArrowIconSize > 0 ) {
70 SUIT_ResourceMgr* aResMgr = SUIT_Session::session()->resourceMgr();
71 myTop = new QPushButton( this );
72 myTop->setIcon( aResMgr->loadPixmap( "HYDRO", tr( "ARROW_TOP_ICO" ) ) );
73 myTop->setIconSize( QSize( theArrowIconSize, theArrowIconSize ) );
74 myTop->setToolTip( tr( "TOP_TLT" ) );
75 myUp = new QPushButton( this );
76 myUp->setIcon( aResMgr->loadPixmap( "HYDRO", tr( "ARROW_UP_ICO" ) ) );
77 myUp->setIconSize( myTop->iconSize() );
78 myUp->setToolTip( tr( "UP_TLT" ) );
79 myDown = new QPushButton( this );
80 myDown->setIcon( aResMgr->loadPixmap( "HYDRO", tr( "ARROW_DOWN_ICO" ) ) );
81 myDown->setIconSize( myTop->iconSize() );
82 myDown->setToolTip( tr( "DOWN_TLT" ) );
83 myBottom = new QPushButton( this );
84 myBottom->setIcon( aResMgr->loadPixmap( "HYDRO", tr( "ARROW_BOTTOM_ICO" ) ) );
85 myBottom->setIconSize( myTop->iconSize() );
86 myBottom->setToolTip( tr( "BOTTOM_TLT" ) );
88 // Add buttons to the main layout
89 QVBoxLayout* aListButtonsLayout = new QVBoxLayout();
90 aListButtonsLayout->addWidget( myTop );
91 aListButtonsLayout->addWidget( myUp );
92 aListButtonsLayout->addWidget( myDown );
93 aListButtonsLayout->addWidget( myBottom );
94 aListButtonsLayout->addStretch();
96 aMainLayout->addLayout( aListButtonsLayout );
98 // Buttons connections
99 QSignalMapper* aSignalMapper = new QSignalMapper( this );
100 aSignalMapper->setMapping( myTop, HYDROGUI_ListModel::Top );
101 aSignalMapper->setMapping( myUp, HYDROGUI_ListModel::Up );
102 aSignalMapper->setMapping( myDown, HYDROGUI_ListModel::Down );
103 aSignalMapper->setMapping( myBottom, HYDROGUI_ListModel::Bottom );
104 connect( myTop, SIGNAL( clicked() ), aSignalMapper, SLOT( map() ) );
105 connect( myUp, SIGNAL( clicked() ), aSignalMapper, SLOT( map() ) );
106 connect( myDown, SIGNAL( clicked() ), aSignalMapper, SLOT( map() ) );
107 connect( myBottom, SIGNAL( clicked() ), aSignalMapper, SLOT( map() ) );
108 connect( aSignalMapper, SIGNAL( mapped( int ) ), this, SLOT( onMove( int ) ) );
110 myTop = myUp = myDown = myBottom = 0;
113 connect ( myList->selectionModel(), SIGNAL( selectionChanged( QItemSelection, QItemSelection ) ),
114 this, SIGNAL( selectionChanged() ) );
117 setHiddenObjectsShown( true );
118 setVisibilityIconShown( true );
124 HYDROGUI_OrderedListWidget::~HYDROGUI_OrderedListWidget()
129 Set the list of objects (which supposed to be ordered by the widget).
130 @param theObjects the list of pairs (object; visibility)
132 void HYDROGUI_OrderedListWidget::setObjects( const HYDROGUI_ListModel::Object2VisibleList& theObjects )
134 HYDROGUI_ListModel* aModel = getSourceModel();
136 aModel->setObjects( theObjects );
141 Returns the ordered list of objects.
142 @return the list of objects
144 QList<Handle(HYDROData_Entity)> HYDROGUI_OrderedListWidget::getObjects() const
146 QList<Handle(HYDROData_Entity)> anObjects;
148 HYDROGUI_ListModel* aModel = getSourceModel();
150 anObjects = aModel->getObjects();
157 Add the object to the end of the list.
158 @param theObjects the pair (object; visibility)
160 void HYDROGUI_OrderedListWidget::addObject( const HYDROGUI_ListModel::Object2Visible& theObject )
162 HYDROGUI_ListModel* aModel = getSourceModel();
164 aModel->addObject(theObject);
169 Remove the object from the list.
170 @param theObjectName the name of the object to remove
172 void HYDROGUI_OrderedListWidget::removeObjectByName( const QString& theObjectName )
174 HYDROGUI_ListModel* aModel = getSourceModel();
176 aModel->removeObjectByName(theObjectName);
181 Set whether the hidden objects are presented in the list.
182 @param theIsToShow if true - the hidden objects will be shown in the list
184 void HYDROGUI_OrderedListWidget::setHiddenObjectsShown( const bool theIsToShow )
186 myIsHiddenObjectsShown = theIsToShow;
188 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
189 QString anExpr = theIsToShow ? "true|false" : "true";
190 aFilterModel->setFilterRegExp( anExpr );
194 Set whether the visibility icon (eye icon) are presented in the list.
195 @param theIsToShow if true - the eye icon will be shown in the list
197 void HYDROGUI_OrderedListWidget::setVisibilityIconShown( const bool theIsToShow )
199 HYDROGUI_ListModel* aModel = getSourceModel();
201 aModel->setDecorationEnabled( theIsToShow );
206 Get entries of the selected objects.
207 @return the list of entries
209 QStringList HYDROGUI_OrderedListWidget::getSelectedEntries() const
211 QStringList anEntries;
213 QSortFilterProxyModel* aFilterModel =
214 dynamic_cast<QSortFilterProxyModel*>( myList->model() );
216 HYDROGUI_ListModel* aSourceModel =
217 dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
218 if ( aSourceModel ) {
219 QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
220 foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
221 QModelIndex aSourceIndex = aFilterModel->mapToSource( anIndex );
222 QString anEntry = aSourceModel->data( aSourceIndex, HYDROGUI_EntryRole ).toString();
223 anEntries << anEntry;
232 Set objects with the given entries selected (other objects will deselected).
233 @param theEntries the list of entries
235 void HYDROGUI_OrderedListWidget::setSelectedEntries( const QStringList& theEntries ) const
237 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
238 if( !aFilterModel ) {
241 HYDROGUI_ListModel* aSourceModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
242 if ( !aSourceModel ) {
245 QItemSelectionModel* aSelectionModel = myList->selectionModel();
246 if ( !aSelectionModel ) {
250 for ( int aRow = 0 ; aRow < aSourceModel->rowCount() ; aRow++ ) {
251 QModelIndex anIndex = aSourceModel->index( aRow, 0 );
252 if ( !anIndex.isValid() ) {
256 QString anEntry = aSourceModel->data( anIndex, HYDROGUI_EntryRole ).toString();
258 bool isToSelect = theEntries.contains( anEntry );
259 QModelIndex aProxyModelIndex = aFilterModel->mapFromSource( anIndex );
260 QItemSelectionModel::SelectionFlags aSelectionFlags =
261 isToSelect ? QItemSelectionModel::Select : QItemSelectionModel::Deselect;
262 aSelectionModel->select( aProxyModelIndex, aSelectionFlags );
267 Get names of the selected objects.
268 @return the list of names
270 QStringList HYDROGUI_OrderedListWidget::getSelectedNames() const
274 QSortFilterProxyModel* aFilterModel =
275 dynamic_cast<QSortFilterProxyModel*>( myList->model() );
276 if ( aFilterModel ) {
277 HYDROGUI_ListModel* aSourceModel =
278 dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
279 if ( aSourceModel ) {
280 QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
281 foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
282 QModelIndex aSourceIndex = aFilterModel->mapToSource( anIndex );
283 QString anEntry = aSourceModel->data( aSourceIndex, Qt::DisplayRole ).toString();
293 Get names of all objects.
294 @return the list of names
296 QStringList HYDROGUI_OrderedListWidget::getAllNames() const
301 foreach ( const Handle(HYDROData_Entity)& anObject, getObjects() ) {
302 aNames << anObject->GetName();
309 Slot called on top, up, down and bottom button click.
310 @param theType the move operation type
312 void HYDROGUI_OrderedListWidget::onMove( int theType )
314 bool isMoved = false;
316 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
318 HYDROGUI_ListModel* aModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
320 QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
321 QModelIndexList aSelectedSourceIndexes;
322 foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
323 aSelectedSourceIndexes << aFilterModel->mapToSource( anIndex );
325 QList<int> aSelectedIds = aModel->getIds( aSelectedSourceIndexes );
326 isMoved = aModel->move( aSelectedIds, ( HYDROGUI_ListModel::OpType )theType,
327 !myIsHiddenObjectsShown );
338 Returns the list source model.
339 @return the source model
341 HYDROGUI_ListModel* HYDROGUI_OrderedListWidget::getSourceModel() const
343 HYDROGUI_ListModel* aSourceModel = 0;
345 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
347 aSourceModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
354 Enable/disable ordering (i.e. enable/disable arrow buttons and drag and drop).
355 @param theIsToEnable if true - ordering will bw enabled
357 void HYDROGUI_OrderedListWidget::setOrderingEnabled( const bool theIsToEnable )
359 // enable/disable arrow buttons
360 if ( myTop && myUp && myDown && myBottom ) {
361 myTop->setEnabled( theIsToEnable );
362 myUp->setEnabled( theIsToEnable );
363 myDown->setEnabled( theIsToEnable );
364 myBottom->setEnabled( theIsToEnable );
367 // enable/disable drag and drop
368 myList->setDragEnabled( theIsToEnable );
371 void HYDROGUI_OrderedListWidget::undoLastMove()
373 HYDROGUI_ListModel* aModel = getSourceModel();
375 aModel->undoLastMove();