Mercurial > MadButterfly
comparison dox/pyink.h @ 1521:6d74f835f3b4
Add document page for pyink.
| author | Thinker K.F. Li <thinker@codemud.net> |
|---|---|
| date | Fri, 19 Aug 2011 17:39:14 +0800 |
| parents | |
| children | 73837e189039 |
comparison
equal
deleted
inserted
replaced
| 1520:8bc2e824f155 | 1521:6d74f835f3b4 |
|---|---|
| 1 /*! \page pyink_arch Architecture of pyink | |
| 2 * | |
| 3 * pyink/ sub-directory is an implementation base on pybind. pybind | |
| 4 * is a binding for Python that exploses functions of Inkscape to | |
| 5 * Python. You can access internal data and functions provided by | |
| 6 * Inkscape, and extend functions of Inkscape platform. | |
| 7 * | |
| 8 * pyink.py includes entry points to initialize Python code when | |
| 9 * Inkscape is booting. With pybind, Inkscape will try to search and | |
| 10 * load pyink.py module from directories given by PYTHONPATH | |
| 11 * environment variable. pyink.pyink_start() would be called by | |
| 12 * Inkscape to give Python code a chance to initialize itself and | |
| 13 * register handlers for hooks provided by pybind. Pybind defines | |
| 14 * some hooks that will be tirggered for various events. By register | |
| 15 * handlers for hooks, Python code can intervent behavior of Inkscape | |
| 16 * to modify its heavior. | |
| 17 * | |
| 18 * Python code defined by pyink.py can also modify UI of Inkscape by | |
| 19 * manipulate component tree of GTK. In our implementation, it | |
| 20 * invokes PyGTK to inspect and modify GUI of Inkscape. For example, | |
| 21 * add list views or/and menu items. | |
| 22 * | |
| 23 * \section arch_pyink_mb Aricthrue of pyink module provied by MadButterfly | |
| 24 * | |
| 25 * The purpose of pyink provided by MadButterfly is for making GUI of | |
| 26 * other applications. It includes several major parts. | |
| 27 * - domview | |
| 28 * - domview_ui | |
| 29 * - frameline | |
| 30 */ |