6add201436
Improve the code documentation (still much more to do) and also add some more meat to the structure of the developer documentation. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
28 lines
858 B
ReStructuredText
28 lines
858 B
ReStructuredText
:mod:`offlineimap.ui` -- A pluggable logging system
|
|
--------------------------------------------------------
|
|
|
|
.. currentmodule:: offlineimap.ui
|
|
|
|
OfflineImap has various ui systems, that can be selected. They offer various functionalities. They must implement all functions that the :class:`offlineimap.ui.UIBase` offers. Early on, the ui must be set using :meth:`getglobalui`
|
|
|
|
.. automethod:: offlineimap.ui.setglobalui
|
|
.. automethod:: offlineimap.ui.getglobalui
|
|
|
|
Base UI plugin
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. autoclass:: offlineimap.ui.UIBase.UIBase
|
|
:members:
|
|
:inherited-members:
|
|
|
|
.. .. note:: :meth:`foo`
|
|
.. .. attribute:: Database.MODE
|
|
|
|
Defines constants that are used as the mode in which to open a database.
|
|
|
|
MODE.READ_ONLY
|
|
Open the database in read-only mode
|
|
|
|
MODE.READ_WRITE
|
|
Open the database in read-write mode
|