diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/en/weechat_plugin_api.en.txt | 116 | ||||
| -rw-r--r-- | doc/fr/weechat_plugin_api.fr.txt | 121 | ||||
| -rw-r--r-- | doc/it/weechat_plugin_api.it.txt | 124 |
3 files changed, 209 insertions, 152 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt index 7599bee6c..93844de12 100644 --- a/doc/en/weechat_plugin_api.en.txt +++ b/doc/en/weechat_plugin_api.en.txt @@ -6076,7 +6076,14 @@ const char *weechat_prefix (const char *prefix); Arguments: -* 'prefix': name of prefix: +* 'prefix': name of prefix (see table below) + +Return value: + +* prefix value (string with prefix and color codes), empty string if prefix is + not found + +List of prefixes: [width="70%",cols="^2e,^1,^3,5",options="header"] |=== @@ -6091,11 +6098,6 @@ Arguments: [NOTE] Values and colors can be customized with command `/set`. -Return value: - -* prefix value (string with prefix and color codes), empty string if prefix is - not found - C example: [source,C] @@ -6854,8 +6856,8 @@ struct t_hook *weechat_hook_process (const char *command, Arguments: -* 'command': command to launch in child process or URL _(WeeChat ≥ 0.3.7)_, - see below +* 'command': command to launch in child process or URL _(WeeChat ≥ 0.3.7)_ + (see below) * 'timeout': timeout for command (in milliseconds): after this timeout, child process is killed (0 means no timeout) * 'callback': function called when data from child is available, or when child @@ -7437,7 +7439,8 @@ 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>>), see table below + (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 @@ -8229,7 +8232,25 @@ struct t_hook *weechat_hook_hsignal (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 +** 'struct t_hashtable *hashtable': hashtable +** 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 hsignals: [width="100%",cols="^1,^3,5,5",options="header"] |=== @@ -8287,22 +8308,6 @@ Arguments: ^(1)^ 'xxx' is signal argument used in redirection, 'yyy' is redirection pattern. -* 'callback': function called when signal is received, arguments and return - value: -** 'void *data': pointer -** 'const char *signal': signal received -** 'struct t_hashtable *hashtable': hashtable -** 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] @@ -8824,7 +8829,21 @@ struct t_hook *weechat_hook_modifier (const char *modifier, Arguments: * 'modifier': modifier name, list of modifiers used by Weechat or plugins - (priority allowed, see note about <<hook_priority,priority>>): + (priority allowed, see note about <<hook_priority,priority>>) + (see table below) +* 'callback': function called when modifier is used, arguments and return value: +** 'void *data': pointer +** 'const char *modifier': name of modifier +** 'const char *modifier_data': data for modifier +** 'const char *string': string to modify +** return value: new string +* 'callback_data': pointer given to callback when it is called by WeeChat + +Return value: + +* pointer to new hook, NULL if error occurred + +List of modifiers used by WeeChat and plugins: [width="100%",cols="^2,3,4,4",options="header"] |=== @@ -8926,18 +8945,6 @@ Arguments: ^(1)^ 'xxx' is IRC command name. + ^(2)^ 'yyy' is bar name. -* 'callback': function called when modifier is used, arguments and return value: -** 'void *data': pointer -** 'const char *modifier': name of modifier -** 'const char *modifier_data': data for modifier -** 'const char *string': string to modify -** return value: new string -* '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] @@ -12109,8 +12116,7 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Arguments: -* 'info_name': name of info to read: -include::autogen/plugin_api/infos.txt[] +* 'info_name': name of info to read (see table below) * 'arguments': arguments for info asked (optional, NULL if no argument is needed) @@ -12118,6 +12124,10 @@ Return value: * string with info asked, NULL if an error occurred +Infos: + +include::autogen/plugin_api/infos.txt[] + C example: [source,C] @@ -12158,8 +12168,7 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Arguments: -* 'info_name': name of info to read: -include::autogen/plugin_api/infos_hashtable.txt[] +* 'info_name': name of info to read (see table below) * 'hashtable': hashtable with arguments (depends on info asked) (optional, NULL if no argument is needed) @@ -12167,6 +12176,10 @@ Return value: * hashtable with info asked, NULL if an error occurred +Infos: + +include::autogen/plugin_api/infos_hashtable.txt[] + C example: [source,C] @@ -12531,8 +12544,7 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Arguments: -* 'infolist_name': name of infolist to read: -include::autogen/plugin_api/infolists.txt[] +* 'infolist_name': name of infolist to read (see table below) * 'pointer': pointer to an item, to get only this item in infolist (optional, can be NULL) * 'arguments': arguments for infolist asked (optional, NULL if no argument is @@ -12542,6 +12554,10 @@ Return value: * pointer to infolist, NULL if an error occurred +Infolists: + +include::autogen/plugin_api/infolists.txt[] + C example: [source,C] @@ -13198,16 +13214,16 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Arguments: -* 'hdata_name': name of hdata - -List of hdata: - -include::autogen/plugin_api/hdata.txt[] +* 'hdata_name': name of hdata (see list below) Return value: * pointer to hdata, NULL if an error occurred +List of hdata: + +include::autogen/plugin_api/hdata.txt[] + C example: [source,C] diff --git a/doc/fr/weechat_plugin_api.fr.txt b/doc/fr/weechat_plugin_api.fr.txt index c7376c2c7..baa3ea70c 100644 --- a/doc/fr/weechat_plugin_api.fr.txt +++ b/doc/fr/weechat_plugin_api.fr.txt @@ -6152,7 +6152,14 @@ const char *weechat_prefix (const char *prefix); Paramètres : -* 'prefix' : nom du préfixe : +* 'prefix' : nom du préfixe (voir le tableau ci-dessous) + +Valeur de retour : + +* valeur du préfixe (chaîne avec le préfixe et des codes couleur), chaîne vide + si le préfixe n'a pas été trouvé + +Liste des préfixes : [width="70%",cols="^2e,^1,^3,5",options="header"] |=== @@ -6167,11 +6174,6 @@ Paramètres : [NOTE] Les valeurs et couleurs peuvent être configurées avec la commande `/set`. -Valeur de retour : - -* valeur du préfixe (chaîne avec le préfixe et des codes couleur), chaîne vide - si le préfixe n'a pas été trouvé - Exemple en C : [source,C] @@ -6956,7 +6958,7 @@ struct t_hook *weechat_hook_process (const char *command, Paramètres : * 'command' : commande à lancer dans le processus fils ou URL - _(WeeChat ≥ 0.3.7)_, voir ci-dessous + _(WeeChat ≥ 0.3.7)_ (voir ci-dessous) * 'timeout' : timeout pour la commande (en millisecondes) : après ce délai, le processus fils est tué (0 signifie pas de limite) * 'callback' : function appelée quand des données du fils sont disponibles, or @@ -7557,8 +7559,8 @@ 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é>>), - voir le tableau ci-dessous + (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 @@ -8359,7 +8361,26 @@ struct t_hook *weechat_hook_hsignal (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 +** 'struct t_hashtable *hashtable' : hashtable +** 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 hsignaux envoyés par WeeChat et les extensions : [width="100%",cols="^1,^3,5,5",options="header"] |=== @@ -8417,23 +8438,6 @@ Paramètres : ^(1)^ 'xxx' est l'argument "signal" utilisé dans la redirection, 'yyy' est le modèle de redirection ("pattern"). -* '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 -** 'struct t_hashtable *hashtable' : hashtable -** 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] @@ -8970,7 +8974,23 @@ Paramètres : * 'modifier' : nom du "modifieur", liste des "modifieurs" utilisés par WeeChat ou des extensions - (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 lorsque le "modifieur" est utilisé, paramètres + et valeur de retour : +** 'void *data' : pointeur +** 'const char *modifier' : nom du "modifieur" +** 'const char *modifier_data' : données pour le "modifieur" +** 'const char *string' : chaîne à modifier +** valeur de retour : nouvelle chaîne +* '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 modifieurs utilisés par WeeChat et les extensions : [width="100%",cols="^2,3,4,4",options="header"] |=== @@ -9077,20 +9097,6 @@ Paramètres : ^(1)^ 'xxx' est un nom de commande IRC. + ^(2)^ 'yyy' est le nom de la barre. -* 'callback' : fonction appelée lorsque le "modifieur" est utilisé, paramètres - et valeur de retour : -** 'void *data' : pointeur -** 'const char *modifier' : nom du "modifieur" -** 'const char *modifier_data' : données pour le "modifieur" -** 'const char *string' : chaîne à modifier -** valeur de retour : nouvelle chaîne -* '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] @@ -12325,8 +12331,7 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Paramètres : -* 'info_name' : nom de l'information à lire : -include::autogen/plugin_api/infos.txt[] +* 'info_name' : nom de l'information à lire (voir le tableau ci-dessous) * 'arguments' : paramètres pour l'information demandée (optionnels, NULL si aucun paramètre n'est nécessaire) @@ -12334,6 +12339,10 @@ Valeur de retour : * chaîne avec l'information demandée, NULL en cas d'erreur +Infos : + +include::autogen/plugin_api/infos.txt[] + Exemple en C : [source,C] @@ -12375,8 +12384,7 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Paramètres : -* 'info_name' : nom de l'information à lire : -include::autogen/plugin_api/infos_hashtable.txt[] +* 'info_name' : nom de l'information à lire (voir le tableau ci-dessous) * 'hashtable' : hashtable avec les paramètres (dépendant de l'information demandée) (optionnel, NULL si aucun paramètre n'est nécessaire) @@ -12384,6 +12392,10 @@ Valeur de retour : * hashtable avec l'information demandée, NULL en cas d'erreur +Infos : + +include::autogen/plugin_api/infos_hashtable.txt[] + Exemple en C : [source,C] @@ -12752,8 +12764,7 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Paramètres : -* 'infolist_name' : nom de l'infolist à lire : -include::autogen/plugin_api/infolists.txt[] +* 'infolist_name' : nom de l'infolist à lire (voir le tableau ci-dessous) * 'pointer' : pointeur vers un objet, pour n'obtenir que celui-ci dans l'infolist (optionnel, peut être NULL) * 'arguments' : paramètres pour l'infolist demandée (optionnels, NULL si aucun @@ -12763,6 +12774,10 @@ Valeur de retour : * pointeur vers l'infolist, NULL en cas d'erreur +Infolists : + +include::autogen/plugin_api/infolists.txt[] + Exemple en C : [source,C] @@ -13438,16 +13453,16 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Paramètres : -* 'hdata_name' : nom du hdata - -Liste des hdata : - -include::autogen/plugin_api/hdata.txt[] +* 'hdata_name' : nom du hdata (voir la liste ci-dessous) Valeur de retour : * pointeur vers le hdata, NULL en cas d'erreur +Liste des hdata : + +include::autogen/plugin_api/hdata.txt[] + Exemple en C : [source,C] diff --git a/doc/it/weechat_plugin_api.it.txt b/doc/it/weechat_plugin_api.it.txt index b5ddddca2..de4388e80 100644 --- a/doc/it/weechat_plugin_api.it.txt +++ b/doc/it/weechat_plugin_api.it.txt @@ -6151,7 +6151,16 @@ const char *weechat_prefix (const char *prefix); Argomenti: -* 'prefix': nome del prefisso: +// TRANSLATION MISSING +* 'prefix': nome del prefisso, see table below + +Valore restituito: + +* valore del prefisso (stringa con prefisso e codici colori), stringa vuota + se il prefisso non è stato trovato + +// TRANSLATION MISSING +List of prefixes: [width="70%",cols="^2e,^1,^3,5",options="header"] |=== @@ -6166,11 +6175,6 @@ Argomenti: [NOTE] Valori e colori possono essere personalizzati con il comando `/set`. -Valore restituito: - -* valore del prefisso (stringa con prefisso e codici colori), stringa vuota - se il prefisso non è stato trovato - Esempio in C: [source,C] @@ -8406,8 +8410,29 @@ struct t_hook *weechat_hook_hsignal (const char *signal, Argomenti: +// TRANSLATION MISSING * 'signal': segnale da catturare, può iniziare o terminare con "*" - (priorità consentita, consultare la nota a proposito di <<hook_priority,priority>>): + (priorità consentita, consultare la nota a proposito di <<hook_priority,priority>>), + see table below +* 'callback': funzione chiamata a segnale ricevuto, argomenti e valore + restituito: +** 'void *data': puntatore +** 'const char *signal': segnale ricevuto +** 'struct t_hashtable *hashtable': tabella hash +** 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 hsignals sent by WeeChat and plugins: [width="100%",cols="^1,^3,5,5",options="header"] |=== @@ -8471,23 +8496,6 @@ Argomenti: ^(1)^ 'xxx' è l'argomento del segnale usato nella redirezione, 'yyy' è lo schema di redirezione. -* 'callback': funzione chiamata a segnale ricevuto, argomenti e valore - restituito: -** 'void *data': puntatore -** 'const char *signal': segnale ricevuto -** 'struct t_hashtable *hashtable': tabella hash -** 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] @@ -9015,10 +9023,25 @@ struct t_hook *weechat_hook_modifier (const char *modifier, Argomenti: +// TRANSLATION MISSING * 'modifier': nome modificatore, lista di modificatori utilizzati da Weechat o dai plugin (priorità consentita, consultare la nota riguardo la - <<hook_priority,priority>>) + <<hook_priority,priority>>), see table below +* 'callback': funzione chiamata quando viene usato il modificatore, + argomenti e valore restituito: +** 'void *data': puntatore +** 'const char *modifier': nome del modificatore +** 'const char *modifier_data': dati per il modificatore +** 'const char *string': stringa da modificare +** valore restituito: nuova stringa +* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat + +Valore restituito: + +* puntatore al nuovo hook, NULL in caso di errore + +List of modifiers used by WeeChat and plugins: [width="100%",cols="^2,3,4,4",options="header"] |=== @@ -9122,19 +9145,6 @@ Argomenti: ^(1)^ 'xxx' è il nome del comando IRC. + ^(2)^ 'yyy' è il nome della barra. -* 'callback': funzione chiamata quando viene usato il modificatore, - argomenti e valore restituito: -** 'void *data': puntatore -** 'const char *modifier': nome del modificatore -** 'const char *modifier_data': dati per il modificatore -** 'const char *string': stringa da modificare -** valore restituito: nuova stringa -* '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] @@ -12397,8 +12407,8 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Argomenti: -* 'info_name': nome delle informazioni da leggere: -include::autogen/plugin_api/infos.txt[] +// TRANSLATION MISSING +* 'info_name': nome delle informazioni da leggere (see table below) * 'arguments': argomenti per l'informazione richiesta (opzionake, NULL se non è richiesto alcun argomento) @@ -12406,6 +12416,11 @@ Valore restituito: * stringa con l'informazione richiesta, NULL in caso di errore +// TRANSLATION MISSING +Infos: + +include::autogen/plugin_api/infos.txt[] + Esempio in C: [source,C] @@ -12446,8 +12461,8 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Argomenti: -* 'info_name': nome della info da leggere -include::autogen/plugin_api/infos_hashtable.txt[] +// TRANSLATION MISSING +* 'info_name': nome della info da leggere (see table below) * 'hashtable': tabella hash con argomenti (dipende dalla info richiesta) * (opzionale, NULL se l'argomento non viene richiesto) @@ -12455,6 +12470,11 @@ Valore restituito: * tabella hash con la info richiesta, NULL in caso di errore +// TRANSLATION MISSING +Infos: + +include::autogen/plugin_api/infos_hashtable.txt[] + Esempio in C: [source,C] @@ -12824,8 +12844,8 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Argomenti: -* 'infolist_name': nome della lista info da leggere: -include::autogen/plugin_api/infolists.txt[] +// TRANSLATION MISSING +* 'infolist_name': nome della lista info da leggere (see table below) * 'pointer': puntatore ad un elemento, per ricevere solo questo elemento nella lista info (opzionale, può essere NULL) * 'arguments': argomenti per la lista info richiesta (opzionale, NULL se @@ -12835,6 +12855,11 @@ Valore restituito: * puntatore alla lista info, NULL in caso di errore +// TRANSLATION MISSING +Infolists: + +include::autogen/plugin_api/infolists.txt[] + Esempio in C: [source,C] @@ -13511,17 +13536,18 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Argomenti: -* 'hdata_name': nome di un hdata - // TRANSLATION MISSING -List of hdata: - -include::autogen/plugin_api/hdata.txt[] +* 'hdata_name': nome di un hdata (see list below) Valore restituito: * puntatore ad un hdata, NULL in caso di errore +// TRANSLATION MISSING +List of hdata: + +include::autogen/plugin_api/hdata.txt[] + Esempio in C: [source,C] |