Skip to content

Commit f084fc0

Browse files
m-kuhnm-kuhn
committedNov 20, 2017
API documentation all over
·
ltr-3_40final-3_0_0
1 parent 3d2b69e commit f084fc0

19 files changed

+233
-97
lines changed
 

‎python/core/qgsaggregatecalculator.sip

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ class QgsAggregateCalculator
2828

2929
struct AggregateInfo
3030
{
31-
QString function;
32-
QString name;
33-
QSet<QVariant::Type> supportedTypes;
31+
QString function; //!< The expression function
32+
QString name; //!< A translated, human readable name
33+
QSet<QVariant::Type> supportedTypes; //!< This aggregate function can only be used with these datatypes
3434
};
3535

3636
enum Aggregate

‎python/gui/editorwidgets/core/qgssearchwidgetwrapper.sip

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,8 @@
6060
class QgsSearchWidgetWrapper : QgsWidgetWrapper
6161
{
6262
%Docstring
63-
Manages an editor widget
64-
Widget and wrapper share the same parent
6563

66-
A wrapper controls one attribute editor widget and is able to create a default
67-
widget or use a pre-existent widget. It is able to set the widget to the value implied
68-
by a field of a vector layer, or return the value it currently holds. Every time it is changed
69-
it has to emit a valueChanged signal. If it fails to do so, there is no guarantee that the
70-
changed status of the widget will be saved.
64+
Shows a search widget on a filter form.
7165
%End
7266

7367
%TypeHeaderCode
@@ -171,22 +165,30 @@ class QgsSearchWidgetWrapper : QgsWidgetWrapper
171165

172166
QString createFieldIdentifier() const;
173167
%Docstring
168+
Get a field name or expression to use as field comparison.
169+
If in SearchMode returns a quoted field identifier.
170+
If in AggregateSearchMode returns an appropriate aggregate expression.
171+
172+
.. versionadded:: 3.2
174173
:rtype: str
175174
%End
176175

177-
178-
179176
QString aggregate() const;
180177
%Docstring
178+
If in AggregateSearch mode, which aggregate should be used to construct
179+
the filter expression. Is a Null String if none.
180+
181+
.. versionadded:: 3.2
181182
:rtype: str
182183
%End
183-
void setAggregate( const QString &aggregate );
184184

185-
QgsRelation aggregateRelation() const;
185+
void setAggregate( const QString &aggregate );
186186
%Docstring
187-
:rtype: QgsRelation
187+
If in AggregateSearch mode, which aggregate should be used to construct
188+
the filter expression. Is a Null String if none.
189+
190+
.. versionadded:: 3.2
188191
%End
189-
void setAggregateRelation( const QgsRelation &aggregateRelation );
190192

191193
public slots:
192194

‎python/gui/editorwidgets/qgsrelationaggregatesearchwidgetwrapper.sip

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,23 @@
1313
class QgsRelationAggregateSearchWidgetWrapper : QgsSearchWidgetWrapper
1414
{
1515
%Docstring
16-
*************************************************************************
17-
qgsrelationaggregatesearchwidget.h
18-
-----------------------------
19-
Date : Nov 2017
20-
Copyright : (C) 2017 Matthias Kuhn
21-
Email : matthias@opengis.ch
22-
**************************************************************************
23-
*
24-
This program is free software; you can redistribute it and/or modify *
25-
it under the terms of the GNU General Public License as published by *
26-
the Free Software Foundation; either version 2 of the License, or *
27-
(at your option) any later version. *
28-
*
29-
**************************************************************************
16+
17+
Search widget for the children of a relation.
18+
For each attribute of the child, an additional QgsAggregateToolButton will be shown
19+
to determine how the values should be aggregated for searching.
20+
21+
.. versionadded:: 3.2
3022
%End
3123

3224
%TypeHeaderCode
3325
#include "qgsrelationaggregatesearchwidgetwrapper.h"
3426
%End
3527
public:
36-
explicit QgsRelationAggregateSearchWidgetWrapper( QgsVectorLayer *vl, QgsRelationWidgetWrapper *wrapper, QWidget *parent /TransferThis/ = 0 );
28+
29+
explicit QgsRelationAggregateSearchWidgetWrapper( QgsVectorLayer *layer, QgsRelationWidgetWrapper *wrapper, QWidget *parent /TransferThis/ = 0 );
30+
%Docstring
31+
Constructor
32+
%End
3733

3834
virtual QString expression() const;
3935

‎python/gui/editorwidgets/qgsrelationwidgetwrapper.sip

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ class QgsRelationWidgetWrapper : QgsWidgetWrapper
7373

7474
QgsRelation relation() const;
7575
%Docstring
76+
The relation for which this wrapper is created.
77+
78+
.. versionadded:: 3.2
7679
:rtype: QgsRelation
7780
%End
7881

‎python/gui/qgsaggregatetoolbutton.sip

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,50 +12,67 @@
1212
class QgsAggregateToolButton : QToolButton
1313
{
1414
%Docstring
15-
*************************************************************************
16-
qgsaggregatetoolbutton.h
17-
--------------------------------------
18-
Date : Nov 2017
19-
Copyright : (C) 2017 Matthias Kuhn
20-
Email : matthias@opengis.ch
21-
**************************************************************************
22-
*
23-
This program is free software; you can redistribute it and/or modify *
24-
it under the terms of the GNU General Public License as published by *
25-
the Free Software Foundation; either version 2 of the License, or *
26-
(at your option) any later version. *
27-
*
28-
**************************************************************************
15+
16+
Offers a toolbutton to choose between different aggregate functions.
17+
Functions are filtered based on the type.
18+
19+
.. versionadded:: 3.2
2920
%End
3021

3122
%TypeHeaderCode
3223
#include "qgsaggregatetoolbutton.h"
3324
%End
3425
public:
26+
3527
QgsAggregateToolButton();
28+
%Docstring
29+
Constructor
30+
%End
3631

3732
void setType( QVariant::Type type );
33+
%Docstring
34+
Based on the ``type`` of underlying data, some aggregates will be available or not.
35+
%End
3836

3937
QVariant::Type type() const;
4038
%Docstring
39+
Based on the ``type`` of underlying data, some aggregates will be available or not.
4140
:rtype: QVariant.Type
4241
%End
4342

4443
void setActive( bool active );
44+
%Docstring
45+
When this flag is false, the aggregate will be deactivated. I.e. no aggregate is chosen.
46+
%End
47+
4548
bool active() const;
4649
%Docstring
50+
When this flag is false, the aggregate will be deactivated. I.e. no aggregate is chosen.
4751
:rtype: bool
4852
%End
4953

5054
QString aggregate() const;
5155
%Docstring
56+
The function name of the selected aggregate or a Null String if none is chosen.
5257
:rtype: str
5358
%End
59+
5460
void setAggregate( const QString &aggregate );
61+
%Docstring
62+
The function name of the selected aggregate or a Null String if none is chosen.
63+
%End
5564

5665
signals:
66+
5767
void aggregateChanged();
68+
%Docstring
69+
The function name of the selected aggregate has changed.
70+
%End
71+
5872
void activeChanged();
73+
%Docstring
74+
A function has been selected or unselected.
75+
%End
5976

6077
};
6178

‎python/gui/qgsattributeform.sip

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,11 @@ class QgsAttributeForm : QWidget
126126

127127
QString aggregateFilter() const;
128128
%Docstring
129+
The aggregate filter is only useful if the form is in AggregateFilter mode.
130+
In this case it will return a combined expression according to the chosen filters
131+
on all attribute widgets.
132+
133+
.. versionadded:: 3.2
129134
:rtype: str
130135
%End
131136

‎python/gui/qgsattributeformrelationeditorwidget.sip

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,25 @@
99

1010

1111

12+
1213
class QgsAttributeFormRelationEditorWidget : QgsAttributeFormWidget
1314
{
1415
%Docstring
15-
*************************************************************************
16-
qgsattributeformrelationeditorwidget.h
17-
--------------------------------------
18-
Date : Nov 2017
19-
Copyright : (C) 2017 Matthias Kuhn
20-
Email : matthias@opengis.ch
21-
**************************************************************************
22-
*
23-
This program is free software; you can redistribute it and/or modify *
24-
it under the terms of the GNU General Public License as published by *
25-
the Free Software Foundation; either version 2 of the License, or *
26-
(at your option) any later version. *
27-
*
28-
**************************************************************************
16+
17+
Widget to show for child relations on an attribute form.
18+
19+
.. versionadded:: 3.2
2920
%End
3021

3122
%TypeHeaderCode
3223
#include "qgsattributeformrelationeditorwidget.h"
3324
%End
3425
public:
26+
3527
explicit QgsAttributeFormRelationEditorWidget( QgsRelationWidgetWrapper *wrapper, QgsAttributeForm *form );
28+
%Docstring
29+
Constructor
30+
%End
3631

3732
virtual void createSearchWidgetWrappers();
3833
virtual QString currentFilterExpression() const;

‎python/gui/qgsattributeformwidget.sip

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@
1111

1212
class QgsAttributeFormWidget : QWidget /Abstract/
1313
{
14+
%Docstring
15+
16+
Base class for all widgets shown on a QgsAttributeForm.
17+
Consists of the widget which is visible in edit mode as well as the widget visible in search mode.
18+
19+
.. versionadded:: 3.2
20+
%End
1421

1522
%TypeHeaderCode
1623
#include "qgsattributeformwidget.h"
@@ -61,11 +68,13 @@ class QgsAttributeFormWidget : QWidget /Abstract/
6168

6269
QgsVectorLayer *layer();
6370
%Docstring
71+
The layer for which this widget and its form is shown.
6472
:rtype: QgsVectorLayer
6573
%End
6674

6775
QgsAttributeForm *form() const;
6876
%Docstring
77+
The form on which this widget is shown.
6978
:rtype: QgsAttributeForm
7079
%End
7180

@@ -108,15 +117,7 @@ class QgsAttributeFormWidget : QWidget /Abstract/
108117

109118

110119

111-
QgsSearchWidgetToolButton *searchWidgetToolButton();
112-
%Docstring
113-
Returns a pointer to the search widget tool button in the widget.
114-
.. note::
115120

116-
this method is in place for unit testing only, and is not considered
117-
stable API
118-
:rtype: QgsSearchWidgetToolButton
119-
%End
120121

121122
};
122123

‎src/core/qgsaggregatecalculator.h

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,16 @@ class CORE_EXPORT QgsAggregateCalculator
4343
{
4444
public:
4545

46+
/**
47+
* Structured information about the available aggregates.
48+
*
49+
* \since QGIS 3.0
50+
*/
4651
struct AggregateInfo
4752
{
48-
QString function;
49-
QString name;
50-
QSet<QVariant::Type> supportedTypes;
53+
QString function; //!< The expression function
54+
QString name; //!< A translated, human readable name
55+
QSet<QVariant::Type> supportedTypes; //!< This aggregate function can only be used with these datatypes
5156
};
5257

5358
/**

‎src/gui/editorwidgets/core/qgssearchwidgetwrapper.cpp

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,6 @@ void QgsSearchWidgetWrapper::clearExpression()
119119
mExpression = QStringLiteral( "TRUE" );
120120
}
121121

122-
QgsRelation QgsSearchWidgetWrapper::aggregateRelation() const
123-
{
124-
return mAggregateRelation;
125-
}
126-
127-
void QgsSearchWidgetWrapper::setAggregateRelation( const QgsRelation &aggregateRelation )
128-
{
129-
mAggregateRelation = aggregateRelation;
130-
}
131-
132122
QString QgsSearchWidgetWrapper::aggregate() const
133123
{
134124
return mAggregate;

‎src/gui/editorwidgets/core/qgssearchwidgetwrapper.h

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,8 @@ class QgsField;
7979

8080
/**
8181
* \ingroup gui
82-
* Manages an editor widget
83-
* Widget and wrapper share the same parent
8482
*
85-
* A wrapper controls one attribute editor widget and is able to create a default
86-
* widget or use a pre-existent widget. It is able to set the widget to the value implied
87-
* by a field of a vector layer, or return the value it currently holds. Every time it is changed
88-
* it has to emit a valueChanged signal. If it fails to do so, there is no guarantee that the
89-
* changed status of the widget will be saved.
83+
* Shows a search widget on a filter form.
9084
*/
9185
class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper
9286
{
@@ -188,15 +182,30 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper
188182
// TODO QGIS 3.0 - make pure virtual
189183
virtual QString createExpression( FilterFlags flags ) const { Q_UNUSED( flags ); return QStringLiteral( "TRUE" ); }
190184

185+
/**
186+
* Get a field name or expression to use as field comparison.
187+
* If in SearchMode returns a quoted field identifier.
188+
* If in AggregateSearchMode returns an appropriate aggregate expression.
189+
*
190+
* \since QGIS 3.2
191+
*/
191192
QString createFieldIdentifier() const;
192193

193-
194-
194+
/**
195+
* If in AggregateSearch mode, which aggregate should be used to construct
196+
* the filter expression. Is a Null String if none.
197+
*
198+
* \since QGIS 3.2
199+
*/
195200
QString aggregate() const;
196-
void setAggregate( const QString &aggregate );
197201

198-
QgsRelation aggregateRelation() const;
199-
void setAggregateRelation( const QgsRelation &aggregateRelation );
202+
/**
203+
* If in AggregateSearch mode, which aggregate should be used to construct
204+
* the filter expression. Is a Null String if none.
205+
*
206+
* \since QGIS 3.2
207+
*/
208+
void setAggregate( const QString &aggregate );
200209

201210
public slots:
202211

‎src/gui/editorwidgets/qgsrelationaggregatesearchwidgetwrapper.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
#include "qgsrelationaggregatesearchwidgetwrapper.h"
1818
#include "qgsattributeform.h"
1919
#include "qgsrelationwidgetwrapper.h"
20+
#include "qgslogger.h"
2021

2122
#include <QLabel>
2223

@@ -57,5 +58,6 @@ bool QgsRelationAggregateSearchWidgetWrapper::applyDirectly()
5758

5859
void QgsRelationAggregateSearchWidgetWrapper::setExpression( const QString &value )
5960
{
60-
61+
Q_UNUSED( value )
62+
QgsDebugMsg( "Not supported" );
6163
}

‎src/gui/editorwidgets/qgsrelationaggregatesearchwidgetwrapper.h

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,25 @@
2323

2424
class QgsRelationWidgetWrapper;
2525

26+
/**
27+
* \ingroup gui
28+
*
29+
* Search widget for the children of a relation.
30+
* For each attribute of the child, an additional QgsAggregateToolButton will be shown
31+
* to determine how the values should be aggregated for searching.
32+
*
33+
* \since QGIS 3.2
34+
*/
2635
class GUI_EXPORT QgsRelationAggregateSearchWidgetWrapper : public QgsSearchWidgetWrapper
2736
{
2837
Q_OBJECT
2938

3039
public:
31-
explicit QgsRelationAggregateSearchWidgetWrapper( QgsVectorLayer *vl, QgsRelationWidgetWrapper *wrapper, QWidget *parent SIP_TRANSFERTHIS = 0 );
40+
41+
/**
42+
* Constructor
43+
*/
44+
explicit QgsRelationAggregateSearchWidgetWrapper( QgsVectorLayer *layer, QgsRelationWidgetWrapper *wrapper, QWidget *parent SIP_TRANSFERTHIS = 0 );
3245

3346
virtual QString expression() const override;
3447

‎src/gui/editorwidgets/qgsrelationwidgetwrapper.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper
7979
*/
8080
void setShowUnlinkButton( bool showUnlinkButton );
8181

82+
/**
83+
* The relation for which this wrapper is created.
84+
*
85+
* \since QGIS 3.2
86+
*/
8287
QgsRelation relation() const;
8388

8489
protected:

‎src/gui/qgsaggregatetoolbutton.h

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,65 @@
2222
#include "qgsaggregatecalculator.h"
2323
#include "qgis_gui.h"
2424

25+
/**
26+
* \ingroup gui
27+
*
28+
* Offers a toolbutton to choose between different aggregate functions.
29+
* Functions are filtered based on the type.
30+
*
31+
* \since QGIS 3.2
32+
*/
2533
class GUI_EXPORT QgsAggregateToolButton : public QToolButton
2634
{
2735
Q_OBJECT
2836

2937
public:
38+
39+
/**
40+
* Constructor
41+
*/
3042
QgsAggregateToolButton();
3143

44+
/**
45+
* Based on the \a type of underlying data, some aggregates will be available or not.
46+
*/
3247
void setType( QVariant::Type type );
3348

49+
/**
50+
* Based on the \a type of underlying data, some aggregates will be available or not.
51+
*/
3452
QVariant::Type type() const;
3553

54+
/**
55+
* When this flag is false, the aggregate will be deactivated. I.e. no aggregate is chosen.
56+
*/
3657
void setActive( bool active );
58+
59+
/**
60+
* When this flag is false, the aggregate will be deactivated. I.e. no aggregate is chosen.
61+
*/
3762
bool active() const;
3863

64+
/**
65+
* The function name of the selected aggregate or a Null String if none is chosen.
66+
*/
3967
QString aggregate() const;
68+
69+
/**
70+
* The function name of the selected aggregate or a Null String if none is chosen.
71+
*/
4072
void setAggregate( const QString &aggregate );
4173

4274
signals:
75+
76+
/**
77+
* The function name of the selected aggregate has changed.
78+
*/
4379
void aggregateChanged();
80+
81+
/**
82+
* A function has been selected or unselected.
83+
*/
4484
void activeChanged();
4585

4686
private slots:

‎src/gui/qgsattributeform.h

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
5454
will add a new feature when the form is accepted. */
5555
MultiEditMode, //!< Multi edit mode, for editing fields of multiple features at once
5656
SearchMode, //!< Form values are used for searching/filtering the layer
57-
AggregateSearchMode,
57+
AggregateSearchMode, //!< Form is in aggregate search mode, show each widget in this mode \since QGIS 3.2
5858
};
5959

6060
//! Filter types
@@ -161,6 +161,13 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
161161
*/
162162
void setMessageBar( QgsMessageBar *messageBar );
163163

164+
/**
165+
* The aggregate filter is only useful if the form is in AggregateFilter mode.
166+
* In this case it will return a combined expression according to the chosen filters
167+
* on all attribute widgets.
168+
*
169+
* \since QGIS 3.2
170+
*/
164171
QString aggregateFilter() const;
165172

166173
signals:

‎src/gui/qgsattributeformrelationeditorwidget.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ QgsAttributeFormRelationEditorWidget::QgsAttributeFormRelationEditorWidget( QgsR
2727

2828
void QgsAttributeFormRelationEditorWidget::createSearchWidgetWrappers( const QgsAttributeEditorContext &context )
2929
{
30+
Q_UNUSED( context )
3031
mSearchWidget = new QgsRelationAggregateSearchWidgetWrapper( layer(), mWrapper, form() );
3132

3233
setSearchWidgetWrapper( mSearchWidget );

‎src/gui/qgsattributeformrelationeditorwidget.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,23 @@
2222
class QgsRelationWidgetWrapper;
2323
class QgsRelationAggregateSearchWidgetWrapper;
2424

25+
26+
/**
27+
* \ingroup gui
28+
*
29+
* Widget to show for child relations on an attribute form.
30+
*
31+
* \since QGIS 3.2
32+
*/
2533
class GUI_EXPORT QgsAttributeFormRelationEditorWidget : public QgsAttributeFormWidget
2634
{
2735
Q_OBJECT
2836

2937
public:
38+
39+
/**
40+
* Constructor
41+
*/
3042
explicit QgsAttributeFormRelationEditorWidget( QgsRelationWidgetWrapper *wrapper, QgsAttributeForm *form );
3143

3244
virtual void createSearchWidgetWrappers( const QgsAttributeEditorContext &context SIP_PYARGREMOVE = QgsAttributeEditorContext() ) override;

‎src/gui/qgsattributeformwidget.h

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ class QgsAttributeForm;
1313
class QStackedWidget;
1414
class QgsSearchWidgetToolButton;
1515

16+
/**
17+
* \ingroup gui
18+
*
19+
* Base class for all widgets shown on a QgsAttributeForm.
20+
* Consists of the widget which is visible in edit mode as well as the widget visible in search mode.
21+
*
22+
* \since QGIS 3.2
23+
*/
1624
class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
1725
{
1826
Q_OBJECT
@@ -25,7 +33,7 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
2533
DefaultMode, //!< Default mode, only the editor widget is shown
2634
MultiEditMode, //!< Multi edit mode, both the editor widget and a QgsMultiEditToolButton is shown
2735
SearchMode, //!< Layer search/filter mode
28-
AggregateSearchMode,
36+
AggregateSearchMode, //!< Embedded in a search form, show additional aggregate function toolbutton
2937
};
3038

3139
explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
@@ -60,8 +68,14 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
6068
*/
6169
Mode mode() const { return mMode; }
6270

71+
/**
72+
* The layer for which this widget and its form is shown.
73+
*/
6374
QgsVectorLayer *layer();
6475

76+
/**
77+
* The form on which this widget is shown.
78+
*/
6579
QgsAttributeForm *form() const;
6680

6781
/**
@@ -100,18 +114,37 @@ class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
100114
void resetSearch();
101115

102116
protected:
117+
118+
/**
119+
* Returns a pointer to the EDIT page widget.
120+
* \note this method is in place for unit testing only, and is not considered
121+
* stable API
122+
* \note not available in Python bindings
123+
*/
103124
QWidget *editPage() const SIP_SKIP;
104125

126+
/**
127+
* Returns a pointer to the stacked widget managing edit and search page.
128+
* \note this method is in place for unit testing only, and is not considered
129+
* stable API
130+
* \note not available in Python bindings
131+
*/
105132
QStackedWidget *stack() const SIP_SKIP;
106133

134+
/**
135+
* Returns a pointer to the search page widget.
136+
* \note this method is in place for unit testing only, and is not considered
137+
* stable API
138+
* \note not available in Python bindings
139+
*/
107140
QWidget *searchPage() const SIP_SKIP;
108141

109142
/**
110143
* Returns a pointer to the search widget tool button in the widget.
111144
* \note this method is in place for unit testing only, and is not considered
112145
* stable API
113146
*/
114-
QgsSearchWidgetToolButton *searchWidgetToolButton();
147+
QgsSearchWidgetToolButton *searchWidgetToolButton() SIP_SKIP;
115148

116149
private slots:
117150

0 commit comments

Comments
 (0)
Please sign in to comment.