wolfhece._builtin_plugins._template.companion
=============================================

.. py:module:: wolfhece._builtin_plugins._template.companion

.. autoapi-nested-parse::

   Template companion plugin.

   Replace every occurrence of ``MyPlugin`` / ``my_plugin`` with your own name,
   then implement the methods below.

   Rename this directory to match the ``name`` field in ``plugin.toml``
   (removing the leading ``_`` so it is auto-discovered).







Module Contents
---------------

.. py:data:: _WXK_ESCAPE
   :value: 27


.. py:class:: MyPluginCompanion(viewer: wolfhece.PyDraw.WolfMapViewer, dialogs: wolfhece.dialog_provider.DialogProvider | None = None, namespace: str | None = None)

   Bases: :py:obj:`wolfhece._menu_companion_abc.AbstractCompanion`

   .. autoapi-inheritance-diagram:: wolfhece._builtin_plugins._template.companion.MyPluginCompanion
      :parts: 1
      :private-bases:


   Minimal template — replace with your implementation.


   .. py:method:: menu_build() -> None

      Add a top-level menu entry.  Remove if no menu is needed.



   .. py:method:: start() -> None

      Called when the companion is activated programmatically.



   .. py:method:: _on_run(event) -> None


   .. py:method:: _rdown(viewer, ctx: wolfhece._viewer_plugin_handlers.MouseContext) -> None


   .. py:method:: _key(viewer, kb: wolfhece._viewer_plugin_handlers.KeyboardSnapshot) -> bool


   .. py:method:: _paint(viewer) -> None