*****************************************************************************
Программный интерфейс к клиентскому приложению Cerebro на языке Python 
*****************************************************************************

Программный интерфейс позволяет расширять возможности клиентского
приложения, используя дополнительные Python-модули.

Существует несколько способов расширения возможностей:
    
* обработка событий;
* встраивание меню;
* обработка входа в программу и выхода из неё.

:ref:`Обработка событий <capi-event>`

Приложение генерирует событие, когда происходит какое-либо изменение
данных пользователем. Например, создание сообщения, задачи, изменение
свойств задач и т.д. Программный интерфейс позволяет управлять этими
событиями.

:ref:`Встраивание меню <capi-menu>`

Программный интерфейс позволяет встраивать пользовательские меню в
главное и контекстные меню приложения.

:ref:`Обработка входа в программу и выхода из неё <capi-logon-off>`

Также программный интерфейс позволяет обработать моменты входа и
выхода из программы, где вы можете произвести какие-либо свои действия
для инициализации и завершения сеанса работы с приложением.

Взаимодействие с приложением осуществляется через пакет
:ref:`cerebro <capi-cerebro>`.
С помощью него осуществляется доступ к данным и управляющим функциям,
вызов простых графических интерфейсов,
доступ к файловому хранилищу и базе данных.


.. toctree for hierarchy and numbering

.. toctree::
   :maxdepth: 2
   :numbered:

   capi_paths
   capi_encoding
   capi_errors
   capi_plugins
   capi_debug
   capi_templates
   capi_menu
   capi_event
   capi_logonoff
   capi_cerebro
   capi_pyqt5
   capi_examples