src/HYDROGUI/HYDROGUI_OrderedListWidget.h

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROGUI_ORDEREDLISTWIDGET_H
  24 #define HYDROGUI_ORDEREDLISTWIDGET_H
  25
  26 #include "HYDROGUI_ListModel.h"
  27
  28 #include <QWidget>
  29
  30 class QListView;
  31 class QPushButton;
  32
  33 /**
  34  * \class HYDROGUI_OrderedListWidget
  35  * \brief The class representing widget for managing list of objects.
  36  *
  37  * The widget represents a list and a set of buttons (top, up, down and bottom)
  38  * providing the possibility to change the list items order.
  39  */
  40 class HYDRO_EXPORT HYDROGUI_OrderedListWidget : public QWidget
  41 {
  42   Q_OBJECT
  43
  44 public:
  45   HYDROGUI_OrderedListWidget( QWidget* theParent, int theArrowIconSize = 32 );
  46   virtual ~HYDROGUI_OrderedListWidget();
  47
  48   void setObjects( const HYDROGUI_ListModel::Object2VisibleList& theObjects );
  49   HYDROGUI_ListModel::ObjectList getObjects() const;
  50
  51   void addObject( const HYDROGUI_ListModel::Object2Visible& theObject );
  52   void removeObjectByName( const QString& theObjectName );
  53
  54   void setHiddenObjectsShown( const bool theIsToShow );
  55   void setVisibilityIconShown( const bool theIsToShow );
  56
  57   void setOrderingEnabled( const bool theIsToEnable );
  58
  59   QStringList getSelectedEntries() const;
  60   void setSelectedEntries( const QStringList& theEntries ) const;
  61
  62   QStringList getSelectedNames() const;
  63   QStringList getAllNames() const;
  64
  65 signals:
  66   void selectionChanged();
  67
  68 private slots:
  69   void onMove( int theType );
  70
  71 private:
  72   HYDROGUI_ListModel* getSourceModel() const;
  73
  74   QModelIndexList getSelectedIndexes() const;
  75
  76 private:
  77   QListView*   myList;   ///< the list view
  78   QPushButton* myTop;    ///< the move on top button
  79   QPushButton* myUp;     ///< the move up button
  80   QPushButton* myDown;   ///< the move down button
  81   QPushButton* myBottom; ///< the move on bottom button
  82
  83   bool myIsHiddenObjectsShown; ///< defines whether to include hidden objects in the list
  84   bool myIsVisibilityIconShown; ///< defines whether to show visibility icon (eye icon)
  85 };
  86
  87 #endif