===============
Curve (hwx.gui)
===============

A curved line.

--------------
Public Methods
--------------

  +---------------------------------------------------------+
  | addSlider_ (self, **kwds)                               |
  +---------------------------------------------------------+
  | clearMemoryCurve_ (self)                                |
  +---------------------------------------------------------+
  | decorateEnabled_ (self, enabled)                        |
  +---------------------------------------------------------+
  | delete_ (self)                                          |
  +---------------------------------------------------------+
  | getNextUnusedColor_ (self)                              |
  +---------------------------------------------------------+
  | getTheClosestPoint_ (self, x, y)                        |
  +---------------------------------------------------------+
  | hover_ (self)                                           |
  +---------------------------------------------------------+
  | pick_ (self, event)                                     |
  +---------------------------------------------------------+
  | setHovered_ (self, points, showText=False, event=None)  |
  +---------------------------------------------------------+
  | setMemoryCurve_ (self)                                  |
  +---------------------------------------------------------+
  | setSelected_ (self, points, showText=False, event=None) |
  +---------------------------------------------------------+
  | unhover_ (self)                                         |
  +---------------------------------------------------------+

--------------
Method Details
--------------

.. _addSlider:
.. method:: addSlider(self, **kwds)

Adds a curve slider.

.. _clearMemoryCurve:
.. method:: clearMemoryCurve(self)

Clears original curve.

.. _decorateEnabled:
.. method:: decorateEnabled(self, enabled)

the plot was enabled or disabled, set the color.

.. _delete:
.. method:: delete(self)

Removes this curve from the plot.

.. _getNextUnusedColor:
.. method:: getNextUnusedColor(self)

Gets next unused color.

.. _getTheClosestPoint:
.. method:: getTheClosestPoint(self, x, y)

Gets the closest CurvePoint for the specified x and y.

:param x: Specified x value.
:type x: float
:param y: Specified y value.
:type y: float

:returns: The closest CurvePoint.
:rtype: CurvePoint


.. _hover:
.. method:: hover(self)

When the line is hovered.

.. _pick:
.. method:: pick(self, event)

When the line is picked from the plot this method gets called

:param event: The mouse event when clicked on the line
:type event: MouseEvent

:returns: A reference to the instance Line object on which it was called or None
:rtype: Line


.. _setHovered:
.. method:: setHovered(self, points, showText=False, event=None)

Sets the curve points hovered.

:param points: The list of points to be set hovered.
:type points: list[Point]
:param showText: Determines whether to show hovered text.
:type showText: bool
:param event: MouseEvent to capture the hover.
:type event: MouseEvent


.. _setMemoryCurve:
.. method:: setMemoryCurve(self)

Shows original curve when dragging.

.. _setSelected:
.. method:: setSelected(self, points, showText=False, event=None)

Sets the curve points selected.

:param points: The list of points to be set selected.
:type points: list[Point]
:param showText: Determines whether to show selected text.
:type showText: bool
:param event: MouseEvent to. capture the selection.
:type event: MouseEvent


.. _unhover:
.. method:: unhover(self)

When the line is not hovered.