Skip to content

Commit 3bdbf79

Browse files
committed
Clarify in the registerMapLayerPropertiesFactory docstring that the ownership of the factory is not transferred
1 parent 2297ade commit 3bdbf79

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

python/gui/qgisinterface.sip

+3-2
Original file line numberDiff line numberDiff line change
@@ -281,8 +281,9 @@ class QgisInterface : QObject
281281

282282
/** Register a new tab in the vector layer properties dialog.
283283
* @note added in QGIS 2.16
284-
* @see unregisterMapLayerPropertiesFactory()
285-
*/
284+
* @note Ownership of the factory is not transferred, and the factory must
285+
* be unregistered when plugin is unloaded.
286+
* @see unregisterMapLayerPropertiesFactory() */
286287
virtual void registerMapLayerPropertiesFactory( QgsMapLayerPropertiesFactory* factory ) = 0;
287288

288289
/** Unregister a previously registered tab in the vector layer properties dialog.

src/app/qgisappinterface.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -290,8 +290,9 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
290290

291291
/** Register a new tab in the vector layer properties dialog.
292292
* @note added in QGIS 2.16
293-
* @see unregisterMapLayerPropertiesFactory()
294-
*/
293+
* @note Ownership of the factory is not transferred, and the factory must
294+
* be unregistered when plugin is unloaded.
295+
* @see unregisterMapLayerPropertiesFactory() */
295296
virtual void registerMapLayerPropertiesFactory( QgsMapLayerPropertiesFactory* factory ) override;
296297

297298
/** Unregister a previously registered tab in the vector layer properties dialog.

src/gui/qgisinterface.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -331,8 +331,9 @@ class GUI_EXPORT QgisInterface : public QObject
331331

332332
/** Register a new tab in the vector layer properties dialog.
333333
* @note added in QGIS 2.16
334-
* @see unregisterMapLayerPropertiesFactory()
335-
*/
334+
* @note Ownership of the factory is not transferred, and the factory must
335+
* be unregistered when plugin is unloaded.
336+
* @see unregisterMapLayerPropertiesFactory() */
336337
virtual void registerMapLayerPropertiesFactory( QgsMapLayerPropertiesFactory* factory ) = 0;
337338

338339
/** Unregister a previously registered tab in the vector layer properties dialog.

0 commit comments

Comments
 (0)