]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROGUI/HYDROGUI_OrderedListWidget.cxx
Salome HOME
Merge branch 'BR_H2018_2' of https://codev-tuleap.cea.fr/plugins/git/salome/hydro...
[modules/hydro.git] / src / HYDROGUI / HYDROGUI_OrderedListWidget.cxx
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.
6 //
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.
11 //
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
15 //
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
17 //
18
19 #include "HYDROGUI_OrderedListWidget.h"
20
21 #include "HYDROGUI_ListModel.h"
22
23 #include <SUIT_Session.h>
24 #include <SUIT_ResourceMgr.h>
25
26 #include <QLayout>
27 #include <QListView>
28 #include <QPushButton>
29 #include <QSignalMapper>
30 #include <QSortFilterProxyModel>
31
32
33 /**
34   Constructor.
35   @param theParent the parent widget
36   @param theIconSize the icon size for arrow buttons
37 */
38 HYDROGUI_OrderedListWidget::HYDROGUI_OrderedListWidget( QWidget* theParent, int theArrowIconSize )
39 : QWidget( theParent )
40 {
41   // Main layout
42   QHBoxLayout* aMainLayout = new QHBoxLayout( this );
43   aMainLayout->setMargin( 0 );
44   aMainLayout->setSpacing( 5 );
45
46   // List view
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 );
55
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 );
62
63   myList->setModel( aFilteredModel );
64
65   // Add list to the main layout
66   aMainLayout->addWidget( myList );
67
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" ) );
87
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();
95     
96     aMainLayout->addLayout( aListButtonsLayout );
97
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 ) ) );
109   } else {
110     myTop = myUp = myDown = myBottom = 0;
111   }
112
113   connect ( myList->selectionModel(), SIGNAL( selectionChanged( QItemSelection, QItemSelection ) ), 
114             this, SIGNAL( selectionChanged() ) );
115
116   // Initialize
117   setHiddenObjectsShown( true );
118   setVisibilityIconShown( true );
119 }
120
121 /**
122   Destructor.
123 */
124 HYDROGUI_OrderedListWidget::~HYDROGUI_OrderedListWidget()
125 {
126 }
127
128 /**
129   Set the list of objects (which supposed to be ordered by the widget).
130   @param theObjects the list of pairs (object; visibility)
131 */
132 void HYDROGUI_OrderedListWidget::setObjects( const HYDROGUI_ListModel::Object2VisibleList& theObjects )
133 {
134   HYDROGUI_ListModel* aModel = getSourceModel();
135   if( aModel ) {
136     aModel->setObjects( theObjects );
137   }
138 }
139
140 void HYDROGUI_OrderedListWidget::setBackgroundColor (int theInd, QColor theColor)
141 {
142   HYDROGUI_ListModel* aModel = getSourceModel();
143   if( aModel ) {
144     aModel->setBackgroundColor( theInd, theColor );
145   }
146 }
147
148 void HYDROGUI_OrderedListWidget::clearAllBackgroundColors ()
149 {
150   HYDROGUI_ListModel* aModel = getSourceModel();
151   if( aModel ) {
152     aModel->clearAllBackgroundColors( );
153   }
154 }
155
156
157  QColor HYDROGUI_OrderedListWidget::getBackgroundColor (int theInd) const
158  {
159    HYDROGUI_ListModel* aModel = getSourceModel();
160    if( aModel ) {
161      return aModel->getBackgroundColor( theInd );
162    }
163  }
164
165 /**
166   Returns the ordered list of objects.
167   @return the list of objects
168 */
169 QList<Handle(HYDROData_Entity)> HYDROGUI_OrderedListWidget::getObjects() const
170 {
171   QList<Handle(HYDROData_Entity)> anObjects;
172
173   HYDROGUI_ListModel* aModel = getSourceModel();
174   if( aModel ) {
175     anObjects = aModel->getObjects();
176   }
177
178   return anObjects;
179 }
180
181 /**
182   Add the object to the end of the list.
183   @param theObjects the pair (object; visibility)
184 */
185 void HYDROGUI_OrderedListWidget::addObject( const HYDROGUI_ListModel::Object2Visible& theObject )
186 {
187   HYDROGUI_ListModel* aModel = getSourceModel();
188   if( aModel ) {
189     aModel->addObject(theObject);
190   }
191 }
192
193 /**
194   Remove the object from the list.
195   @param theObjectName the name of the object to remove
196 */
197 void HYDROGUI_OrderedListWidget::removeObjectByName( const QString& theObjectName )
198 {
199   HYDROGUI_ListModel* aModel = getSourceModel();
200   if( aModel ) {
201     aModel->removeObjectByName(theObjectName);
202   }
203 }
204
205 /**
206   Set whether the hidden objects are presented in the list.
207   @param theIsToShow if true - the hidden objects will be shown in the list
208 */
209 void HYDROGUI_OrderedListWidget::setHiddenObjectsShown( const bool theIsToShow )
210 {
211   myIsHiddenObjectsShown = theIsToShow; 
212
213   QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
214   QString anExpr = theIsToShow ? "true|false" : "true";
215   aFilterModel->setFilterRegExp( anExpr );
216 }
217
218 /**
219   Set whether the visibility icon (eye icon) are presented in the list.
220   @param theIsToShow if true - the eye icon will be shown in the list
221 */
222 void HYDROGUI_OrderedListWidget::setVisibilityIconShown( const bool theIsToShow )
223 {
224   HYDROGUI_ListModel* aModel = getSourceModel();
225   if( aModel ) {
226     aModel->setDecorationEnabled( theIsToShow );
227   }
228 }
229
230 /**
231   Get entries of the selected objects.
232   @return the list of entries
233 */
234 QStringList HYDROGUI_OrderedListWidget::getSelectedEntries() const
235
236   QStringList anEntries;
237
238   QSortFilterProxyModel* aFilterModel = 
239     dynamic_cast<QSortFilterProxyModel*>( myList->model() );
240   if( aFilterModel ) {
241     HYDROGUI_ListModel* aSourceModel = 
242       dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
243     if ( aSourceModel ) {
244       QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
245       foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
246         QModelIndex aSourceIndex = aFilterModel->mapToSource( anIndex );
247         QString anEntry = aSourceModel->data( aSourceIndex, HYDROGUI_EntryRole ).toString();
248         anEntries << anEntry;
249       }
250     }
251   }
252
253   return anEntries;
254 }
255
256 /**
257   Set objects with the given entries selected (other objects will deselected).
258   @param theEntries the list of entries
259 */
260 void HYDROGUI_OrderedListWidget::setSelectedEntries( const QStringList& theEntries ) const
261 {
262   QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
263   if( !aFilterModel ) {
264     return;
265   }
266   HYDROGUI_ListModel* aSourceModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
267   if ( !aSourceModel ) {
268     return;
269   }
270   QItemSelectionModel* aSelectionModel = myList->selectionModel();
271   if ( !aSelectionModel ) {
272     return;
273   }
274   
275   for ( int aRow = 0 ; aRow < aSourceModel->rowCount() ; aRow++ ) {
276     QModelIndex anIndex = aSourceModel->index( aRow, 0 );
277     if ( !anIndex.isValid() ) {
278       continue;
279     }
280
281     QString anEntry = aSourceModel->data( anIndex, HYDROGUI_EntryRole ).toString();
282
283     bool isToSelect = theEntries.contains( anEntry );
284     QModelIndex aProxyModelIndex = aFilterModel->mapFromSource( anIndex );
285     QItemSelectionModel::SelectionFlags aSelectionFlags =
286       isToSelect ? QItemSelectionModel::Select : QItemSelectionModel::Deselect;
287     aSelectionModel->select( aProxyModelIndex, aSelectionFlags );
288   }
289 }
290
291 /**
292   Get names of the selected objects.
293   @return the list of names
294 */
295 QStringList HYDROGUI_OrderedListWidget::getSelectedNames() const
296 {
297   QStringList aNames;
298
299   QSortFilterProxyModel* aFilterModel = 
300     dynamic_cast<QSortFilterProxyModel*>( myList->model() );
301   if ( aFilterModel ) {
302     HYDROGUI_ListModel* aSourceModel = 
303       dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
304     if ( aSourceModel ) {
305       QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
306       foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
307         QModelIndex aSourceIndex = aFilterModel->mapToSource( anIndex );
308         QString anEntry = aSourceModel->data( aSourceIndex, Qt::DisplayRole ).toString();
309         aNames << anEntry;
310       }
311     }
312   }
313
314   return aNames;
315 }
316
317 /**
318   Get names of all objects.
319   @return the list of names
320 */
321 QStringList HYDROGUI_OrderedListWidget::getAllNames() const
322 {
323   QStringList aNames;
324
325
326   foreach ( const Handle(HYDROData_Entity)& anObject, getObjects() ) {
327     aNames << anObject->GetName();
328   }
329
330   return aNames;
331 }
332
333 /**
334   Slot called on top, up, down and bottom button click.
335   @param theType the move operation type
336 */
337 void HYDROGUI_OrderedListWidget::onMove( int theType )
338 {
339   bool isMoved = false;
340
341   QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
342   if( aFilterModel ) {
343     HYDROGUI_ListModel* aModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
344     if( aModel ) {
345       QModelIndexList aSelectedIndexes = myList->selectionModel()->selectedIndexes();
346       QModelIndexList aSelectedSourceIndexes;
347       foreach ( const QModelIndex& anIndex, aSelectedIndexes ) {
348         aSelectedSourceIndexes << aFilterModel->mapToSource( anIndex );
349       }
350       QList<int> aSelectedIds = aModel->getIds( aSelectedSourceIndexes );
351       isMoved = aModel->move( aSelectedIds, ( HYDROGUI_ListModel::OpType )theType, 
352                               !myIsHiddenObjectsShown );
353     }
354   }
355
356   if ( isMoved )
357   {
358     emit orderChanged();
359   }
360 }
361
362 /**
363   Returns the list source model.
364   @return the source model
365 */
366 HYDROGUI_ListModel* HYDROGUI_OrderedListWidget::getSourceModel() const
367 {
368   HYDROGUI_ListModel* aSourceModel = 0;
369
370   QSortFilterProxyModel* aFilterModel = dynamic_cast<QSortFilterProxyModel*>( myList->model() );
371   if( aFilterModel ) {
372     aSourceModel = dynamic_cast<HYDROGUI_ListModel*>( aFilterModel->sourceModel() );
373   }
374
375   return aSourceModel;
376 }
377
378 /**
379   Enable/disable ordering (i.e. enable/disable arrow buttons and drag and drop).
380   @param theIsToEnable if true - ordering will bw enabled
381 */
382 void HYDROGUI_OrderedListWidget::setOrderingEnabled( const bool theIsToEnable )
383 {
384   // enable/disable arrow buttons
385   if ( myTop && myUp && myDown && myBottom ) {
386     myTop->setEnabled( theIsToEnable );
387     myUp->setEnabled( theIsToEnable );
388     myDown->setEnabled( theIsToEnable );
389     myBottom->setEnabled( theIsToEnable );
390   }
391
392   // enable/disable drag and drop
393   myList->setDragEnabled( theIsToEnable );
394 }
395
396 void HYDROGUI_OrderedListWidget::undoLastMove()
397 {
398   HYDROGUI_ListModel* aModel = getSourceModel();
399   if( aModel )
400     aModel->undoLastMove();
401 }