Class: QgsLocatorWidget¶
-
class
qgis.gui.
QgsLocatorWidget
(parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QWidget
Constructor for QgsLocatorWidget.
A special locator widget which allows searching for matching results from a QgsLocator and presenting them to users for selection.
See also
New in version 3.0.
- Parameters
parent –
-
actionEvent
()¶
-
changeEvent
()¶
-
childEvent
()¶
-
closeEvent
()¶
-
configTriggered
¶ Emitted when the configure option is triggered in the widget. [signal]
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
create
()¶
-
customEvent
()¶
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
enterEvent
()¶
-
event
()¶
-
eventFilter
(self, obj: QObject, event: QEvent) → bool¶ - Parameters
obj (QObject) –
event (QEvent) –
- Return type
bool
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideEvent
()¶
-
initPainter
()¶
-
inputMethodEvent
()¶
-
invalidateResults
(self)¶ Invalidates the current search results, e.g. as a result of changes to the locator filter settings.
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
leaveEvent
()¶
-
locator
(self) → QgsLocator¶ Returns a pointer to the locator utilized by this widget.
- Return type
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
paintEvent
()¶
-
receivers
()¶
-
resizeEvent
()¶
-
search
(self, string: str)¶ Triggers the locator widget to focus, open and start searching for a specified
string
.- Parameters
string (str) –
-
sender
()¶
-
senderSignalIndex
()¶
-
setMapCanvas
(self, canvas: QgsMapCanvas)¶ Sets a map
canvas
to associate with the widget. This allows the widget to customize the searches performed by its locator(), such as prioritizing results which are near the current canvas extent.- Parameters
canvas (QgsMapCanvas) –
-
showEvent
()¶
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wheelEvent
()¶