Commit 097d06ea authored by louiz’'s avatar louiz’

Rename the sleekxmpp module to slixmpp in the doc

parent 0800c666
...@@ -793,7 +793,7 @@ Options related to logging. ...@@ -793,7 +793,7 @@ Options related to logging.
**Default value:** ``true`` **Default value:** ``true``
Logs all the tracebacks and erors of poezio/sleekxmpp in Logs all the tracebacks and erors of poezio/slixmpp in
:term:`log_dir`/errors.log by default. ``false`` disables this option. :term:`log_dir`/errors.log by default. ``false`` disables this option.
use_log use_log
......
Event Index Event Index
=========== ===========
The following events are poezio-only events, for SleekXMPP events, check out The following events are poezio-only events, for Slixmpp events, check out
`their index <http://sleekxmpp.com/event_index.html>`_. `their index <http://slixmpp.com/event_index.html>`_.
.. glossary:: .. glossary::
:sorted: :sorted:
...@@ -14,13 +14,13 @@ The following events are poezio-only events, for SleekXMPP events, check out ...@@ -14,13 +14,13 @@ The following events are poezio-only events, for SleekXMPP events, check out
Triggered whenever the user switches between tabs. Triggered whenever the user switches between tabs.
muc_say muc_say
- **message:** :py:class:`~sleekxmpp.Message` that will be sent - **message:** :py:class:`~slixmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered whenever the user sends a message to a :py:class:`~tabs.MucTab`. Triggered whenever the user sends a message to a :py:class:`~tabs.MucTab`.
muc_say_after muc_say_after
- **message:** :py:class:`~sleekxmpp.Message` that will be sent - **message:** :py:class:`~slixmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Same thing than :term:`muc_say`, but after XHTML generation of the body, if needed. Same thing than :term:`muc_say`, but after XHTML generation of the body, if needed.
...@@ -29,13 +29,13 @@ The following events are poezio-only events, for SleekXMPP events, check out ...@@ -29,13 +29,13 @@ The following events are poezio-only events, for SleekXMPP events, check out
you should probably not need it. you should probably not need it.
private_say private_say
- **message:** :py:class:`~sleekxmpp.Message` that will be sent - **message:** :py:class:`~slixmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.PrivateTab` source - **tab:** :py:class:`~tabs.PrivateTab` source
Triggered whenever the user sends a message to a :py:class:`~tabs.PrivateTab`. Triggered whenever the user sends a message to a :py:class:`~tabs.PrivateTab`.
private_say_after private_say_after
- **message:** :py:class:`~sleekxmpp.Message` that will be sent - **message:** :py:class:`~slixmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.PrivateTab` source - **tab:** :py:class:`~tabs.PrivateTab` source
Same thing than :term:`private_say`, but after XHTML generation of the body, if needed. Same thing than :term:`private_say`, but after XHTML generation of the body, if needed.
...@@ -44,13 +44,13 @@ The following events are poezio-only events, for SleekXMPP events, check out ...@@ -44,13 +44,13 @@ The following events are poezio-only events, for SleekXMPP events, check out
you should probably not need it. you should probably not need it.
conversation_say conversation_say
- **message:** :py:class:`~sleekxmpp.Message` that will be sent - **message:** :py:class:`~slixmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.ConversationTab` source - **tab:** :py:class:`~tabs.ConversationTab` source
Triggered whenever the user sends a message to a :py:class:`~tabs.ConversationTab`. Triggered whenever the user sends a message to a :py:class:`~tabs.ConversationTab`.
conversation_say_after: conversation_say_after:
- **message:** :py:class:`~sleekxmpp.Message` that will be sent - **message:** :py:class:`~slixmpp.Message` that will be sent
- **tab:** :py:class:`~tabs.ConversationTab` source - **tab:** :py:class:`~tabs.ConversationTab` source
Same thing than :term:`conversation_say`, but after XHTML generation Same thing than :term:`conversation_say`, but after XHTML generation
...@@ -60,101 +60,101 @@ The following events are poezio-only events, for SleekXMPP events, check out ...@@ -60,101 +60,101 @@ The following events are poezio-only events, for SleekXMPP events, check out
and you should probably not need it. and you should probably not need it.
muc_msg muc_msg
- **message:** :py:class:`~sleekxmpp.Message` received - **message:** :py:class:`~slixmpp.Message` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when a message is received in a :py:class:`~tabs.MucTab`. Triggered when a message is received in a :py:class:`~tabs.MucTab`.
private_msg private_msg
- **message:** :py:class:`~sleekxmpp.Message` received - **message:** :py:class:`~slixmpp.Message` received
- **tab:** :py:class:`~tabs.PrivateTab` source - **tab:** :py:class:`~tabs.PrivateTab` source
Triggered when a message is received in a :py:class:`~tabs.PrivateTab`. Triggered when a message is received in a :py:class:`~tabs.PrivateTab`.
conversation_msg conversation_msg
- **message:** :py:class:`~sleekxmpp.Message` received - **message:** :py:class:`~slixmpp.Message` received
- **tab:** :py:class:`~tabs.ConversationTab` source - **tab:** :py:class:`~tabs.ConversationTab` source
Triggered when a message is received in a :py:class:`~tabs.ConversationTab`. Triggered when a message is received in a :py:class:`~tabs.ConversationTab`.
conversation_chatstate conversation_chatstate
- **message:** :py:class:`~sleekxmpp.Message` received - **message:** :py:class:`~slixmpp.Message` received
- **tab:** :py:class:`~tabs.ConversationTab` source - **tab:** :py:class:`~tabs.ConversationTab` source
Triggered when a chatstate is received in a :py:class:`~tabs.ConversationTab`. Triggered when a chatstate is received in a :py:class:`~tabs.ConversationTab`.
muc_chatstate muc_chatstate
- **message:** :py:class:`~sleekxmpp.Message` received - **message:** :py:class:`~slixmpp.Message` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when a chatstate is received in a :py:class:`~tabs.MucTab`. Triggered when a chatstate is received in a :py:class:`~tabs.MucTab`.
private_chatstate private_chatstate
- **message:** :py:class:`~sleekxmpp.Message` received - **message:** :py:class:`~slixmpp.Message` received
- **tab:** :py:class:`PrivateTab <tabs.PrivateTab>` source - **tab:** :py:class:`PrivateTab <tabs.PrivateTab>` source
Triggered when a chatstate is received in a :py:class:`~tabs.PrivateTab`. Triggered when a chatstate is received in a :py:class:`~tabs.PrivateTab`.
normal_presence normal_presence
- **presence:** :py:class:`~sleekxmpp.Presence` received - **presence:** :py:class:`~slixmpp.Presence` received
- **resource:** :py:class:`Resource <str>` that emitted the :py:class:`~sleekxmpp.Presence` - **resource:** :py:class:`Resource <str>` that emitted the :py:class:`~slixmpp.Presence`
Triggered when a presence is received from a contact. Triggered when a presence is received from a contact.
muc_presence muc_presence
- **presence:** :py:class:`~sleekxmpp.Presence` received - **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when a presence is received from someone in a Triggered when a presence is received from someone in a
:py:class:`~tabs.MucTab`. :py:class:`~tabs.MucTab`.
joining_muc joining_muc
- **presence:** :py:class:`~~sleekxmpp.Presence` to be sent - **presence:** :py:class:`~~slixmpp.Presence` to be sent
Triggered when joining a MUC. The presence can thus be modified Triggered when joining a MUC. The presence can thus be modified
before being sent. before being sent.
changing_nick changing_nick
- **presence:** :py:class:`~~sleekxmpp.Presence` to be sent - **presence:** :py:class:`~~slixmpp.Presence` to be sent
Triggered when the user changes his/her nickname on a MUC. The Triggered when the user changes his/her nickname on a MUC. The
presence can thus be modified before being sent. presence can thus be modified before being sent.
send_normal_presence send_normal_presence
- **presence:** :py:class:`~sleekxmpp.Presence` sent - **presence:** :py:class:`~slixmpp.Presence` sent
Triggered when poezio sends a new :py:class:`~sleekxmpp.Presence` Triggered when poezio sends a new :py:class:`~slixmpp.Presence`
stanza. The presence can thus be modified before being sent. stanza. The presence can thus be modified before being sent.
muc_join muc_join
- **presence:** :py:class:`~sleekxmpp.Presence` received - **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when an user joins a :py:class:`~tabs.MucTab` Triggered when an user joins a :py:class:`~tabs.MucTab`
muc_ban muc_ban
- **presence:** :py:class:`~sleekxmpp.Presence` received - **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when an user from a :py:class:`~tabs.MucTab` Triggered when an user from a :py:class:`~tabs.MucTab`
gets banned. gets banned.
muc_kicked muc_kicked
- **presence:** :py:class:`~sleekxmpp.Presence` received - **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when an user from a :py:class:`~tabs.MucTab` Triggered when an user from a :py:class:`~tabs.MucTab`
gets kicked. gets kicked.
muc_nickchange muc_nickchange
- **presence:** :py:class:`~sleekxmpp.Presence` received - **presence:** :py:class:`~slixmpp.Presence` received
- **tab:** :py:class:`~tabs.MucTab` source - **tab:** :py:class:`~tabs.MucTab` source
Triggered when an user in a :py:class:`~tabs.MucTab` changes Triggered when an user in a :py:class:`~tabs.MucTab` changes
his nickname. his nickname.
ignored_private ignored_private
- **message**:py:class:`~sleekxmpp.Message` received - **message**:py:class:`~slixmpp.Message` received
- **tab:** :py:class:`~tabs.PrivateTab` source - **tab:** :py:class:`~tabs.PrivateTab` source
Triggered when a private message (that goes in a Triggered when a private message (that goes in a
......
...@@ -15,7 +15,7 @@ About plugins ...@@ -15,7 +15,7 @@ About plugins
plugin plugin
events events
sleek slix
xep xep
About Poezio About Poezio
......
SleekXMPP classes SleekXMPP classes
================= =================
.. module:: sleekxmpp .. module:: slixmpp
.. autoclass:: Message .. autoclass:: Message
:members: :members:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment