84aeb6c80b
- Rename all .txt doc files to .rst to make it more clear that they are restructured text. - Add requirements.txt for Sphinx - Rerun sphinx-quickstart to make compatible with the latest Sphinx version. - Fix module names from gaphor to gaphas - Fix warnings about incorrect indent following :mod: lines - Fix TypeError for class Segmant: function object has no attribute '__mro__' Signed-off-by: Dan Yeaw <dan@yeaw.me>
39 lines
1.3 KiB
ReStructuredText
39 lines
1.3 KiB
ReStructuredText
Class diagram
|
|
=============
|
|
|
|
This class diagram describes the basic layout of Gaphas.
|
|
|
|
.. image:: gaphas-canvas.png
|
|
:width: 700
|
|
|
|
One-oh-one:
|
|
|
|
:doc:`api/canvas`
|
|
The main canvas class (container for Items)
|
|
:doc:`api/items`
|
|
Objects placed on a Canvas. Items can draw themselves, but not act on user events
|
|
:doc:`api/solver`
|
|
A constraint solver. Nice to have when you want to connect items together in a generic way.
|
|
:doc:`api/view`
|
|
Base class that renders content (`paint()`). The view is responsible for the calculation of bounding boxes. This information is stored in a quadtree_ data structure for fast access.
|
|
:doc:`api/gtkview`
|
|
A view to be used in GTK+ applications. This view class is interactive. Interaction with users is handled by Tools.
|
|
:doc:`api/painters`
|
|
Painters are the workers when it comes to painting items.
|
|
:doc:`api/tools`
|
|
Tools are used to handle user events (such as mouse movement and button presses).
|
|
:doc:`api/aspects`
|
|
Tools do not modify the items directly. They use aspects (not the AOP kind) as intermediate step. Since aspects are defined as generic functions, the behaviour for each diagram item type can be slightly different.
|
|
|
|
Tools
|
|
-----
|
|
|
|
Several tools_ are used to make the overall user experience complete.
|
|
|
|
.. image:: tools.png
|
|
:width: 532
|
|
|
|
|
|
.. _quadtree: quadtree.html
|
|
.. _tools: tools.html
|