diff options
| -rw-r--r-- | doc/api.txt | 46 | ||||
| -rw-r--r-- | doc/api/canvas.txt | 15 | ||||
| -rw-r--r-- | doc/api/connectors.txt | 27 | ||||
| -rw-r--r-- | doc/api/constraints.txt | 16 | ||||
| -rw-r--r-- | doc/api/decorators.txt | 5 | ||||
| -rw-r--r-- | doc/api/geometry.txt | 4 | ||||
| -rw-r--r-- | doc/api/gtkview.txt | 15 | ||||
| -rw-r--r-- | doc/api/items.txt | 23 | ||||
| -rw-r--r-- | doc/api/matrix.txt | 15 | ||||
| -rw-r--r-- | doc/api/painters.txt | 16 | ||||
| -rw-r--r-- | doc/api/quadtree.txt | 15 | ||||
| -rw-r--r-- | doc/api/solver.txt | 15 | ||||
| -rw-r--r-- | doc/api/tools.txt | 16 | ||||
| -rw-r--r-- | doc/api/tree.txt | 15 | ||||
| -rw-r--r-- | doc/api/utils.txt | 12 | ||||
| -rw-r--r-- | doc/api/view.txt | 17 | ||||
| -rw-r--r-- | doc/conf.py | 2 | ||||
| -rw-r--r-- | doc/undo.txt | 8 |
18 files changed, 275 insertions, 7 deletions
diff --git a/doc/api.txt b/doc/api.txt index 12c1f02..2ad2d31 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -4,12 +4,46 @@ API reference This part describes the API of Gaphas. -:mod: `gaphor.canvas` ---------------------- +The API can be separated into three parts. First of all there's the model +(canvas and items). Then there's the view (view) and controllers (tools). -.. module:: gaphas.canvas +Some more generic stuff is also described here. -.. autoclass:: Canvas - :members: - :undoc-members: +Canvas and items +---------------- + +.. toctree:: + :maxdepth: 2 + + api/canvas + api/items + api/connectors + api/solver + api/constraints + api/utils + + +View and tools +-------------- + +.. toctree:: + :maxdepth: 2 + + api/view + api/gtkview + api/tools + api/painters + + +Miscellaneous +------------- + +.. toctree:: + :maxdepth: 2 + + api/tree + api/matrix + api/quadtree + api/geometry + api/decorators diff --git a/doc/api/canvas.txt b/doc/api/canvas.txt new file mode 100644 index 0000000..42dbb2b --- /dev/null +++ b/doc/api/canvas.txt @@ -0,0 +1,15 @@ +###### +Canvas +###### + +This part describes the API of Gaphas. + +:mod: `gaphor.canvas` +--------------------- + +.. module:: gaphas.canvas + +.. autoclass:: Canvas + :members: + :undoc-members: + diff --git a/doc/api/connectors.txt b/doc/api/connectors.txt new file mode 100644 index 0000000..966bf48 --- /dev/null +++ b/doc/api/connectors.txt @@ -0,0 +1,27 @@ +################# +Handles and ports +################# + +This part describes the API of Gaphas. + +:mod: `gaphor.connector` +------------------------ + +.. module:: gaphas.connector + +.. autoclass:: Handle + :members: + :undoc-members: + +.. autoclass:: Port + :members: + :undoc-members: + +.. autoclass:: PointPort + :members: + :undoc-members: + +.. autoclass:: LinePort + :members: + :undoc-members: + diff --git a/doc/api/constraints.txt b/doc/api/constraints.txt new file mode 100644 index 0000000..08757e6 --- /dev/null +++ b/doc/api/constraints.txt @@ -0,0 +1,16 @@ +################# +Constraints +################# + +The default constraint classes provided by Gaphas + +:mod: `gaphor.constraint` +--------------------- + +.. module:: gaphas.constraint + +.. autoclass:: Constraint + :members: + :undoc-members: + +TODO: And the rest diff --git a/doc/api/decorators.txt b/doc/api/decorators.txt new file mode 100644 index 0000000..2bb218d --- /dev/null +++ b/doc/api/decorators.txt @@ -0,0 +1,5 @@ +########## +Decorators +########## + +TODO: tell. diff --git a/doc/api/geometry.txt b/doc/api/geometry.txt new file mode 100644 index 0000000..21c500c --- /dev/null +++ b/doc/api/geometry.txt @@ -0,0 +1,4 @@ +############################ +Lines, points and rectangles +############################ + diff --git a/doc/api/gtkview.txt b/doc/api/gtkview.txt new file mode 100644 index 0000000..2d8e436 --- /dev/null +++ b/doc/api/gtkview.txt @@ -0,0 +1,15 @@ +######### +GTK+ View +######### + +This part describes the API of Gaphas. + +:mod: `gaphor.view` +--------------------- + +.. module:: gaphas.view + +.. autoclass:: GtkView + :members: + :undoc-members: + diff --git a/doc/api/items.txt b/doc/api/items.txt new file mode 100644 index 0000000..cbb8260 --- /dev/null +++ b/doc/api/items.txt @@ -0,0 +1,23 @@ +################# +Items +################# + +Items are put on a Canvas. + +:mod: `gaphor.item` +--------------------- + +.. module:: gaphas.item + +.. autoclass:: Item + :members: + :undoc-members: + +.. autoclass:: Element + :members: + :undoc-members: + +.. autoclass:: Line + :members: + :undoc-members: + diff --git a/doc/api/matrix.txt b/doc/api/matrix.txt new file mode 100644 index 0000000..938723e --- /dev/null +++ b/doc/api/matrix.txt @@ -0,0 +1,15 @@ +###### +Matrix +###### + +The Matrix class is used to define transformations on an item, relative to the parent Item. This is basically the same implementation as cairo.Matrix, only notifications are sent on state changes (see the state module). + +:mod: `gaphor.matrix` +--------------------- + +.. module:: gaphas.matrix + +.. autoclass:: Matrix + :members: + :undoc-members: + diff --git a/doc/api/painters.txt b/doc/api/painters.txt new file mode 100644 index 0000000..6a52237 --- /dev/null +++ b/doc/api/painters.txt @@ -0,0 +1,16 @@ +############################## +Painters - drawing on the View +############################## + +This part describes the API of Gaphas. + +:mod: `gaphor.painter` +--------------------- + +.. module:: gaphas.painter + +.. autoclass:: Painter + :members: + :undoc-members: + +TODO: Add the rest diff --git a/doc/api/quadtree.txt b/doc/api/quadtree.txt new file mode 100644 index 0000000..09388c9 --- /dev/null +++ b/doc/api/quadtree.txt @@ -0,0 +1,15 @@ +######## +Quadtree +######## + +This part describes the API of Gaphas. + +:mod: `gaphor.quadtree` +--------------------- + +.. module:: gaphas.quadtree + +.. autoclass:: Quadtree + :members: + :undoc-members: + diff --git a/doc/api/solver.txt b/doc/api/solver.txt new file mode 100644 index 0000000..0afe856 --- /dev/null +++ b/doc/api/solver.txt @@ -0,0 +1,15 @@ +################# +Constraint solver +################# + +This part describes the API of Gaphas. + +:mod: `gaphor.solver` +--------------------- + +.. module:: gaphas.solver + +.. autoclass:: Solver + :members: + :undoc-members: + diff --git a/doc/api/tools.txt b/doc/api/tools.txt new file mode 100644 index 0000000..e0c3c61 --- /dev/null +++ b/doc/api/tools.txt @@ -0,0 +1,16 @@ +################################## +Interacting with the canvas (view) +################################## + +This part describes the API of Gaphas. + +:mod: `gaphor.tool` +--------------------- + +.. module:: gaphas.tool + +.. autoclass:: Tool + :members: + :undoc-members: + +# TODO: describe the rest diff --git a/doc/api/tree.txt b/doc/api/tree.txt new file mode 100644 index 0000000..044a69b --- /dev/null +++ b/doc/api/tree.txt @@ -0,0 +1,15 @@ +############## +Tree structure +############## + +This part describes the API of Gaphas. + +:mod: `gaphor.tree` +--------------------- + +.. module:: gaphas.tree + +.. autoclass:: Tree + :members: + :undoc-members: + diff --git a/doc/api/utils.txt b/doc/api/utils.txt new file mode 100644 index 0000000..2744e92 --- /dev/null +++ b/doc/api/utils.txt @@ -0,0 +1,12 @@ +######################### +Various utility functions +######################### + +This part describes the API of Gaphas. + +:mod: `gaphor.utils` +--------------------- + +.. module:: gaphas.utils + +TODO: describe the rest diff --git a/doc/api/view.txt b/doc/api/view.txt new file mode 100644 index 0000000..21efe5f --- /dev/null +++ b/doc/api/view.txt @@ -0,0 +1,17 @@ +#### +View +#### + +The View is the base class for viewing related operations. A good example is +the ``GtkView``, which provides a GTK+ widget for viewing (and editing) the +canvas. Views are also used for rendering to images (for example SVG or PNG). + +:mod: `gaphor.view` +--------------------- + +.. module:: gaphas.view + +.. autoclass:: View + :members: + :undoc-members: + diff --git a/doc/conf.py b/doc/conf.py index fb05fe7..d39fa5c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,4 +1,6 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo'] project = 'Gaphas' +version = '0.4' +release = version source_suffix = '.txt' master_doc = 'contents' diff --git a/doc/undo.txt b/doc/undo.txt index a1c8b38..0dead78 100644 --- a/doc/undo.txt +++ b/doc/undo.txt @@ -1,5 +1,5 @@ Undo - implementing basic undo behaviour with Gaphas -==================================================== +#################################################### This document describes a basic undo system and tests Gaphas' classes with this system. @@ -35,6 +35,12 @@ This simple undo function will revert all states collected in the undo_list: ... redo_list[:] = undo_list[:] ... del undo_list[:] +Undo functionality tests +======================== + +The following sections contain most of the basis unit tests for undo +management. + tree.py: Tree ------------- Tree has no observed methods. |