mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
96 lines
2.7 KiB
Plaintext
96 lines
2.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/locator/qgslocatorwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsLocatorWidget : QWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A special locator widget which allows searching for matching results from a :py:class:`QgsLocator`
|
|
and presenting them to users for selection.
|
|
|
|
.. seealso:: :py:class:`QgsLocator`
|
|
%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.
|
|
%End
|
|
|
|
void setMapCanvas( QgsMapCanvas *canvas );
|
|
%Docstring
|
|
Sets a map ``canvas`` to associate with the widget. This allows the
|
|
widget to customize the searches performed by its :py:func:`~QgsLocatorWidget.locator`, such
|
|
as prioritizing results which are near the current canvas extent.
|
|
%End
|
|
|
|
void setPlaceholderText( const QString &text );
|
|
%Docstring
|
|
Set placeholder ``text`` for the line edit.
|
|
|
|
.. versionadded:: 3.36
|
|
%End
|
|
|
|
void setResultContainerAnchors( QgsFloatingWidget::AnchorPoint anchorPoint, QgsFloatingWidget::AnchorPoint anchorWidgetPoint );
|
|
%Docstring
|
|
Sets the result container ``anchorPoint`` and ``anchorWidgetPoint`` position.
|
|
|
|
.. versionadded:: 3.36
|
|
%End
|
|
|
|
public slots:
|
|
|
|
void search( const QString &string );
|
|
%Docstring
|
|
Triggers the locator widget to focus, open and start searching for a specified ``string``.
|
|
%End
|
|
|
|
void invalidateResults();
|
|
%Docstring
|
|
Invalidates the current search results, e.g. as a result of changes to the locator
|
|
filter settings.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void configTriggered();
|
|
%Docstring
|
|
Emitted when the configure option is triggered in the widget.
|
|
%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.py again *
|
|
************************************************************************/
|