From 65a19c7a78c9a4b844f6435b921e1c225e4114a9 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Tue, 7 Nov 2023 07:43:23 +1000 Subject: [PATCH] Fix documentation format of QgsCustomDropHandler --- python/gui/auto_generated/qgscustomdrophandler.sip.in | 6 +++--- src/gui/qgscustomdrophandler.h | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/python/gui/auto_generated/qgscustomdrophandler.sip.in b/python/gui/auto_generated/qgscustomdrophandler.sip.in index e646415c143..e7d875c148d 100644 --- a/python/gui/auto_generated/qgscustomdrophandler.sip.in +++ b/python/gui/auto_generated/qgscustomdrophandler.sip.in @@ -16,14 +16,14 @@ Abstract base class that may be implemented to handle new types of data to be dr Implementations have three approaches they can use to handle drops. -# The simplest approach is to implement :py:func:`~handeFileDrop` when they need to handle +- The simplest approach is to implement :py:func:`~handleFileDrop` when they need to handle dropped files (i.e. with mime type "text/uri-list"). -# Reimplement :py:func:`~handleCustomUriDrop` when they want to handle dropped custom +- Reimplement :py:func:`~handleCustomUriDrop` when they want to handle dropped custom :py:class:`QgsMimeDataUtils`.Uri entries, for instance handling dropping custom entries from the browser tree (with mime type "application/x-vnd.qgis.qgis.uri"). In this case the implementation's :py:func:`~customUriProviderKey` must match the uri entry's providerKey. -# Reimplement :py:func:`~handleMimeData` to directly handle dropped QMimeData. +- Reimplement :py:func:`~handleMimeData` to directly handle dropped QMimeData. Subclasses should take care when overriding this method. When a drop event occurs, Qt will lock the source application of the drag for the duration of the drop event handling via :py:func:`~handleMimeData` (e.g. dragging files from diff --git a/src/gui/qgscustomdrophandler.h b/src/gui/qgscustomdrophandler.h index e3ac6c890bd..1780e7bc93e 100644 --- a/src/gui/qgscustomdrophandler.h +++ b/src/gui/qgscustomdrophandler.h @@ -27,14 +27,14 @@ class QgsMapCanvas; * * Implementations have three approaches they can use to handle drops. * - * # The simplest approach is to implement handeFileDrop() when they need to handle + * - The simplest approach is to implement handleFileDrop() when they need to handle * dropped files (i.e. with mime type "text/uri-list"). - * # Reimplement handleCustomUriDrop() when they want to handle dropped custom + * - Reimplement handleCustomUriDrop() when they want to handle dropped custom * QgsMimeDataUtils::Uri entries, for instance handling dropping custom entries * from the browser tree (with mime type "application/x-vnd.qgis.qgis.uri"). In * this case the implementation's customUriProviderKey() must match the uri * entry's providerKey. - * # Reimplement handleMimeData() to directly handle dropped QMimeData. + * - Reimplement handleMimeData() to directly handle dropped QMimeData. * Subclasses should take care when overriding this method. When a drop event * occurs, Qt will lock the source application of the drag for the duration * of the drop event handling via handleMimeData() (e.g. dragging files from