docs: Add documentation for orangecanvas.document.interactions

biolab · Dec 29, 2020 · 7f91319 · 7f91319
1 parent f0a8d99
commit 7f91319
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 0 deletions.
diff --git a/docs/source/orangecanvas/document.interactions.rst b/docs/source/orangecanvas/document.interactions.rst
@@ -0,0 +1,52 @@
+==================================
+Interactions (:mod:`interactions`)
+==================================
+
+.. automodule:: orangecanvas.document.interactions
+
+
+.. autoclass:: UserInteraction
+   :members:
+   :exclude-members:
+      started,
+      finished,
+      ended,
+      canceled
+   :member-order: bysource
+   :show-inheritance:
+
+   .. automethod:: started()
+
+   .. automethod:: finished()
+
+   .. automethod:: ended()
+
+   .. automethod:: canceled()
+
+
+.. autoclass:: DropAction
+   :members:
+   :member-order: bysource
+   :show-inheritance:
+
+
+.. autoclass:: DropHandler
+   :members:
+   :member-order: bysource
+   :show-inheritance:
+
+
+.. autoclass:: DropHandlerAction
+   :members:
+   :member-order: bysource
+   :show-inheritance:
+
+.. autoclass:: NodeFromMimeDataDropHandler
+   :members:
+   :member-order: bysource
+   :show-inheritance:
+
+.. autoclass:: PluginDropHandler
+   :members:
+   :member-order: bysource
+   :show-inheritance:
diff --git a/docs/source/orangecanvas/document.rst b/docs/source/orangecanvas/document.rst
@@ -9,3 +9,4 @@ Document (``document``)
 
    document.schemeedit
    document.quickmenu
+   document.interactions
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,3 +9,4 @@ Document (``document``)

		document.schemeedit
		document.quickmenu
		document.interactions