Skip to content

Commit 0b22508

Browse files
committed
give a few references in QgisInterface API docs
1 parent 1bcd306 commit 0b22508

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

python/gui/auto_generated/qgisinterface.sip.in

+16
Original file line numberDiff line numberDiff line change
@@ -969,6 +969,8 @@ Register a new tab in the vector layer properties dialog.
969969
Ownership of the factory is not transferred, and the factory must
970970
be unregistered when plugin is unloaded.
971971

972+
.. seealso:: :py:class:`QgsMapLayerConfigWidgetFactory`
973+
972974
.. seealso:: :py:func:`unregisterMapLayerConfigWidgetFactory`
973975

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

983+
.. seealso:: :py:class:`QgsMapLayerConfigWidgetFactory`
984+
981985
.. seealso:: :py:func:`registerMapLayerConfigWidgetFactory`
982986

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

999+
.. seealso:: :py:class:`QgsOptionsWidgetFactory`
1000+
9951001
.. seealso:: :py:func:`unregisterOptionsWidgetFactory`
9961002

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

1010+
.. seealso:: :py:class:`QgsOptionsWidgetFactory`
1011+
10041012
.. seealso:: :py:func:`registerOptionsWidgetFactory`
10051013

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

1026+
.. seealso:: :py:class:`QgsCustomDropHandler`
1027+
10181028
.. seealso:: :py:func:`unregisterCustomDropHandler`
10191029

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

1037+
.. seealso:: :py:class:`QgsCustomDropHandler`
1038+
10271039
.. seealso:: :py:func:`registerCustomDropHandler`
10281040

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

1053+
.. seealso:: :py:class:`QgsLayoutCustomDropHandler`
1054+
10411055
.. seealso:: :py:func:`unregisterCustomLayoutDropHandler`
10421056

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

1064+
.. seealso:: :py:class:`QgsLayoutCustomDropHandler`
1065+
10501066
.. seealso:: :py:func:`registerCustomLayoutDropHandler`
10511067

10521068
.. versionadded:: 3.0

src/gui/qgisinterface.h

+8
Original file line numberDiff line numberDiff line change
@@ -816,13 +816,15 @@ class GUI_EXPORT QgisInterface : public QObject
816816
* Register a new tab in the vector layer properties dialog.
817817
* \note Ownership of the factory is not transferred, and the factory must
818818
* be unregistered when plugin is unloaded.
819+
* \see QgsMapLayerConfigWidgetFactory
819820
* \see unregisterMapLayerConfigWidgetFactory()
820821
* \since QGIS 2.16
821822
*/
822823
virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0;
823824

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

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

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

872879
/**
873880
* Unregister a previously registered custom drop \a handler for layout windows.
881+
* \see QgsLayoutCustomDropHandler
874882
* \see registerCustomLayoutDropHandler()
875883
* \since QGIS 3.0
876884
*/

0 commit comments

Comments
 (0)