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