Improve documentation of 'on_write' attribute

review11071002
This commit is contained in:
Cédric Krier
2015-03-16 10:05:25 +01:00
parent e631dbee65
commit af292cac78
+11 -6
View File
@@ -153,11 +153,19 @@ Each form view must start with this tag.
* ``string``: The text that will be used as default title for the tab or
the window.
* ``on_write``: The name of a function that will be called when the record
is saved. The function must have this syntax:
.. _form-attributes-on_write:
* ``on_write``: The name of a method on the Model of the view that will be
called when a record is saved. The method must return a list of record
ids that the client must reload if they are already loaded. The function
must have this syntax:
``on_write(self, ids)``
.. note::
The method must be registered in :attr:`trytond.model.Model.__rpc__`.
..
* ``col``: The number of columns for the view.
* ``cursor``: The name of the field that must have the cursor by default.
@@ -479,10 +487,7 @@ Each tree view must start with this tag.
* ``string``: The text that will be used as default title for the tab or
the window.
* ``on_write``: The name of a function that will be called when a record is
saved. The function must have this syntax:
``on_write(self, ids)``
* ``on_write``: see form-attributes-on_write_.
* ``editable``: If it is set to ``top`` or ``bottom``, the list becomes
editable and the new record will be added on ``top`` or ``bottom`` of the