:py:mod:`pickax.flag`
=====================

.. py:module:: pickax.flag

.. autodoc2-docstring:: pickax.flag
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`PickFlag <pickax.flag.PickFlag>`
     - .. autodoc2-docstring:: pickax.flag.PickFlag
          :summary:

API
~~~

.. py:class:: PickFlag(pick, seismograph, arrival=None, is_modifiable=False)
   :canonical: pickax.flag.PickFlag

   .. autodoc2-docstring:: pickax.flag.PickFlag

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.flag.PickFlag.__init__

   .. py:method:: mouse_event_connect(canvas)
      :canonical: pickax.flag.PickFlag.mouse_event_connect

      .. autodoc2-docstring:: pickax.flag.PickFlag.mouse_event_connect

   .. py:method:: event_on_flag(event)
      :canonical: pickax.flag.PickFlag.event_on_flag

      .. autodoc2-docstring:: pickax.flag.PickFlag.event_on_flag

   .. py:method:: on_key(event)
      :canonical: pickax.flag.PickFlag.on_key

      .. autodoc2-docstring:: pickax.flag.PickFlag.on_key

   .. py:method:: on_press(event)
      :canonical: pickax.flag.PickFlag.on_press

      .. autodoc2-docstring:: pickax.flag.PickFlag.on_press

   .. py:method:: on_release(event)
      :canonical: pickax.flag.PickFlag.on_release

      .. autodoc2-docstring:: pickax.flag.PickFlag.on_release

   .. py:method:: on_motion(event)
      :canonical: pickax.flag.PickFlag.on_motion

      .. autodoc2-docstring:: pickax.flag.PickFlag.on_motion

   .. py:method:: draw()
      :canonical: pickax.flag.PickFlag.draw

      .. autodoc2-docstring:: pickax.flag.PickFlag.draw

   .. py:method:: color_label()
      :canonical: pickax.flag.PickFlag.color_label

      .. autodoc2-docstring:: pickax.flag.PickFlag.color_label