11/* **************************************************************************
2- qgsbrowserdockwidget.h
2+ qgsbrowserdockwidget_p.h
3+
4+ Private classes for QgsBrowserDockWidget
5+
36 ---------------------
4- begin : July 2011
5- copyright : (C) 2011 by Martin Dobias
6- email : wonder dot sk at gmail dot com
7+ begin : May 2017
8+ copyright : (C) 2017 by Alessandro Pasotti
9+ real work done by : (C) 2011 by Martin Dobias
10+ email : a dot pasotti at itopen dot it
711 ***************************************************************************
812 * *
913 * This program is free software; you can redistribute it and/or modify *
1216 * (at your option) any later version. *
1317 * *
1418 ***************************************************************************/
15- #ifndef QGSBROWSERDOCKWIDGET_H
16- #define QGSBROWSERDOCKWIDGET_H
19+
20+
21+ #ifndef QGSBROWSERDOCKWIDGET_P_H
22+ #define QGSBROWSERDOCKWIDGET_P_H
23+
24+ // / @cond PRIVATE
25+
26+ //
27+ // W A R N I N G
28+ // -------------
29+ //
30+ // This file is not part of the QGIS API. It exists purely as an
31+ // implementation detail. This header file may change from version to
32+ // version without notice, or even be removed.
33+ //
34+
1735
1836#include < ui_qgsbrowserdockwidgetbase.h>
1937#include < ui_qgsbrowserlayerpropertiesbase.h>
2442#include " qgsbrowsertreeview.h"
2543#include " qgsdockwidget.h"
2644#include < QSortFilterProxyModel>
27- #include " qgis_app.h"
2845
2946class QgsBrowserModel ;
3047class QModelIndex ;
@@ -33,23 +50,41 @@ class QgsLayerItem;
3350class QgsDataItem ;
3451class QgsBrowserTreeFilterProxyModel ;
3552
36- // hack to show wrapped text without spaces
53+ /* *
54+ * Hack to show wrapped text without spaces
55+ */
3756class QgsBrowserPropertiesWrapLabel : public QTextEdit
3857{
3958 Q_OBJECT
4059 public:
60+
61+ /* *
62+ * Constructor for QgsBrowserPropertiesWrapLabel
63+ * \param text label text
64+ * \param parent parent widget
65+ */
4166 QgsBrowserPropertiesWrapLabel ( const QString &text, QWidget *parent = nullptr );
4267
4368 private slots:
4469 void adjustHeight ( QSizeF size );
4570};
4671
72+ /* *
73+ * The QgsBrowserPropertiesWidget base class
74+ */
4775class QgsBrowserPropertiesWidget : public QWidget
4876{
4977 Q_OBJECT
5078 public:
79+
80+ /* *
81+ * Constructor for QgsBrowserPropertiesWidget
82+ * \param parent parent widget
83+ */
5184 explicit QgsBrowserPropertiesWidget ( QWidget *parent = nullptr );
85+ // ! Factory method to create a new browser properties widget
5286 static QgsBrowserPropertiesWidget *createWidget ( QgsDataItem *item, QWidget *parent = nullptr );
87+ // ! Stub
5388 virtual void setItem ( QgsDataItem *item ) { Q_UNUSED ( item ) }
5489 // ! Set content widget, usually item paramWidget. Takes ownership.
5590 virtual void setWidget ( QWidget *widget );
@@ -62,137 +97,128 @@ class QgsBrowserPropertiesWidget : public QWidget
6297 virtual void setCondensedMode ( bool condensedMode ) { Q_UNUSED ( condensedMode ); }
6398};
6499
100+ /* *
101+ * The QgsBrowserLayerProperties class
102+ */
65103class QgsBrowserLayerProperties : public QgsBrowserPropertiesWidget , private Ui ::QgsBrowserLayerPropertiesBase
66104{
67105 Q_OBJECT
68106 public:
107+
108+ /* *
109+ * Constructor for QgsBrowserLayerProperties
110+ * \param parent parent widget
111+ */
69112 explicit QgsBrowserLayerProperties ( QWidget *parent = nullptr );
113+ // ! Set item
70114 void setItem ( QgsDataItem *item ) override ;
71115
116+ /* * Sets whether the properties widget should display in condensed mode, ie, for display in a dock
117+ * widget rather than it's own separate dialog.
118+ * \param condensedMode set to true to enable condensed mode
119+ * \since QGIS 2.10
120+ */
72121 virtual void setCondensedMode ( bool condensedMode ) override ;
73122
74123 private:
75124 QgsBrowserPropertiesWrapLabel *mUriLabel = nullptr ;
76125};
77126
127+ /* *
128+ * The QgsBrowserDirectoryProperties class
129+ */
78130class QgsBrowserDirectoryProperties : public QgsBrowserPropertiesWidget , private Ui ::QgsBrowserDirectoryPropertiesBase
79131{
80132 Q_OBJECT
81133 public:
134+
135+ /* *
136+ * Constructor for QgsBrowserDirectoryProperties
137+ * \param parent parent widget
138+ */
82139 explicit QgsBrowserDirectoryProperties ( QWidget *parent = nullptr );
83140
141+ // ! Create widget from the given item and add it
84142 void setItem ( QgsDataItem *item ) override ;
85143 private:
86144 QgsDirectoryParamWidget *mDirectoryWidget = nullptr ;
87145 QgsBrowserPropertiesWrapLabel *mPathLabel = nullptr ;
88146};
89147
148+ /* *
149+ * The QgsBrowserPropertiesDialog class
150+ */
90151class QgsBrowserPropertiesDialog : public QDialog , private Ui ::QgsBrowserPropertiesDialogBase
91152{
92153 Q_OBJECT
93154 public:
155+
156+ /* *
157+ * Constructor for QgsBrowserPropertiesDialog
158+ * \param settingsSection prefix for settings (from the object name)
159+ * \param parent parent widget
160+ */
94161 QgsBrowserPropertiesDialog ( const QString &settingsSection, QWidget *parent = nullptr );
95162 ~QgsBrowserPropertiesDialog ();
96163
164+ // ! Create dialog from the given item and add it
97165 void setItem ( QgsDataItem *item );
98166
99167 private:
100168 QgsBrowserPropertiesWidget *mPropertiesWidget = nullptr ;
101169 QString mSettingsSection ;
102170};
103171
104- class APP_EXPORT QgsBrowserDockWidget : public QgsDockWidget, private Ui::QgsBrowserDockWidgetBase
105- {
106- Q_OBJECT
107- public:
108- explicit QgsBrowserDockWidget ( const QString &name, QWidget *parent = nullptr );
109- ~QgsBrowserDockWidget ();
110- void addFavoriteDirectory ( const QString &favDir );
111-
112- public slots:
113- void addLayerAtIndex ( const QModelIndex &index );
114- void showContextMenu ( QPoint );
115-
116- void addFavorite ();
117- void addFavoriteDirectory ();
118- void removeFavorite ();
119-
120- void refresh ();
121-
122- void showFilterWidget ( bool visible );
123- void enablePropertiesWidget ( bool enable );
124- void setFilterSyntax ( QAction * );
125- void setCaseSensitive ( bool caseSensitive );
126- void setFilter ();
127-
128- // layer menu items
129- void addSelectedLayers ();
130- void showProperties ();
131- void hideItem ();
132- void toggleFastScan ();
133-
134- void selectionChanged ( const QItemSelection &selected, const QItemSelection &deselected );
135- void splitterMoved ();
136-
137- protected:
138- void refreshModel ( const QModelIndex &index );
139- void showEvent ( QShowEvent *event ) override ;
140- void addLayer ( QgsLayerItem *layerItem );
141- void clearPropertiesWidget ();
142- void setPropertiesWidget ();
143-
144- int selectedItemsCount ();
145- QString settingsSection () { return objectName ().toLower (); }
146-
147- QgsDockBrowserTreeView *mBrowserView = nullptr ;
148- QgsBrowserModel *mModel = nullptr ;
149- QgsBrowserTreeFilterProxyModel *mProxyModel = nullptr ;
150- QString mInitPath ;
151- bool mPropertiesWidgetEnabled ;
152- // height fraction
153- float mPropertiesWidgetHeight ;
154-
155- private:
156- };
157-
158172
159173/* *
160- Utility class for correct drag&drop handling.
161-
162- We want to allow user to drag layers to qgis window. At the same time we do not
163- accept drops of the items on our view - but if we ignore the drag enter action
164- then qgis application consumes the drag events and it is possible to drop the
165- items on the tree view although the drop is actually managed by qgis app.
174+ * Utility class for correct drag&drop handling.
175+ *
176+ * We want to allow user to drag layers to qgis window. At the same time we do not
177+ * accept drops of the items on our view - but if we ignore the drag enter action
178+ * then qgis application consumes the drag events and it is possible to drop the
179+ * items on the tree view although the drop is actually managed by qgis app.
166180 */
167181class QgsDockBrowserTreeView : public QgsBrowserTreeView
168182{
169183 Q_OBJECT
170184
171185 public:
172- explicit QgsDockBrowserTreeView ( QWidget *parent );
173186
187+ /* *
188+ * Constructor for QgsDockBrowserTreeView
189+ * \param parent parent widget
190+ */
191+ explicit QgsDockBrowserTreeView ( QWidget *parent );
192+ // ! Overrides drag enter event
174193 void dragEnterEvent ( QDragEnterEvent *e ) override ;
194+ // ! Overrides drag move event
175195 void dragMoveEvent ( QDragMoveEvent *e ) override ;
196+ // ! Overrides drag stop event
176197 void dropEvent ( QDropEvent *e ) override ;
177198};
178199
179200/* *
180- Utility class for filtering browser items
201+ * Utility class for filtering browser items
181202 */
182203class QgsBrowserTreeFilterProxyModel : public QSortFilterProxyModel
183204{
184205 Q_OBJECT
185206 public:
186- explicit QgsBrowserTreeFilterProxyModel ( QObject *parent );
187207
208+ /* *
209+ * Constructor for QgsBrowserTreeFilterProxyModel
210+ * @param parent parent widget
211+ */
212+ explicit QgsBrowserTreeFilterProxyModel ( QObject *parent );
213+ // ! Set the browser model
188214 void setBrowserModel ( QgsBrowserModel *model );
189-
215+ // ! Set the filter syntax
190216 void setFilterSyntax ( const QString &syntax );
191-
217+ // ! Set the filter
192218 void setFilter ( const QString &filter );
193-
219+ // ! Set case sensitivity
194220 void setCaseSensitive ( bool caseSensitive );
195-
221+ // ! Update filter
196222 void updateFilter ();
197223
198224 protected:
@@ -203,20 +229,23 @@ class QgsBrowserTreeFilterProxyModel : public QSortFilterProxyModel
203229 QString mPatternSyntax ;
204230 Qt::CaseSensitivity mCaseSensitivity ;
205231
232+ // ! Filter accepts string
206233 bool filterAcceptsString ( const QString &value ) const ;
207234
208- // It would be better to apply the filer only to expanded (visible) items, but using mapFromSource() + view here was causing strange errors
235+ // ! It would be better to apply the filer only to expanded (visible) items, but using mapFromSource() + view here was causing strange errors
209236 bool filterAcceptsRow ( int sourceRow, const QModelIndex &sourceParent ) const override ;
210237
211- // returns true if at least one ancestor is accepted by filter
238+ // ! Returns true if at least one ancestor is accepted by filter
212239 bool filterAcceptsAncestor ( const QModelIndex &sourceIndex ) const ;
213240
214- // returns true if at least one descendant s accepted by filter
241+ // ! Returns true if at least one descendant s accepted by filter
215242 bool filterAcceptsDescendant ( const QModelIndex &sourceIndex ) const ;
216243
217- // filter accepts item name
244+ // ! Filter accepts item name
218245 bool filterAcceptsItem ( const QModelIndex &sourceIndex ) const ;
219246};
220247
221248
222- #endif // QGSBROWSERDOCKWIDGET_H
249+ // / @endcond
250+
251+ #endif // QGSBROWSERDOCKWIDGET_P_H
0 commit comments