Skip to content

Commit 376d6b3

Browse files
committedMay 17, 2017
Add missing docs, sip bindings
1 parent 1174b33 commit 376d6b3

File tree

5 files changed

+74
-0
lines changed

5 files changed

+74
-0
lines changed
 

‎python/gui/gui.sip

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@
213213

214214
%Include locator/qgslocator.sip
215215
%Include locator/qgslocatorfilter.sip
216+
%Include locator/qgslocatorwidget.sip
216217

217218
%Include raster/qgsmultibandcolorrendererwidget.sip
218219
%Include raster/qgspalettedrendererwidget.sip

‎python/gui/locator/qgslocatorfilter.sip

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ class QgsLocatorResult
2323
public:
2424

2525
QgsLocatorResult();
26+
%Docstring
27+
Constructor for QgsLocatorResult.
28+
%End
2629

2730
QgsLocatorResult( QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData = QVariant() );
2831
%Docstring
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/gui/locator/qgslocatorwidget.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
12+
13+
class QgsLocatorWidget : QWidget
14+
{
15+
%Docstring
16+
A special locator widget which allows searching for matching results from a QgsLocator
17+
and presenting them to users for selection.
18+
.. seealso:: QgsLocator
19+
.. versionadded:: 3.0
20+
%End
21+
22+
%TypeHeaderCode
23+
#include "qgslocatorwidget.h"
24+
%End
25+
public:
26+
27+
QgsLocatorWidget( QWidget *parent /TransferThis/ = 0 );
28+
%Docstring
29+
Constructor for QgsLocatorWidget.
30+
%End
31+
32+
QgsLocator *locator();
33+
%Docstring
34+
Returns a pointer to the locator utilized by this widget.
35+
:rtype: QgsLocator
36+
%End
37+
38+
public slots:
39+
40+
void search( const QString &string );
41+
%Docstring
42+
Triggers the locator widget to focus, open and start searching for a specified ``string``.
43+
%End
44+
45+
protected:
46+
47+
virtual bool eventFilter( QObject *obj, QEvent *event );
48+
49+
50+
};
51+
52+
53+
54+
55+
56+
/************************************************************************
57+
* This file has been generated automatically from *
58+
* *
59+
* src/gui/locator/qgslocatorwidget.h *
60+
* *
61+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
62+
************************************************************************/

‎src/gui/locator/qgslocatorfilter.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ class GUI_EXPORT QgsLocatorResult
3737
{
3838
public:
3939

40+
/**
41+
* Constructor for QgsLocatorResult.
42+
*/
4043
QgsLocatorResult() = default;
4144

4245
/**

‎src/gui/locator/qgslocatorwidget.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ class GUI_EXPORT QgsLocatorWidget : public QWidget
9393

9494
};
9595

96+
#ifndef SIP_RUN
97+
9698
///@cond PRIVATE
9799

98100
/**
@@ -175,6 +177,9 @@ class QgsLocatorResultsView : public QTreeView
175177

176178
///@endcond
177179

180+
#endif
181+
182+
178183
#endif // QGSLOCATORWIDGET_H
179184

180185

0 commit comments

Comments
 (0)
Please sign in to comment.