Salome HOME
c1cf4ef5f89401d96e4968cac12d719d4df1e624
[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&, const int id = -1, const int width = -1 );
75   virtual int       addColumn( const QIconSet&, const QString&, const int id = -1, const int width = -1 );
76   virtual void      removeColumn( const int id );
77
78   void              setNameTitle( const QString& );
79   virtual void      setNameTitle( const QIconSet&, const QString& );
80   void              setColumnTitle( const int id, const QString& );
81   virtual void      setColumnTitle( const int id, const QIconSet&, const QString& );
82
83   bool              isColumnVisible( const int ) const;
84   virtual void      setColumnShown( const int, const bool );
85
86   QValueList<int>   columns() const;
87
88   virtual bool      eventFilter(QObject* watched, QEvent* e);
89
90   QListView*        listView() const;
91
92   virtual void      contextMenuPopup( QPopupMenu* );
93
94 signals:
95   void              aboutRefresh();
96   void              selectionChanged();
97   void              dropped( DataObjectList, SUIT_DataObject*, int );
98
99 private slots:
100   void              onExpand();
101   void              onRefresh();
102   void              onDestroyed( SUIT_DataObject* );
103   void              onDropped( QPtrList<QListViewItem>, QListViewItem*, int );
104
105 protected:
106   void              adjustWidth( QListViewItem* );
107   virtual void      updateView( const SUIT_DataObject* theStartObj = 0 );
108   virtual void      updateText();
109
110   virtual void      keyPressEvent( QKeyEvent* );
111
112   SUIT_DataObject*  dataObject( const QListViewItem* ) const;
113   QListViewItem*    listViewItem( const SUIT_DataObject* ) const;
114
115 private:
116   typedef QMap<SUIT_DataObject*, QListViewItem*> ItemMap;
117   typedef SUIT_DataObjectKeyHandle               DataObjectKey;
118   typedef QMap<SUIT_DataObject*, int>            DataObjectMap;
119   typedef QMap<DataObjectKey, int>               DataObjectKeyMap;
120
121 private:
122   void              expand( QListViewItem* );
123   bool              hasClosed( QListViewItem* ) const;
124
125   void              autoOpenBranches();
126   void              openBranch( QListViewItem*, const int );
127
128   void              removeReferences( QListViewItem* );
129   void              createConnections( SUIT_DataObject* );
130   void              removeObject( SUIT_DataObject*, const bool = true );
131
132   void              updateText( QListViewItem* );
133   void              updateTree( SUIT_DataObject*, const bool );
134
135   DataObjectKey     objectKey( QListViewItem* ) const;
136   DataObjectKey     objectKey( SUIT_DataObject* ) const;
137
138   QListViewItem*    createTree( const SUIT_DataObject*, QListViewItem*, QListViewItem* = 0 );
139   QListViewItem*    createItem( const SUIT_DataObject*, QListViewItem*, QListViewItem* = 0 );
140
141   SUIT_DataObject*  storeState( DataObjectMap&, DataObjectMap&,
142                                 DataObjectKeyMap&, DataObjectKeyMap&, DataObjectKey& ) const;
143   void              restoreState( const DataObjectMap&, const DataObjectMap&, const SUIT_DataObject*,
144                                   const DataObjectKeyMap&, const DataObjectKeyMap&, const DataObjectKey& );
145
146 private:
147   OB_ListView*      myView;
148   SUIT_DataObject*  myRoot;
149   ItemMap           myItems;
150   QToolTip*         myTooltip;
151   QMap<int, int>    myColumnIds;
152   bool              myAutoUpdate;
153   bool              myAutoDelObjs;
154   bool              myShowToolTips;
155   bool              myRootDecorated;
156   int               myAutoOpenLevel;
157
158   friend class OB_Browser::ToolTip;
159 };
160
161 #endif