doc: move table with signals below all arguments and return value in function hook_signal (plugin API reference)

v2.8-utf8proc
Sebastien Helleu 2014-01-12 13:09:58 +01:00
parent 52f2d5bf13
commit 8b3d8fdfe5
3 changed files with 71 additions and 65 deletions

View File

@ -7437,7 +7437,28 @@ struct t_hook *weechat_hook_signal (const char *signal,
Arguments:
* 'signal': signal to catch, can begin or end with "*"
(priority allowed, see note about <<hook_priority,priority>>):
(priority allowed, see note about <<hook_priority,priority>>), see table below
* 'callback': function called when signal is received, arguments and return
value:
** 'void *data': pointer
** 'const char *signal': signal received
** 'const char *type_data': type of data sent with signal:
*** 'WEECHAT_HOOK_SIGNAL_STRING': string
*** 'WEECHAT_HOOK_SIGNAL_INT': integer number
*** 'WEECHAT_HOOK_SIGNAL_POINTER': pointer
** 'void *signal_data': data sent with signal
** return value:
*** 'WEECHAT_RC_OK'
*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately)
_(WeeChat ≥ 0.4.0)_
*** 'WEECHAT_RC_ERROR'
* 'callback_data': pointer given to callback when it is called by WeeChat
Return value:
* pointer to new hook, NULL if error occurred
List of signals sent by WeeChat and plugins:
[width="100%",cols="^1,^3,4,5",options="header"]
|===
@ -7974,26 +7995,6 @@ Arguments:
[NOTE]
^(1)^ 'xxx' is IRC server name, 'yyy' is IRC command name.
* 'callback': function called when signal is received, arguments and return
value:
** 'void *data': pointer
** 'const char *signal': signal received
** 'const char *type_data': type of data sent with signal:
*** 'WEECHAT_HOOK_SIGNAL_STRING': string
*** 'WEECHAT_HOOK_SIGNAL_INT': integer number
*** 'WEECHAT_HOOK_SIGNAL_POINTER': pointer
** 'void *signal_data': data sent with signal
** return value:
*** 'WEECHAT_RC_OK'
*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately)
_(WeeChat ≥ 0.4.0)_
*** 'WEECHAT_RC_ERROR'
* 'callback_data': pointer given to callback when it is called by WeeChat
Return value:
* pointer to new hook, NULL if error occurred
C example:
[source,C]

View File

@ -7555,7 +7555,30 @@ struct t_hook *weechat_hook_signal (const char *signal,
Paramètres :
* 'signal' : signal à intercepter, peut commencer ou se terminer par "*"
(priorité autorisée, voir la note sur la <<hook_priority,priorité>>) :
(priorité autorisée, voir la note sur la <<hook_priority,priorité>>),
voir le tableau ci-dessous
* 'callback' : fonction appelée quand le signal est reçu, paramètres et valeur
de retour :
** 'void *data' : pointeur
** 'const char *signal' : signal reçu
** 'const char *type_data' : type de donnée reçu avec le signal :
*** 'WEECHAT_HOOK_SIGNAL_STRING' : chaîne de caractères
*** 'WEECHAT_HOOK_SIGNAL_INT' : nombre entier
*** 'WEECHAT_HOOK_SIGNAL_POINTER' : pointeur
** 'void *signal_data' : données envoyées avec le signal
** valeur de retour :
*** 'WEECHAT_RC_OK'
*** 'WEECHAT_RC_OK_EAT' (arrêter l'envoi du signal immédiatement)
_(WeeChat ≥ 0.4.0)_
*** 'WEECHAT_RC_ERROR'
* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par
WeeChat
Valeur de retour :
* pointeur vers le nouveau "hook", NULL en cas d'erreur
Liste des signaux envoyés par WeeChat et les extensions :
[width="100%",cols="^1,^3,^4,5",options="header"]
|===
@ -8092,27 +8115,6 @@ Paramètres :
[NOTE]
^(1)^ 'xxx' est le nom du serveur IRC, 'yyy' est le nom d'une commande IRC.
* 'callback' : fonction appelée quand le signal est reçu, paramètres et valeur
de retour :
** 'void *data' : pointeur
** 'const char *signal' : signal reçu
** 'const char *type_data' : type de donnée reçu avec le signal :
*** 'WEECHAT_HOOK_SIGNAL_STRING' : chaîne de caractères
*** 'WEECHAT_HOOK_SIGNAL_INT' : nombre entier
*** 'WEECHAT_HOOK_SIGNAL_POINTER' : pointeur
** 'void *signal_data' : données envoyées avec le signal
** valeur de retour :
*** 'WEECHAT_RC_OK'
*** 'WEECHAT_RC_OK_EAT' (arrêter l'envoi du signal immédiatement)
_(WeeChat ≥ 0.4.0)_
*** 'WEECHAT_RC_ERROR'
* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par
WeeChat
Valeur de retour :
* pointeur vers le nouveau "hook", NULL en cas d'erreur
Exemple en C :
[source,C]

View File

@ -7548,9 +7548,33 @@ struct t_hook *weechat_hook_signal (const char *signal,
Argomenti:
// TRANSLATION MISSING
* 'signal': segnale da catturare, può iniziare o terminare con "*"
(priorità consentita, consultare la nota riguardo la
<<hook_priority,priority>>):
<<hook_priority,priority>>), see table below
* 'callback': funzione chiamata a segnale ricevuto, argomenti e valore
restituito:
** 'void *data': puntatore
** 'const char *signal': segnale ricevuto
** 'const char *type_data': tipo di dati inviati con il segnale:
*** 'WEECHAT_HOOK_SIGNAL_STRING': stringa
*** 'WEECHAT_HOOK_SIGNAL_INT': numero intero
*** 'WEECHAT_HOOK_SIGNAL_POINTER': puntatore
** 'void *signal_data': dati inviati con il segnale
** valore restituito:
*** 'WEECHAT_RC_OK'
// TRANSLATION MISSING
*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately)
_(WeeChat ≥ 0.4.0)_
*** 'WEECHAT_RC_ERROR'
* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat
Valore restituito:
* puntatore al nuovo hook, NULL in caso di errore
// TRANSLATION MISSING
List of signals sent by WeeChat and plugins:
[width="100%",cols="^1,^3,^4,5",options="header"]
|===
@ -8140,27 +8164,6 @@ Argomenti:
[NOTE]
^(1)^ 'xxx' è il nome del server IRC, 'yyy' è il nome del comando IRC.
* 'callback': funzione chiamata a segnale ricevuto, argomenti e valore
restituito:
** 'void *data': puntatore
** 'const char *signal': segnale ricevuto
** 'const char *type_data': tipo di dati inviati con il segnale:
*** 'WEECHAT_HOOK_SIGNAL_STRING': stringa
*** 'WEECHAT_HOOK_SIGNAL_INT': numero intero
*** 'WEECHAT_HOOK_SIGNAL_POINTER': puntatore
** 'void *signal_data': dati inviati con il segnale
** valore restituito:
*** 'WEECHAT_RC_OK'
// TRANSLATION MISSING
*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately)
_(WeeChat ≥ 0.4.0)_
*** 'WEECHAT_RC_ERROR'
* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat
Valore restituito:
* puntatore al nuovo hook, NULL in caso di errore
Esempio in C:
[source,C]