Add missing docs, sip bindings

nyalldawson · nyalldawson · commit 376d6b3d085a · 2017-05-17T21:33:47.000+10:00
diff --git a/python/gui/gui.sip b/python/gui/gui.sip
@@ -213,6 +213,7 @@
 
 %Include locator/qgslocator.sip
 %Include locator/qgslocatorfilter.sip
+%Include locator/qgslocatorwidget.sip
 
 %Include raster/qgsmultibandcolorrendererwidget.sip
 %Include raster/qgspalettedrendererwidget.sip
diff --git a/python/gui/locator/qgslocatorfilter.sip b/python/gui/locator/qgslocatorfilter.sip
@@ -23,6 +23,9 @@ class QgsLocatorResult
   public:
 
     QgsLocatorResult();
+%Docstring
+ Constructor for QgsLocatorResult.
+%End
 
     QgsLocatorResult( QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData = QVariant() );
 %Docstring
diff --git a/python/gui/locator/qgslocatorwidget.sip b/python/gui/locator/qgslocatorwidget.sip
@@ -0,0 +1,62 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/locator/qgslocatorwidget.h                                   *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsLocatorWidget : QWidget
+{
+%Docstring
+ A special locator widget which allows searching for matching results from a QgsLocator
+ and presenting them to users for selection.
+.. seealso:: QgsLocator
+.. versionadded:: 3.0
+%End
+
+%TypeHeaderCode
+#include "qgslocatorwidget.h"
+%End
+  public:
+
+    QgsLocatorWidget( QWidget *parent /TransferThis/ = 0 );
+%Docstring
+ Constructor for QgsLocatorWidget.
+%End
+
+    QgsLocator *locator();
+%Docstring
+ Returns a pointer to the locator utilized by this widget.
+ :rtype: QgsLocator
+%End
+
+  public slots:
+
+    void search( const QString &string );
+%Docstring
+ Triggers the locator widget to focus, open and start searching for a specified ``string``.
+%End
+
+  protected:
+
+    virtual bool eventFilter( QObject *obj, QEvent *event );
+
+
+};
+
+
+
+
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/locator/qgslocatorwidget.h                                   *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/src/gui/locator/qgslocatorfilter.h b/src/gui/locator/qgslocatorfilter.h
@@ -37,6 +37,9 @@ class GUI_EXPORT QgsLocatorResult
 {
   public:
 
+    /**
+     * Constructor for QgsLocatorResult.
+     */
     QgsLocatorResult() = default;
 
     /**
diff --git a/src/gui/locator/qgslocatorwidget.h b/src/gui/locator/qgslocatorwidget.h
@@ -93,6 +93,8 @@ class GUI_EXPORT QgsLocatorWidget : public QWidget
 
 };
 
+#ifndef SIP_RUN
+
 ///@cond PRIVATE
 
 /**
@@ -175,6 +177,9 @@ class QgsLocatorResultsView : public QTreeView
 
 ///@endcond
 
+#endif
+
+
 #endif // QGSLOCATORWIDGET_H
 
 

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,9 @@ class GUI_EXPORT QgsLocatorResult`
`37`	`37`	`{`
`38`	`38`	`public:`
`39`	`39`
	`40`	`+ /**`
	`41`	`+ * Constructor for QgsLocatorResult.`
	`42`	`+ */`
`40`	`43`	`QgsLocatorResult() = default;`
`41`	`44`
`42`	`45`	`/**`