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() ) );
116 connect ( myList->selectionModel(), SIGNAL( selectionChanged( QItemSelection, QItemSelection ) ),
117 this, SLOT( onSelectionChanged() ) );
120 setHiddenObjectsShown( true );
121 setVisibilityIconShown( true );
124 void HYDROGUI_OrderedListWidget::onSelectionChanged()
126 QStringList selectedEntries = getSelectedEntries();
133 HYDROGUI_OrderedListWidget::~HYDROGUI_OrderedListWidget()
138 Set the list of objects (which supposed to be ordered by the widget).
139 @param theObjects the list of pairs (object; visibility)
141 void HYDROGUI_OrderedListWidget::setObjects( const HYDROGUI_ListModel::Object2VisibleList& theObjects )
143 HYDROGUI_ListModel* aModel = getSourceModel();
145 aModel->setObjects( theObjects );
149 void HYDROGUI_OrderedListWidget::setBackgroundColor (int theInd, QColor theColor)
151 HYDROGUI_ListModel* aModel = getSourceModel();
153 aModel->setBackgroundColor( theInd, theColor );
157 void HYDROGUI_OrderedListWidget::setBackgroundColor (QString theName, QColor theColor)
159 HYDROGUI_ListModel* aModel = getSourceModel();
162 QList<Handle(HYDROData_Entity)> anObjects = aModel->getObjects();
165 foreach (Handle(HYDROData_Entity) ent, anObjects)
167 if (ent->GetName() == theName)
175 aModel->setBackgroundColor( ind, theColor );
179 void HYDROGUI_OrderedListWidget::clearAllBackgroundColors ()
181 HYDROGUI_ListModel* aModel = getSourceModel();
183 aModel->clearAllBackgroundColors( );
188 QColor HYDROGUI_OrderedListWidget::getBackgroundColor (int theInd) const
190 HYDROGUI_ListModel* aModel = getSourceModel();
192 return aModel->getBackgroundColor( theInd );
197 Returns the ordered list of objects.
198 @return the list of objects
200 QList<Handle(HYDROData_Entity)> HYDROGUI_OrderedListWidget::getObjects() const
202 QList<Handle(HYDROData_Entity)> anObjects;
204 HYDROGUI_ListModel* aModel = getSourceModel();
206 anObjects = aModel->getObjects();
213 Add the object to the end of the list.
214 @param theObjects the pair (object; visibility)
216 void HYDROGUI_OrderedListWidget::addObject( const HYDROGUI_ListModel::Object2Visible& theObject )
218 HYDROGUI_ListModel* aModel = getSourceModel();
220 aModel->addObject(theObject);
225 Remove the object from the list.
226 @param theObjectName the name of the object to remove
228 void HYDROGUI_OrderedListWidget::removeObjectByName( const QString& theObjectName )
230 HYDROGUI_ListModel* aModel = getSourceModel();
232 aModel->removeObjectByName(theObjectName);
237 Set whether the hidden objects are presented in the list.
238 @param theIsToShow if true - the hidden objects will be shown in the list
240 void HYDROGUI_OrderedListWidget::setHiddenObjectsShown( const bool theIsToShow )
242 myIsHiddenObjectsShown = theIsToShow;
244 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
245 QString anExpr = theIsToShow ? "true|false" : "true";
246 aFilterModel->setFilterRegExp( anExpr );
250 Set whether the visibility icon (eye icon) are presented in the list.
251 @param theIsToShow if true - the eye icon will be shown in the list
253 void HYDROGUI_OrderedListWidget::setVisibilityIconShown( const bool theIsToShow )
255 HYDROGUI_ListModel* aModel = getSourceModel();
257 aModel->setDecorationEnabled( theIsToShow );
262 Get entries of the selected objects.
263 @return the list of entries
265 QStringList HYDROGUI_OrderedListWidget::getSelectedEntries() const
267 QStringList anEntries;
269 QSortFilterProxyModel* aFilterModel =
270 dynamic_cast<QSortFilterProxyModel*>( myList->model() );
272 HYDROGUI_ListModel* aSourceModel =
273 dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
274 if ( aSourceModel ) {
275 QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
276 foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
277 QModelIndex aSourceIndex = aFilterModel->mapToSource( anIndex );
278 QString anEntry = aSourceModel->data( aSourceIndex, HYDROGUI_EntryRole ).toString();
279 anEntries << anEntry;
288 Set objects with the given entries selected (other objects will deselected).
289 @param theEntries the list of entries
291 void HYDROGUI_OrderedListWidget::setSelectedEntries( const QStringList& theEntries ) const
293 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
294 if( !aFilterModel ) {
297 HYDROGUI_ListModel* aSourceModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
298 if ( !aSourceModel ) {
301 QItemSelectionModel* aSelectionModel = myList->selectionModel();
302 if ( !aSelectionModel ) {
306 for ( int aRow = 0 ; aRow < aSourceModel->rowCount() ; aRow++ ) {
307 QModelIndex anIndex = aSourceModel->index( aRow, 0 );
308 if ( !anIndex.isValid() ) {
312 QString anEntry = aSourceModel->data( anIndex, HYDROGUI_EntryRole ).toString();
314 bool isToSelect = theEntries.contains( anEntry );
315 QModelIndex aProxyModelIndex = aFilterModel->mapFromSource( anIndex );
316 QItemSelectionModel::SelectionFlags aSelectionFlags =
317 isToSelect ? QItemSelectionModel::Select : QItemSelectionModel::Deselect;
318 aSelectionModel->select( aProxyModelIndex, aSelectionFlags );
323 Get names of the selected objects.
324 @return the list of names
326 QStringList HYDROGUI_OrderedListWidget::getSelectedNames() const
330 QSortFilterProxyModel* aFilterModel =
331 dynamic_cast<QSortFilterProxyModel*>( myList->model() );
332 if ( aFilterModel ) {
333 HYDROGUI_ListModel* aSourceModel =
334 dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
335 if ( aSourceModel ) {
336 QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
337 foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
338 QModelIndex aSourceIndex = aFilterModel->mapToSource( anIndex );
339 QString anEntry = aSourceModel->data( aSourceIndex, Qt::DisplayRole ).toString();
349 Get names of all objects.
350 @return the list of names
352 QStringList HYDROGUI_OrderedListWidget::getAllNames() const
357 foreach ( const Handle(HYDROData_Entity)& anObject, getObjects() ) {
358 aNames << anObject->GetName();
365 Slot called on top, up, down and bottom button click.
366 @param theType the move operation type
368 void HYDROGUI_OrderedListWidget::onMove( int theType )
370 bool isMoved = false;
372 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
374 HYDROGUI_ListModel* aModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
376 QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
377 QModelIndexList aSelectedSourceIndexes;
378 foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
379 aSelectedSourceIndexes << aFilterModel->mapToSource( anIndex );
381 QList<int> aSelectedIds = aModel->getIds( aSelectedSourceIndexes );
382 isMoved = aModel->move( aSelectedIds, ( HYDROGUI_ListModel::OpType )theType,
383 !myIsHiddenObjectsShown );
394 Returns the list source model.
395 @return the source model
397 HYDROGUI_ListModel* HYDROGUI_OrderedListWidget::getSourceModel() const
399 HYDROGUI_ListModel* aSourceModel = 0;
401 QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
403 aSourceModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
410 Enable/disable ordering (i.e. enable/disable arrow buttons and drag and drop).
411 @param theIsToEnable if true - ordering will bw enabled
413 void HYDROGUI_OrderedListWidget::setOrderingEnabled( const bool theIsToEnable )
415 // enable/disable arrow buttons
416 if ( myTop && myUp && myDown && myBottom ) {
417 myTop->setEnabled( theIsToEnable );
418 myUp->setEnabled( theIsToEnable );
419 myDown->setEnabled( theIsToEnable );
420 myBottom->setEnabled( theIsToEnable );
423 // enable/disable drag and drop
424 myList->setDragEnabled( theIsToEnable );
427 void HYDROGUI_OrderedListWidget::undoLastMove()
429 HYDROGUI_ListModel* aModel = getSourceModel();
431 aModel->undoLastMove();