summaryrefslogtreecommitdiff
path: root/doc/source/dev/events.rst
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-08 18:52:35 +0200
committermathieui <mathieui@mathieui.net>2013-04-08 18:52:35 +0200
commitbd8d38d711e15d42ac8e797723af5242e4c3f4fb (patch)
treed3ea6da641be1c7e67a3123071cb816933436502 /doc/source/dev/events.rst
parente5f219d43edbb4b05c8890f81f2f93b90e215a10 (diff)
downloadpoezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.tar.gz
poezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.tar.bz2
poezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.tar.xz
poezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.zip
Beginning of the migration to reST documentation
Diffstat (limited to 'doc/source/dev/events.rst')
-rw-r--r--doc/source/dev/events.rst142
1 files changed, 142 insertions, 0 deletions
diff --git a/doc/source/dev/events.rst b/doc/source/dev/events.rst
new file mode 100644
index 00000000..c2aa4036
--- /dev/null
+++ b/doc/source/dev/events.rst
@@ -0,0 +1,142 @@
+Event Index
+===========
+
+The following events are poezio-only events, for SleekXMPP events, check out
+`their index <http://sleekxmpp.com/event_index.html>`_.
+
+.. glossary::
+ :sorted:
+
+ muc_say
+ - **message:** :py:class:`~sleekxmpp.Message` that will be sent
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered whenever the user sends a message to a :py:class:`~tabs.MucTab`.
+
+ muc_say_after
+ - **message:** :py:class:`~sleekxmpp.Message` that will be sent
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Same thing than :term:`muc_say`, but after XHTML generation of the body, if needed.
+ This means you must not insert any colors in the body in the handler, since
+ it may lead to send invalid XML. This hook is less safe than ``muc_say`` and
+ you should probably not need it.
+
+ private_say
+ - **message:** :py:class:`~sleekxmpp.Message` that will be sent
+ - **tab:** :py:class:`~tabs.PrivateTab` source
+
+ Triggered whenever the user sends a message to a :py:class:`~tabs.PrivateTab`.
+
+ private_say_after
+ - **message:** :py:class:`~sleekxmpp.Message` that will be sent
+ - **tab:** :py:class:`~tabs.PrivateTab` source
+
+ Same thing than :term:`private_say`, but after XHTML generation of the body, if needed.
+ This means you must not insert any colors in the body in the handler, since
+ it may lead to send invalid XML. This hook is less safe than :term:`private_say` and
+ you should probably not need it.
+
+ conversation_say
+ - **message:** :py:class:`~sleekxmpp.Message` that will be sent
+ - **tab:** :py:class:`~tabs.ConversationTab` source
+
+ Triggered whenever the user sends a message to a :py:class:`~tabs.ConversationTab`.
+
+ conversation_say_after:
+ - **message:** :py:class:`~sleekxmpp.Message` that will be sent
+ - **tab:** :py:class:`~tabs.ConversationTab` source
+
+ Same thing than :term:`conversation_say`, but after XHTML generation of the body, if needed.
+ This means you must not insert any colors in the body in the handler, since
+ it may lead to send invalid XML. This hook is less safe than :term:`conversation_say` and
+ you should probably not need it.
+
+ muc_msg
+ - **message:** :py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when a message is received in a :py:class:`~tabs.MucTab`.
+
+ private_msg
+ - **message:** :py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`~tabs.PrivateTab` source
+
+ Triggered when a message is received in a :py:class:`~tabs.PrivateTab`.
+
+ conversation_msg
+ - **message:** :py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`~tabs.ConversationTab` source
+
+ Triggered when a message is received in a :py:class:`~tabs.ConversationTab`.
+
+ conversation_chatstate
+ - **message:** :py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`~tabs.ConversationTab` source
+
+ Triggered when a chatstate is received in a :py:class:`~tabs.ConversationTab`.
+
+ muc_chatstate
+ - **message:** :py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when a chatstate is received in a :py:class:`~tabs.MucTab`.
+
+ private_chatstate
+ - **message:** :py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`PrivateTab <tabs.PrivateTab>` source
+
+ Triggered when a chatstate is received in a :py:class:`~tabs.PrivateTab`.
+
+ normal_presence
+ - **presence:** :py:class:`~sleekxmpp.Presence` received
+ - **resource:** :py:class:`Resource <str>` that emitted the :py:class:`~sleekxmpp.Presence`
+
+ Triggered when a presence is received from a contact.
+
+ muc_presence
+ - **presence:** :py:class:`~sleekxmpp.Presence` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when a presence is received from someone in a :py:class:`~tabs.MucTab`.
+
+ send_normal_presence
+ - **presence:** :py:class:`~sleekxmpp.Presence` sent
+
+ Triggered when before poezio sends a new :py:class:`~sleekxmpp.Presence` stanza.
+
+ muc_join
+ - **presence:** :py:class:`~sleekxmpp.Presence` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when an user joins a :py:class:`~tabs.MucTab`
+
+ muc_ban
+ - **presence:** :py:class:`~sleekxmpp.Presence` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when an user from a :py:class:`~tabs.MucTab`
+ gets banned.
+
+ muc_kicked
+ - **presence:** :py:class:`~sleekxmpp.Presence` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when an user from a :py:class:`~tabs.MucTab`
+ gets kicked.
+
+ muc_nickchange
+ - **presence:** :py:class:`~sleekxmpp.Presence` received
+ - **tab:** :py:class:`~tabs.MucTab` source
+
+ Triggered when an user in a :py:class:`~tabs.MucTab` changes
+ his nickname.
+
+ ignored_private
+ - **message**:py:class:`~sleekxmpp.Message` received
+ - **tab:** :py:class:`~tabs.PrivateTab` source
+
+ Triggered when a private message (that goes in a :py:class:`~tabs.PrivateTab`)
+ is ignored automatically by poezio.
+
+ **tab** is always ``None``, except when a tab has already been opened.