summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2016-03-08 22:53:13 +0100
committermathieui <mathieui@mathieui.net>2016-03-08 22:53:13 +0100
commit7d6ee0858501e22bf1ce6092a5e319467019507d (patch)
tree7d9b3f3c24edf8283fa9b2f2046973aaf1d140ef /doc/source
parent2354e7d10203f0561f3c4d6657f044b3938b8db1 (diff)
downloadpoezio-7d6ee0858501e22bf1ce6092a5e319467019507d.tar.gz
poezio-7d6ee0858501e22bf1ce6092a5e319467019507d.tar.bz2
poezio-7d6ee0858501e22bf1ce6092a5e319467019507d.tar.xz
poezio-7d6ee0858501e22bf1ce6092a5e319467019507d.zip
Update api doc
It was missing the highlight event
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/dev/events.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/source/dev/events.rst b/doc/source/dev/events.rst
index 80397a6e..3af469bb 100644
--- a/doc/source/dev/events.rst
+++ b/doc/source/dev/events.rst
@@ -7,6 +7,10 @@ The following events are poezio-only events, for Slixmpp events, check out
.. glossary::
:sorted:
+ highlight
+ - **message:** :py:class:`~slixmpp.Message` that was received
+ - **tab:** :py:class:`~tabs.MucTab` source of the event
+
tab_change
- **old_tab_nb:** :py:class:`int` Old current tab number.
- **new_tab_nb:** :py:class:`int` New current tab number.
@@ -130,27 +134,27 @@ The following events are poezio-only events, for Slixmpp events, check out
- **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source
- Triggered when an user joins a :py:class:`~tabs.MucTab`
+ Triggered when a user joins a :py:class:`~tabs.MucTab`
muc_ban
- **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source
- Triggered when an user from a :py:class:`~tabs.MucTab`
+ Triggered when a user from a :py:class:`~tabs.MucTab`
gets banned.
- muc_kicked
+ muc_kick
- **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source
- Triggered when an user from a :py:class:`~tabs.MucTab`
+ Triggered when a user from a :py:class:`~tabs.MucTab`
gets kicked.
muc_nickchange
- **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source
- Triggered when an user in a :py:class:`~tabs.MucTab` changes
+ Triggered when a user in a :py:class:`~tabs.MucTab` changes
his nickname.
ignored_private