Skip to content

Commit bbb2727

Browse files
wonder-skwonder-sk
committed
Minor fixes (spelling, renaming, sip magic)
1 parent 8190930 commit bbb2727

10 files changed

+54
-37
lines changed

‎python/gui/layertree/qgslayertreeview.sip.in

+12-6
Original file line numberDiff line numberDiff line change
@@ -118,26 +118,32 @@ in the layer tree view. They can be used to show extra information with tree nod
118118
user interaction.
119119

120120
Does not take ownership of the indicator. One indicator object may be used for multiple layer tree nodes.
121-
\sa removeIndicator
122-
\sa indicators
121+
122+
.. seealso:: :py:func:`removeIndicator`
123+
124+
.. seealso:: :py:func:`indicators`
123125

124126
.. versionadded:: 3.2
125127
%End
126128

127129
void removeIndicator( QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator );
128130
%Docstring
129131
Removes a previously added indicator to a layer tree node. Does not delete the indicator.
130-
\sa addIndicator
131-
\sa indicators
132+
133+
.. seealso:: :py:func:`addIndicator`
134+
135+
.. seealso:: :py:func:`indicators`
132136

133137
.. versionadded:: 3.2
134138
%End
135139

136140
QList<QgsLayerTreeViewIndicator *> indicators( QgsLayerTreeNode *node ) const;
137141
%Docstring
138142
Returns list of indicators associated with a particular layer tree node.
139-
\sa addIndicator
140-
\sa removeIndicator
143+
144+
.. seealso:: :py:func:`addIndicator`
145+
146+
.. seealso:: :py:func:`removeIndicator`
141147

142148
.. versionadded:: 3.2
143149
%End

‎python/gui/layertree/qgslayertreeviewindicator.sip

+3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ and QgsLayerTreeView.removeIndicator() calls.
2626
%End
2727
public:
2828
explicit QgsLayerTreeViewIndicator( QObject *parent /TransferThis/ = 0 );
29+
%Docstring
30+
Constructs an indicator, optionally transferring ownership to a parent QObject
31+
%End
2932

3033
QIcon icon() const;
3134
%Docstring

‎src/app/qgisapp.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -3646,7 +3646,7 @@ void QgisApp::initLayerTreeView()
36463646

36473647
mLayerTreeView->setModel( model );
36483648
mLayerTreeView->setMenuProvider( new QgsAppLayerTreeViewMenuProvider( mLayerTreeView, mMapCanvas ) );
3649-
new QgsLayerTreeViewFilterIndicatorManager( mLayerTreeView ); // gets parented to the layer view
3649+
new QgsLayerTreeViewFilterIndicatorProvider( mLayerTreeView ); // gets parented to the layer view
36503650

36513651
setupLayerTreeViewFromSettings();
36523652

‎src/app/qgslayertreeviewfilterindicator.cpp

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/***************************************************************************
22
qgslayertreeviewfilterindicator.cpp
33
--------------------------------------
4-
Date : Januray 2018
4+
Date : January 2018
55
Copyright : (C) 2018 by Martin Dobias
66
Email : wonder dot sk at gmail dot com
77
***************************************************************************
@@ -22,7 +22,7 @@
2222
#include "qgsvectorlayer.h"
2323

2424

25-
QgsLayerTreeViewFilterIndicatorManager::QgsLayerTreeViewFilterIndicatorManager( QgsLayerTreeView *view )
25+
QgsLayerTreeViewFilterIndicatorProvider::QgsLayerTreeViewFilterIndicatorProvider( QgsLayerTreeView *view )
2626
: QObject( view )
2727
, mLayerTreeView( view )
2828
{
@@ -31,12 +31,12 @@ QgsLayerTreeViewFilterIndicatorManager::QgsLayerTreeViewFilterIndicatorManager(
3131
QgsLayerTree *tree = mLayerTreeView->layerTreeModel()->rootGroup();
3232
onAddedChildren( tree, 0, tree->children().count() - 1 );
3333

34-
connect( tree, &QgsLayerTree::addedChildren, this, &QgsLayerTreeViewFilterIndicatorManager::onAddedChildren );
35-
connect( tree, &QgsLayerTree::willRemoveChildren, this, &QgsLayerTreeViewFilterIndicatorManager::onWillRemoveChildren );
34+
connect( tree, &QgsLayerTree::addedChildren, this, &QgsLayerTreeViewFilterIndicatorProvider::onAddedChildren );
35+
connect( tree, &QgsLayerTree::willRemoveChildren, this, &QgsLayerTreeViewFilterIndicatorProvider::onWillRemoveChildren );
3636
}
3737

3838

39-
void QgsLayerTreeViewFilterIndicatorManager::onAddedChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo )
39+
void QgsLayerTreeViewFilterIndicatorProvider::onAddedChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo )
4040
{
4141
// recursively connect to providers' dataChanged() signal
4242

@@ -56,22 +56,22 @@ void QgsLayerTreeViewFilterIndicatorManager::onAddedChildren( QgsLayerTreeNode *
5656
{
5757
if ( vlayer->dataProvider() )
5858
{
59-
connect( vlayer->dataProvider(), &QgsDataProvider::dataChanged, this, &QgsLayerTreeViewFilterIndicatorManager::onProviderDataChanged );
59+
connect( vlayer->dataProvider(), &QgsDataProvider::dataChanged, this, &QgsLayerTreeViewFilterIndicatorProvider::onProviderDataChanged );
6060

6161
addOrRemoveIndicator( childLayerNode, vlayer->dataProvider() );
6262
}
6363
}
6464
else if ( !childLayerNode->layer() )
6565
{
6666
// wait for layer to be loaded (e.g. when loading project, first the tree is loaded, afterwards the references to layers are resolved)
67-
connect( childLayerNode, &QgsLayerTreeLayer::layerLoaded, this, &QgsLayerTreeViewFilterIndicatorManager::onLayerLoaded );
67+
connect( childLayerNode, &QgsLayerTreeLayer::layerLoaded, this, &QgsLayerTreeViewFilterIndicatorProvider::onLayerLoaded );
6868
}
6969
}
7070
}
7171
}
7272

7373

74-
void QgsLayerTreeViewFilterIndicatorManager::onWillRemoveChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo )
74+
void QgsLayerTreeViewFilterIndicatorProvider::onWillRemoveChildren( QgsLayerTreeNode *node, int indexFrom, int indexTo )
7575
{
7676
// recursively disconnect from providers' dataChanged() signal
7777

@@ -90,14 +90,14 @@ void QgsLayerTreeViewFilterIndicatorManager::onWillRemoveChildren( QgsLayerTreeN
9090
if ( QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( childLayerNode->layer() ) )
9191
{
9292
if ( vlayer->dataProvider() )
93-
disconnect( vlayer->dataProvider(), &QgsDataProvider::dataChanged, this, &QgsLayerTreeViewFilterIndicatorManager::onProviderDataChanged );
93+
disconnect( vlayer->dataProvider(), &QgsDataProvider::dataChanged, this, &QgsLayerTreeViewFilterIndicatorProvider::onProviderDataChanged );
9494
}
9595
}
9696
}
9797
}
9898

9999

100-
void QgsLayerTreeViewFilterIndicatorManager::onLayerLoaded()
100+
void QgsLayerTreeViewFilterIndicatorProvider::onLayerLoaded()
101101
{
102102
QgsLayerTreeLayer *nodeLayer = qobject_cast<QgsLayerTreeLayer *>( sender() );
103103
if ( !nodeLayer )
@@ -107,15 +107,15 @@ void QgsLayerTreeViewFilterIndicatorManager::onLayerLoaded()
107107
{
108108
if ( vlayer->dataProvider() )
109109
{
110-
connect( vlayer->dataProvider(), &QgsDataProvider::dataChanged, this, &QgsLayerTreeViewFilterIndicatorManager::onProviderDataChanged );
110+
connect( vlayer->dataProvider(), &QgsDataProvider::dataChanged, this, &QgsLayerTreeViewFilterIndicatorProvider::onProviderDataChanged );
111111

112112
addOrRemoveIndicator( nodeLayer, vlayer->dataProvider() );
113113
}
114114
}
115115
}
116116

117117

118-
void QgsLayerTreeViewFilterIndicatorManager::onProviderDataChanged()
118+
void QgsLayerTreeViewFilterIndicatorProvider::onProviderDataChanged()
119119
{
120120
QgsVectorDataProvider *provider = qobject_cast<QgsVectorDataProvider *>( sender() );
121121
if ( !provider )
@@ -134,7 +134,7 @@ void QgsLayerTreeViewFilterIndicatorManager::onProviderDataChanged()
134134
}
135135

136136

137-
void QgsLayerTreeViewFilterIndicatorManager::onIndicatorClicked( const QModelIndex &index )
137+
void QgsLayerTreeViewFilterIndicatorProvider::onIndicatorClicked( const QModelIndex &index )
138138
{
139139
QgsLayerTreeNode *node = mLayerTreeView->layerTreeModel()->index2node( index );
140140
if ( !QgsLayerTree::isLayer( node ) )
@@ -151,23 +151,23 @@ void QgsLayerTreeViewFilterIndicatorManager::onIndicatorClicked( const QModelInd
151151
vlayer->dataProvider()->setSubsetString( qb.sql() );
152152
}
153153

154-
QgsLayerTreeViewIndicator *QgsLayerTreeViewFilterIndicatorManager::newIndicator( const QString &filter )
154+
QgsLayerTreeViewIndicator *QgsLayerTreeViewFilterIndicatorProvider::newIndicator( const QString &filter )
155155
{
156156
QgsLayerTreeViewIndicator *indicator = new QgsLayerTreeViewIndicator( this );
157157
indicator->setIcon( mIcon );
158158
updateIndicator( indicator, filter );
159-
connect( indicator, &QgsLayerTreeViewIndicator::clicked, this, &QgsLayerTreeViewFilterIndicatorManager::onIndicatorClicked );
159+
connect( indicator, &QgsLayerTreeViewIndicator::clicked, this, &QgsLayerTreeViewFilterIndicatorProvider::onIndicatorClicked );
160160
mIndicators.insert( indicator );
161161
return indicator;
162162
}
163163

164-
void QgsLayerTreeViewFilterIndicatorManager::updateIndicator( QgsLayerTreeViewIndicator *indicator, const QString &filter )
164+
void QgsLayerTreeViewFilterIndicatorProvider::updateIndicator( QgsLayerTreeViewIndicator *indicator, const QString &filter )
165165
{
166166
indicator->setToolTip( QString( "<b>%1:</b><br>%2" ).arg( tr( "Filter" ) ).arg( filter ) );
167167
}
168168

169169

170-
void QgsLayerTreeViewFilterIndicatorManager::addOrRemoveIndicator( QgsLayerTreeNode *node, QgsVectorDataProvider *provider )
170+
void QgsLayerTreeViewFilterIndicatorProvider::addOrRemoveIndicator( QgsLayerTreeNode *node, QgsVectorDataProvider *provider )
171171
{
172172
QString filter = provider->subsetString();
173173
if ( !filter.isEmpty() )

‎src/app/qgslayertreeviewfilterindicator.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/***************************************************************************
22
qgslayertreeviewfilterindicator.h
33
--------------------------------------
4-
Date : Januray 2018
4+
Date : January 2018
55
Copyright : (C) 2018 by Martin Dobias
66
Email : wonder dot sk at gmail dot com
77
***************************************************************************
@@ -26,11 +26,11 @@ class QgsVectorDataProvider;
2626

2727

2828
//! Adds indicators showing whether vector layers have a filter applied.
29-
class QgsLayerTreeViewFilterIndicatorManager : public QObject
29+
class QgsLayerTreeViewFilterIndicatorProvider : public QObject
3030
{
3131
Q_OBJECT
3232
public:
33-
explicit QgsLayerTreeViewFilterIndicatorManager( QgsLayerTreeView *view );
33+
explicit QgsLayerTreeViewFilterIndicatorProvider( QgsLayerTreeView *view );
3434

3535
private slots:
3636
//! Connects to signals of layers newly added to the tree

‎src/gui/layertree/qgslayertreeview.h

+6-6
Original file line numberDiff line numberDiff line change
@@ -113,24 +113,24 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView
113113
* user interaction.
114114
*
115115
* Does not take ownership of the indicator. One indicator object may be used for multiple layer tree nodes.
116-
* \sa removeIndicator
117-
* \sa indicators
116+
* \see removeIndicator
117+
* \see indicators
118118
* \since QGIS 3.2
119119
*/
120120
void addIndicator( QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator );
121121

122122
/**
123123
* Removes a previously added indicator to a layer tree node. Does not delete the indicator.
124-
* \sa addIndicator
125-
* \sa indicators
124+
* \see addIndicator
125+
* \see indicators
126126
* \since QGIS 3.2
127127
*/
128128
void removeIndicator( QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator );
129129

130130
/**
131131
* Returns list of indicators associated with a particular layer tree node.
132-
* \sa addIndicator
133-
* \sa removeIndicator
132+
* \see addIndicator
133+
* \see removeIndicator
134134
* \since QGIS 3.2
135135
*/
136136
QList<QgsLayerTreeViewIndicator *> indicators( QgsLayerTreeNode *node ) const;

‎src/gui/layertree/qgslayertreeviewindicator.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/***************************************************************************
22
qgslayertreeviewindicator.cpp
33
--------------------------------------
4-
Date : Januray 2018
4+
Date : January 2018
55
Copyright : (C) 2018 by Martin Dobias
66
Email : wonder dot sk at gmail dot com
77
***************************************************************************

‎src/gui/layertree/qgslayertreeviewindicator.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/***************************************************************************
22
qgslayertreeviewindicator.h
33
--------------------------------------
4-
Date : Januray 2018
4+
Date : January 2018
55
Copyright : (C) 2018 by Martin Dobias
66
Email : wonder dot sk at gmail dot com
77
***************************************************************************
@@ -36,6 +36,7 @@ class GUI_EXPORT QgsLayerTreeViewIndicator : public QObject
3636
{
3737
Q_OBJECT
3838
public:
39+
//! Constructs an indicator, optionally transferring ownership to a parent QObject
3940
explicit QgsLayerTreeViewIndicator( QObject *parent SIP_TRANSFERTHIS = nullptr );
4041

4142
//! Indicator icon that will be displayed in the layer tree view

‎src/gui/layertree/qgslayertreeviewitemdelegate.cpp

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/***************************************************************************
22
qgslayertreeviewitemdelegate.cpp
33
--------------------------------------
4-
Date : Januray 2018
4+
Date : January 2018
55
Copyright : (C) 2018 by Martin Dobias
66
Email : wonder dot sk at gmail dot com
77
***************************************************************************
@@ -22,6 +22,7 @@
2222
#include <QHelpEvent>
2323
#include <QToolTip>
2424

25+
/// @cond PRIVATE
2526

2627
QgsLayerTreeViewProxyStyle::QgsLayerTreeViewProxyStyle( QgsLayerTreeView *treeView )
2728
: mLayerTreeView( treeView )
@@ -166,3 +167,5 @@ void QgsLayerTreeViewItemDelegate::onClicked( const QModelIndex &index )
166167
emit indicators[indicatorIndex]->clicked( index );
167168
}
168169
}
170+
171+
/// @endcond

‎src/gui/layertree/qgslayertreeviewitemdelegate.h

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/***************************************************************************
22
qgslayertreeviewitemdelegate.h
33
--------------------------------------
4-
Date : Januray 2018
4+
Date : January 2018
55
Copyright : (C) 2018 by Martin Dobias
66
Email : wonder dot sk at gmail dot com
77
***************************************************************************
@@ -16,6 +16,10 @@
1616
#ifndef QGSLAYERTREEVIEWITEMDELEGATE_H
1717
#define QGSLAYERTREEVIEWITEMDELEGATE_H
1818

19+
#include "qgis_sip.h"
20+
21+
SIP_NO_FILE
22+
1923
/// @cond PRIVATE
2024

2125
//

0 commit comments

Comments
 (0)