API Reference
=============

NodeWidget
----------
The NodeWidget class provides the main entry point to the nodeworks library. The
class provides a QWidget that can be inserted into Qt based applications. The
NodeWidget contains methods for adding/removing Nodes and Connections as well as
saving, loading, exporting, and solving the network.

.. autoclass:: nodeworks.nodewidget.NodeWidget
    :members:

NodeWidget Support
******************

.. autoclass:: nodeworks.nodewidget.GraphicsScene
    :members:

.. autoclass:: nodeworks.nodewidget.StructureScene
    :members:

.. autoclass:: nodeworks.nodewidget.GraphicsView
    :members:

.. autoclass:: nodeworks.nodewidget.PreviewView
    :members:

.. autoclass:: nodeworks.nodewidget.SearchNodeWidget
    :members:

.. autoclass:: nodeworks.nodewidget.WorkerThread
    :members:


Node
----
The Node provides the top-level methods for a node.

.. autoclass:: nodeworks.node.Node
    :members:

Node Support
************

.. autoclass:: nodeworks.node.NodeGraphic
    :members:

.. autoclass:: nodeworks.node.Terminal
    :members:

Connection
----------
The Connection provides connections between Terminals of Nodes

.. autoclass:: nodeworks.node.Connection
    :members:

NodeLibrary
-----------
The NodeLibrary provides methods for building and maintaining a collection of
Nodes that can be added to a network.

.. autoclass:: nodeworks.nodelibrary.NodeLibrary
    :members:

Base Widgets
------------
Base widgets provide unified value and setValue methods as well as ValueChanged
Signals for a collection of QWidgets.


Tools
-----
A collection of helper functions.