Skip to content
Permalink
Browse files

give a few references in QgisInterface API docs

  • Loading branch information
3nids committed Oct 23, 2018
1 parent 1bcd306 commit 0b22508fe67d6ed63e8e88da10bffc002e5dc6b4
Showing with 24 additions and 0 deletions.
  1. +16 −0 python/gui/auto_generated/qgisinterface.sip.in
  2. +8 −0 src/gui/qgisinterface.h
@@ -969,6 +969,8 @@ Register a new tab in the vector layer properties dialog.
Ownership of the factory is not transferred, and the factory must
be unregistered when plugin is unloaded.

.. seealso:: :py:class:`QgsMapLayerConfigWidgetFactory`

.. seealso:: :py:func:`unregisterMapLayerConfigWidgetFactory`

.. versionadded:: 2.16
@@ -978,6 +980,8 @@ Register a new tab in the vector layer properties dialog.
%Docstring
Unregister a previously registered tab in the vector layer properties dialog.

.. seealso:: :py:class:`QgsMapLayerConfigWidgetFactory`

.. seealso:: :py:func:`registerMapLayerConfigWidgetFactory`

.. versionadded:: 2.16
@@ -992,6 +996,8 @@ Register a new tab in the options dialog.
Ownership of the factory is not transferred, and the factory must
be unregistered when plugin is unloaded.

.. seealso:: :py:class:`QgsOptionsWidgetFactory`

.. seealso:: :py:func:`unregisterOptionsWidgetFactory`

.. versionadded:: 3.0
@@ -1001,6 +1007,8 @@ Register a new tab in the options dialog.
%Docstring
Unregister a previously registered tab in the options dialog.

.. seealso:: :py:class:`QgsOptionsWidgetFactory`

.. seealso:: :py:func:`registerOptionsWidgetFactory`

.. versionadded:: 3.0
@@ -1015,6 +1023,8 @@ Register a new custom drop handler.
Ownership of the factory is not transferred, and the factory must
be unregistered when plugin is unloaded.

.. seealso:: :py:class:`QgsCustomDropHandler`

.. seealso:: :py:func:`unregisterCustomDropHandler`

.. versionadded:: 3.0
@@ -1024,6 +1034,8 @@ Register a new custom drop handler.
%Docstring
Unregister a previously registered custom drop handler.

.. seealso:: :py:class:`QgsCustomDropHandler`

.. seealso:: :py:func:`registerCustomDropHandler`

.. versionadded:: 3.0
@@ -1038,6 +1050,8 @@ Register a new custom drop ``handler`` for layout windows.
Ownership of the factory is not transferred, and the factory must
be unregistered when plugin is unloaded.

.. seealso:: :py:class:`QgsLayoutCustomDropHandler`

.. seealso:: :py:func:`unregisterCustomLayoutDropHandler`

.. versionadded:: 3.0
@@ -1047,6 +1061,8 @@ Register a new custom drop ``handler`` for layout windows.
%Docstring
Unregister a previously registered custom drop ``handler`` for layout windows.

.. seealso:: :py:class:`QgsLayoutCustomDropHandler`

.. seealso:: :py:func:`registerCustomLayoutDropHandler`

.. versionadded:: 3.0
@@ -816,13 +816,15 @@ class GUI_EXPORT QgisInterface : public QObject
* Register a new tab in the vector layer properties dialog.
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* \see QgsMapLayerConfigWidgetFactory
* \see unregisterMapLayerConfigWidgetFactory()
* \since QGIS 2.16
*/
virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;

/**
* Unregister a previously registered tab in the vector layer properties dialog.
* \see QgsMapLayerConfigWidgetFactory
* \see registerMapLayerConfigWidgetFactory()
* \since QGIS 2.16
*/
@@ -832,13 +834,15 @@ class GUI_EXPORT QgisInterface : public QObject
* Register a new tab in the options dialog.
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* \see QgsOptionsWidgetFactory
* \see unregisterOptionsWidgetFactory()
* \since QGIS 3.0
*/
virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0;

/**
* Unregister a previously registered tab in the options dialog.
* \see QgsOptionsWidgetFactory
* \see registerOptionsWidgetFactory()
* \since QGIS 3.0
*/
@@ -848,13 +852,15 @@ class GUI_EXPORT QgisInterface : public QObject
* Register a new custom drop handler.
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* \see QgsCustomDropHandler
* \see unregisterCustomDropHandler()
* \since QGIS 3.0
*/
virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0;

/**
* Unregister a previously registered custom drop handler.
* \see QgsCustomDropHandler
* \see registerCustomDropHandler()
* \since QGIS 3.0
*/
@@ -864,13 +870,15 @@ class GUI_EXPORT QgisInterface : public QObject
* Register a new custom drop \a handler for layout windows.
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* \see QgsLayoutCustomDropHandler
* \see unregisterCustomLayoutDropHandler()
* \since QGIS 3.0
*/
virtual void registerCustomLayoutDropHandler( QgsLayoutCustomDropHandler *handler ) = 0;

/**
* Unregister a previously registered custom drop \a handler for layout windows.
* \see QgsLayoutCustomDropHandler
* \see registerCustomLayoutDropHandler()
* \since QGIS 3.0
*/

0 comments on commit 0b22508

Please sign in to comment.
You can’t perform that action at this time.