Skip to content

Commit

Permalink
Add missing docs, sip bindings
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed May 17, 2017
1 parent 1174b33 commit 376d6b3
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 0 deletions.
1 change: 1 addition & 0 deletions python/gui/gui.sip
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@

%Include locator/qgslocator.sip
%Include locator/qgslocatorfilter.sip
%Include locator/qgslocatorwidget.sip

%Include raster/qgsmultibandcolorrendererwidget.sip
%Include raster/qgspalettedrendererwidget.sip
Expand Down
3 changes: 3 additions & 0 deletions python/gui/locator/qgslocatorfilter.sip
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ class QgsLocatorResult
public:

QgsLocatorResult();
%Docstring
Constructor for QgsLocatorResult.
%End

QgsLocatorResult( QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData = QVariant() );
%Docstring
Expand Down
62 changes: 62 additions & 0 deletions python/gui/locator/qgslocatorwidget.sip
Original file line number Diff line number Diff line change
@@ -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 *
************************************************************************/
3 changes: 3 additions & 0 deletions src/gui/locator/qgslocatorfilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ class GUI_EXPORT QgsLocatorResult
{
public:

/**
* Constructor for QgsLocatorResult.
*/
QgsLocatorResult() = default;

/**
Expand Down
5 changes: 5 additions & 0 deletions src/gui/locator/qgslocatorwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ class GUI_EXPORT QgsLocatorWidget : public QWidget

};

#ifndef SIP_RUN

///@cond PRIVATE

/**
Expand Down Expand Up @@ -175,6 +177,9 @@ class QgsLocatorResultsView : public QTreeView

///@endcond

#endif


#endif // QGSLOCATORWIDGET_H


0 comments on commit 376d6b3

Please sign in to comment.