.. meta::
    :description: Extensions Plugin

Plugins
=======

This section explains how to create and edit plugins.

.. _filesLocationPluginExtension:

Files location
--------------

To be recognized by the application, plugins should be located in one of these folders:

- %LocalAppData%/ORS/Dragonfly(*version*)/pythonUserExtensions/Plugins (available for the current user)
- %ProgramData%/ORS/Dragonfly(*version*)/pythonAllUsersExtensions/Plugins (available for all users)
- %ProgramData%/ORS/Dragonfly(*version*)/python/OrsPythonPlugins (distributed with the application)

.. note::
    All the mandatory files defining a plugin should be contained in a folder having the same name as the
    plugin implementation file and the implementation class.
    For example, a simple plugin named ``ASimplePlugin`` would be constituted of these files:

    - %LocalAppData%/ORS/Dragonfly(*version*)/pythonUserExtensions/Plugins/ASimplePlugin/__init__.py
    - %LocalAppData%/ORS/Dragonfly(*version*)/pythonUserExtensions/Plugins/ASimplePlugin/ASimplePlugin.py

    See :ref:`extensionFiles` for more information on the purpose of each file.

File creation
-------------
To create a plugin, start the application,
start the :mod:`OrsPythonPlugins.OrsPluginGenerator.OrsPluginGenerator`
(found in *Developer/Python Plugin Generator*),
fill in the required fields in the different tabs and press the button *Create plugin*.

See :ref:`pluginElements` for more information on the elements of a plugin.

File edition
------------
**Design the UI**

If a UI is used, design it in the generated *.ui* file(s).

See :ref:`howtodevelopui` for more information.

**Develop the code**

Open the implementation file (the Python file having the name of the plugin) in a text editor.
Fill in the required methods.

Demos
-----

- :ref:`Interface methods basic structure <sourcecodeexample_plugin_DemoBasicStructureInterfaceMethod_a86f77ae9e0511e7904d448a5b5d70c0>`
- :ref:`Interface methods input as list <sourcecodeexample_plugin_DemoInputAsListInterfaceMethod_a7cdee2e9e1811e79308448a5b5d70c0>`
- :ref:`Interface methods multiple outputs <sourcecodeexample_plugin_DemoMultipleOutputsInterfaceMethod_80749b1a9e2a11e7a22c448a5b5d70c0>`
- :ref:`Top level menu item <sourcecodeexample_plugin_DemoTopLevelMenuItem_bbcbcaf49a3111e7aad3448a5b5d70c0>`
- :ref:`Static contextual menu item <sourcecodeexample_plugin_DemoStaticContextualMenuItem_af3829f09a4811e78298448a5b5d70c0>`
- :ref:`Static contextual menu item <sourcecodeexample_plugin_DemoStaticContextualMenuItem2_37318dec9a4c11e7b320448a5b5d70c0>`
- :ref:`Dynamic contextual menu item <sourcecodeexample_plugin_DemoDynamicContextualMenuItem_288f7e809c9111e796e3448a5b5d70c0>`
- :ref:`Association of menu items to actions <sourcecodeexample_plugin_DemoAssociationMenuItemToAction_12015ade98c711e7905d448a5b5d70c0>`
- :ref:`Class action <sourcecodeexample_plugin_DemoClassAction_cfd430589c9711e78d5d448a5b5d70c0>`
- :ref:`Instance action <sourcecodeexample_plugin_DemoInstanceAction_3f9a92129c9a11e7aa79448a5b5d70c0>`
- :ref:`State-dependent action <sourcecodeexample_plugin_DemoStateDependentAction_0fa218549cb111e7bc8c448a5b5d70c0>`
- :ref:`Cursors <sourcecodeexample_plugin_DemoCursorState_5c5a3f069efc11e796c3448a5b5d70c0>`
- :ref:`Method handleChanged <sourcecodeexample_plugin_DemoHandleChangedState_129e978a9fb811e78427448a5b5d70c0>`
- :ref:`Method handleTriggered <sourcecodeexample_plugin_DemoHandleTriggeredState_118ffffe9fcf11e7aeee448a5b5d70c0>`
- :ref:`Temporary actions <sourcecodeexample_plugin_DemoTemporaryActionState_2fcb02f8a21311e79b16448a5b5d70c0>`
- :ref:`Temporary actions external state <sourcecodeexample_plugin_DemoTemporaryActionExternalState_c2ce1878b4f911e79ff1448a5b5d70c0>`
- :ref:`Interest on entities defined by the application <sourcecodeexample_plugin_DemoInterestOnApplicationDefinedEntities_04c40fd29d5711e7987c448a5b5d70c0>`
- :ref:`Interest on user defined entities <sourcecodeexample_plugin_DemoInterestOnUserDefinedEntities_a1fd6d309d6511e78494448a5b5d70c0>`
- :ref:`Mouse handlers state activation <sourcecodeexample_plugin_DemoStateActivationMouseHandlers_4f8c6ed4ba7d11e7ade9448a5b5d70c0>`
- :ref:`Mouse handlers annotations <sourcecodeexample_plugin_DemoAnnotationMouseHandlers_aedd61d0bd7711e7acfe448a5b5d70c0>`
- :ref:`Instance callbacks <sourcecodeexample_plugin_DemoInstanceCallbacks_56a0eba8addf11e7baff448a5b5d70c0>`
- :ref:`Class callbacks <sourcecodeexample_plugin_DemoClassCallbacks_d335ec40aded11e7b38f448a5b5d70c0>`
- :ref:`Global callbacks <sourcecodeexample_plugin_DemoGlobalCallbacks_ea5008a6adf911e7a36a448a5b5d70c0>`
- :ref:`Dirty signature flags <sourcecodeexample_plugin_DemoDirtyFlags_0ac5ff5eaf7b11e78346448a5b5d70c0>`
- :ref:`Progress bars <sourcecodeexample_plugin_DemoProgress_fabbb140f16b11e7bc70448a5b5d70c0>`
- :ref:`Promoting widgets <sourcecodeexample_plugin_DemoPromotingWidgets_7e725328bf2b11e7afbc448a5b5d70c0>`
- :ref:`How to develop a User Interface (video tutorial) <howtodevelopui_videotutorial>`