Salome HOME
e1ea16ad3ff45ecd0481dea154a6e9dd1e215b39
[modules/gui.git] / src / ObjBrowser / OB_Browser.h
1 #ifndef OB_BROWSER_H
2 #define OB_BROWSER_H
3
4 #include "OB.h"
5
6 #include <qframe.h>
7
8 #include <qmap.h>
9 #include <qlistview.h>
10
11 #include <SUIT_DataObject.h>
12 #include <SUIT_DataObjectKey.h>
13 #include <SUIT_PopupClient.h>
14
15 #ifdef WNT
16 #pragma warning( disable:4251 )
17 #endif
18
19 class QToolTip;
20 class OB_Filter;
21 class OB_ListView;
22
23 class OB_EXPORT OB_Browser : public QFrame, public SUIT_PopupClient
24 {
25         Q_OBJECT
26
27   class ToolTip;
28
29 public:
30         OB_Browser( QWidget* = 0, SUIT_DataObject* theRoot = 0 );
31         virtual ~OB_Browser();
32
33   virtual QString   popupClientType() const { return QString( "ObjectBrowser" ); }
34
35   SUIT_DataObject*  getRootObject() const;
36   virtual void      setRootObject( SUIT_DataObject* theRoot = 0 );
37
38   int               numberOfSelected() const;
39
40   DataObjectList    getSelected() const;
41   void              getSelected( DataObjectList& ) const;
42
43   virtual void      setSelected( const SUIT_DataObject* theObject, const bool = false );
44   virtual void      setSelected( const DataObjectList& theObjLst, const bool = false );
45
46   bool              isOpen( SUIT_DataObject* theObject ) const;
47   virtual void      setOpen( SUIT_DataObject* theObject, const bool theOpen = true );
48
49   bool              isAutoUpdate() const;
50   virtual void      setAutoUpdate( const bool );
51
52   bool              isAutoDeleteObjects() const;
53   virtual void      setAutoDeleteObjects( const bool );
54
55   virtual void      updateTree( SUIT_DataObject* = 0 );
56   virtual void      replaceTree( SUIT_DataObject*, SUIT_DataObject* );
57
58   bool              isShowToolTips();
59   void              setShowToolTips( const bool theDisplay );
60
61   void              adjustWidth();
62
63   SUIT_DataObject*  dataObjectAt( const QPoint& ) const;
64
65   OB_Filter*        filter() const;
66   void              setFilter( OB_Filter* );
67
68   bool              rootIsDecorated() const;
69   void              setRootIsDecorated( const bool );
70
71   int               autoOpenLevel() const;
72   void              setAutoOpenLevel( const int );
73
74   virtual int       addColumn( const QString & label, int width = -1, int index = -1 );
75   virtual int       addColumn( const QIconSet & iconset, const QString & label, int width = -1, int index = -1 );
76   virtual void      removeColumn( int index );
77
78   virtual bool      eventFilter(QObject* watched, QEvent* e);
79
80   QListView*        getListView() const;
81   
82   virtual void      contextMenuPopup( QPopupMenu* );
83
84 signals:
85   void              selectionChanged();
86   void              dropped( DataObjectList, SUIT_DataObject*, int );
87
88 private slots:
89   void              onExpand();
90   void              onRefresh();
91   void              onDestroyed( SUIT_DataObject* );
92   void              onDropped( QPtrList<QListViewItem>, QListViewItem*, int );
93
94 protected:
95   void              adjustWidth( QListViewItem* );
96   virtual void      updateView( const SUIT_DataObject* theStartObj = 0 );
97   virtual void      updateText();
98
99   virtual void      keyPressEvent( QKeyEvent* );
100
101   SUIT_DataObject*  dataObject( const QListViewItem* ) const;
102   QListViewItem*    listViewItem( const SUIT_DataObject* ) const;
103
104 private:
105   typedef QMap<SUIT_DataObject*, QListViewItem*> ItemMap;
106   typedef SUIT_DataObjectKeyHandle               DataObjectKey;
107   typedef QMap<SUIT_DataObject*, int>            DataObjectMap;
108   typedef QMap<DataObjectKey, int>               DataObjectKeyMap;
109
110 private:
111   void              expand( QListViewItem* );
112   bool              hasClosed( QListViewItem* ) const;
113
114   void              autoOpenBranches();
115   void              openBranch( QListViewItem*, const int );
116
117   void              removeReferences( QListViewItem* );
118   void              createConnections( SUIT_DataObject* );
119   void              removeObject( SUIT_DataObject*, const bool = true );
120
121   DataObjectKey     objectKey( QListViewItem* ) const;
122   DataObjectKey     objectKey( SUIT_DataObject* ) const;
123
124   QListViewItem*    createTree( const SUIT_DataObject*, QListViewItem*, QListViewItem* = 0 );
125   QListViewItem*    createItem( const SUIT_DataObject*, QListViewItem*, QListViewItem* = 0 );
126
127   SUIT_DataObject*  storeState( DataObjectMap&, DataObjectMap&,
128                                 DataObjectKeyMap&, DataObjectKeyMap&, DataObjectKey& ) const;
129   void              restoreState( const DataObjectMap&, const DataObjectMap&, const SUIT_DataObject*,
130                                   const DataObjectKeyMap&, const DataObjectKeyMap&, const DataObjectKey& );
131
132 private:
133   OB_ListView*      myView;
134   SUIT_DataObject*  myRoot;
135   ItemMap           myItems;
136   QToolTip*         myTooltip;
137   QMap<int, int>    myColumnIds;
138   bool              myAutoUpdate;
139   bool              myAutoDelObjs;
140   bool              myShowToolTips;
141   bool              myRootDecorated;
142   int               myAutoOpenLevel;
143
144   friend class OB_Browser::ToolTip;
145 };
146
147 #endif