Add missing docs, sip bindings

This commit is contained in:
Nyall Dawson 2017-05-08 09:07:36 +10:00
parent 1174b335dc
commit 376d6b3d08
5 changed files with 74 additions and 0 deletions

View File

@ -213,6 +213,7 @@
%Include locator/qgslocator.sip
%Include locator/qgslocatorfilter.sip
%Include locator/qgslocatorwidget.sip
%Include raster/qgsmultibandcolorrendererwidget.sip
%Include raster/qgspalettedrendererwidget.sip

View File

@ -23,6 +23,9 @@ class QgsLocatorResult
public:
QgsLocatorResult();
%Docstring
Constructor for QgsLocatorResult.
%End
QgsLocatorResult( QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData = QVariant() );
%Docstring

View File

@ -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 *
************************************************************************/

View File

@ -37,6 +37,9 @@ class GUI_EXPORT QgsLocatorResult
{
public:
/**
* Constructor for QgsLocatorResult.
*/
QgsLocatorResult() = default;
/**

View File

@ -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