diff options
| -rw-r--r-- | doc/en/weechat_plugin_api.en.txt | 189 | ||||
| -rw-r--r-- | doc/fr/weechat_plugin_api.fr.txt | 192 | ||||
| -rw-r--r-- | doc/it/weechat_plugin_api.it.txt | 208 |
3 files changed, 464 insertions, 125 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt index 7b60242be..95275789f 100644 --- a/doc/en/weechat_plugin_api.en.txt +++ b/doc/en/weechat_plugin_api.en.txt @@ -2975,10 +2975,20 @@ Arguments: ** 'WEECHAT_HASHTABLE_TIME' * 'callback_hash_key': callback used to "hash" a key (key as integer value), can be NULL if key type is "string" (a default function is used for strings, and - only for strings) + only for strings), arguments and return value: +** 'struct t_hashtable *hashtable': hashtable pointer +** 'const void *key': key +** return value: hash of the key * 'callback_keycmp': callback used to compare two keys, can be NULL if value type is "string" (a default comparison function is used for strings, and only - for strings) + for strings), arguments and return value: +** 'struct t_hashtable *hashtable': hashtable pointer +** 'const void *key1': first key +** 'const void *key2': second key +** return value: +*** negative number if 'key1' is less than 'key2' +*** 0 if 'key1' equals 'key2' +*** positive number if 'key1' is greater than 'key2' Return value: @@ -3471,9 +3481,13 @@ Arguments: * 'name': name of configuration file (without path or extension) * 'callback_reload': function called when configuration file is reloaded with - `/reload` (optional, can be NULL), arguments: + `/reload` (optional, can be NULL), arguments and return value: ** 'void *data': pointer ** 'struct t_config_file *config_file': configuration file pointer +** return value: +*** 'WEECHAT_CONFIG_READ_OK' +*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' +*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' * 'callback_reload_data': pointer given to reload callback when it is called by WeeChat @@ -3571,45 +3585,67 @@ Arguments: it is forbidden * 'callback_read': function called when an option in section is read from disk (should be NULL in most cases, except if options in section need custom - function), arguments: + function), arguments and return value: ** 'void *data': pointer ** 'struct t_config_file *config_file': configuration file pointer ** 'struct t_config_section *section': section pointer ** 'const char *option_name': name of option ** 'const char *value': value +** return value: +*** 'WEECHAT_CONFIG_READ_OK' +*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' +*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' * 'callback_read_data': pointer given to callback when it is called by WeeChat * 'callback_write': function called when section is written in file (should be NULL for most cases, except if section needs to be written by a custom - function), arguments: + function), arguments and return value: ** 'void *data': pointer ** 'struct t_config_file *config_file': configuration file pointer ** 'struct t_config_section *section': section pointer ** 'const char *option_name': name of option +** return value: +*** 'WEECHAT_CONFIG_WRITE_OK' +*** 'WEECHAT_CONFIG_WRITE_ERROR' +*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' * callback_write_data: pointer given to callback when it is called by WeeChat * callback_write_default: function called when default values for section must be written in file, arguments: ** 'void *data': pointer ** 'struct t_config_file *config_file': configuration file pointer ** 'const char *section_name': name of section +** return value: +*** 'WEECHAT_CONFIG_WRITE_OK' +*** 'WEECHAT_CONFIG_WRITE_ERROR' +*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' * 'callback_write_default_data': pointer given to callback when it is called by WeeChat * 'callback_create_option': function called when a new option is created in section (NULL if section does not allow new options to be created), - arguments: + arguments and return value: ** 'void *data': pointer ** 'struct t_config_file *config_file': configuration file pointer ** 'struct t_config_section *section': section pointer ** 'const char *option_name': name of option ** 'const char *value': value +** return value: +*** 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' +*** 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' +*** 'WEECHAT_CONFIG_OPTION_SET_ERROR' +*** 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' * 'callback_create_option_data': pointer given to callback when it is called by WeeChat * 'callback_delete_option': function called when an option is deleted in section (NULL if section does not allow options to be deleted), - arguments: + arguments and return value: ** 'void *data': pointer ** 'struct t_config_file *config_file': configuration file pointer ** 'struct t_config_section *section': section pointer ** 'struct t_config_option *option': option pointer +** return value: +*** 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' +*** 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' +*** 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' +*** 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' * 'callback_delete_option_data': pointer given to callback when it is called by WeeChat @@ -3835,22 +3871,31 @@ Arguments: * 'null_value_allowed': 1 if 'null' (undefined value) is allowed for option, otherwise 0 * 'callback_check_value': function called to check new value for option - (optional), arguments: + (optional), arguments and return value: ** 'void *data': pointer ** 'struct t_config_option *option': option pointer ** 'const char *value': new value for option +** return value: +*** 1 if value is ok +*** 0 if value is invalid * 'callback_check_value_data': pointer given to check_value callback when it is called by WeeChat * 'callback_change': function called when value of option has changed - (optional), arguments: + (optional), arguments and return value: ** 'void *data': pointer ** 'struct t_config_option *option': option pointer +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_change_data': pointer given to change callback when it is called by WeeChat * 'callback_delete': function called when option will be deleted (optional), - arguments: + arguments and return value: ** 'void *data': pointer ** 'struct t_config_option *option': option pointer +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_delete_data': pointer given to delete callback when it is called by WeeChat @@ -6038,13 +6083,16 @@ Arguments: argument, separated by space. Many completions are possible for one argument, separated by "|". Many templates are possible for same command, separated by "||". -* 'callback': function called when command is used, arguments: +* 'callback': function called when command is used, arguments and return value: ** 'void *data': pointer ** 'struct t_gui_buffer *buffer': buffer where command is executed ** 'int argc': number of arguments given for command ** 'char **argv': arguments given for command ** 'char **argv_eol': arguments given for command (until end of line for each argument) +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Default completion codes are: @@ -6154,10 +6202,14 @@ Arguments: * 'command': command to hook, can start or end with "*" as wildcard (priority allowed, see note about <<hook_priority,priority>>) -* 'callback': function called when command is run, arguments: +* 'callback': function called when command is run, arguments and return value: ** 'void *data': pointer ** 'struct t_gui_buffer *buffer': buffer where command is executed ** 'const char *command': the command executed, with its arguments +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_OK_EAT' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat [NOTE] @@ -6225,9 +6277,12 @@ Arguments: if interval = 60000 (60 seconds), and align_second = 60, then timer is called each minute when second is 00 * 'max_calls': number of calls to timer (if 0, then timer has no end) -* 'callback': function called when time is reached, arguments: +* 'callback': function called when time is reached, arguments and return value: ** 'void *data': pointer ** 'int remaining_calls': remaining calls (-1 if timer has no end) +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -6291,9 +6346,12 @@ Arguments: * 'flag_write': 1 = catch write event, 0 = ignore * 'flag_exception': 1 = catch exception event, 0 = ignore * 'callback': function called a selected event occurs for file (or socket), - arguments: + arguments and return value: ** 'void *data': pointer ** 'int fd': file descriptor +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -6359,7 +6417,7 @@ Arguments: * '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 - has ended, arguments: + has ended, arguments and return value: ** 'void *data': pointer ** 'const char *command': command executed by child ** 'int return_code': return code: @@ -6368,6 +6426,9 @@ Arguments: running) or 'WEECHAT_HOOK_PROCESS_ERROR' (error when launching command) ** 'out': standard output of command (stdout) ** 'err': error output of command (stderr) +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -6486,7 +6547,8 @@ Arguments: * 'gnutls_dhkey_size': size of the key used during the Diffie-Hellman Key Exchange (GnuTLS) * 'local_hostname': local hostname to use for connection (optional) -* 'callback': function called when connection is ok or failed, arguments: +* 'callback': function called when connection is ok or failed, arguments and + return value: ** 'void *data': pointer ** 'int status': connection status: *** 'WEECHAT_HOOK_CONNECT_OK': connection ok @@ -6501,6 +6563,9 @@ Arguments: ** 'gnutls_rc': result value of 'gnutls_handshake()' ** 'const char *error': result value of 'gnutls_strerror(gnutls_rc)' ** 'const char *ip_address': IP address found +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -6623,7 +6688,8 @@ Arguments: * 'message': only messages with this string will be caught (optional) * 'strip_colors': if 1, colors will be stripped from message displayed, before calling callback -* 'callback': function called when a message is printed, arguments: +* 'callback': function called when a message is printed, arguments and return + value: ** 'void *data': pointer ** 'struct t_gui_buffer *buffer': buffer pointer ** 'time_t date': date @@ -6633,6 +6699,9 @@ Arguments: ** 'int highlight': 1 if line has highlight, otherwise 0 ** 'const char *prefix': prefix ** 'const char *message': message +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -6906,7 +6975,8 @@ Arguments: [NOTE] ^(1)^ 'xxx' is IRC server name, 'yyy' is IRC command name. -* 'callback': function called when signal is received, arguments: +* '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: @@ -6914,6 +6984,9 @@ Arguments: *** '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_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -7174,10 +7247,14 @@ Arguments: ^(1)^ 'xxx' is signal argument used in redirection, 'yyy' is redirection pattern. -* 'callback': function called when signal is received, arguments: +* '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_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -7444,10 +7521,14 @@ Arguments: * 'option': option, format is full name, as used with command `/set` (for example: `weechat.look.item_time_format`) (priority allowed, see note about <<hook_priority,priority>>) -* 'callback': function called when configuration option is changed, arguments: +* 'callback': function called when configuration option is changed, arguments + and return value: ** 'void *data': pointer ** 'const char *option': name of option ** 'const char *value': new value for option +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -7511,13 +7592,16 @@ Arguments: (priority allowed, see note about <<hook_priority,priority>>) * 'description': description of completion * 'callback': function called when completion item is used (user is completing - something using this item), arguments: + something using this item), arguments and return value: ** 'void *data': pointer ** 'const char *completion_item': name of completion item ** 'struct t_gui_buffer *buffer': buffer where completion is made ** 'struct t_gui_completion *completion': structure used to add words for completion (see <<_weechat_hook_completion_list_add,weechat_hook_completion_list_add>>) +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat [NOTE] @@ -7758,12 +7842,12 @@ Arguments: ^(1)^ 'xxx' is IRC command name. + ^(2)^ 'yyy' is bar name. -* 'callback': function called when modifier is used, arguments: +* '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 (function must return copy of this - string, no changes are allowed in this string) +** 'const char *string': string to modify +** return value: new string * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -7881,10 +7965,11 @@ Arguments: (priority allowed, see note about <<hook_priority,priority>>) * 'description': description * 'args_description': description of arguments (optional, can be NULL) -* 'callback': function called when info is asked, arguments: +* 'callback': function called when info is asked, arguments and return value: ** 'void *data': pointer ** 'const char *info_name': name of info ** 'const char *arguments': additional arguments, depending on info +** return value: value of info asked * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -7953,10 +8038,11 @@ Arguments: * 'args_description': description of expected hashtable (optional, can be NULL) * 'output_description': description of hashtable returned by callback (optional, can be NULL) -* 'callback': function called when info is asked, arguments: +* 'callback': function called when info is asked, arguments and return value: ** 'void *data': pointer ** 'const char *info_name': name of info ** 'struct t_hashtable *hashtable': hashtable, depending on info +** return value: hashtable asked * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -8013,10 +8099,10 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, const char *description, const char *pointer_description, const char *args_description, - const char *(*callback)(void *data, - const char *infolist_name, - void *pointer, - const char *arguments), + struct t_infolist *(*callback)(void *data, + const char *infolist_name, + void *pointer, + const char *arguments), void *callback_data); ---------------------------------------- @@ -8027,12 +8113,14 @@ Arguments: * 'description': description * 'pointer_description': description of pointer (optional, can be NULL) * 'args_description': description of arguments (optional, can be NULL) -* 'callback': function called when infolist is asked, arguments: +* 'callback': function called when infolist is asked, arguments and return + value: ** 'void *data': pointer ** 'const char *infolist_name': name of infolist ** 'void *pointer': pointer to an object that infolist must return (to get only one item in infolist) ** 'const char *arguments': additional arguments, depending on infolist +** return value: infolist asked * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -8177,14 +8265,21 @@ Arguments: * 'name': name of buffer (must be unique for plugin) * 'input_callback': function called when input text is entered on buffer, - arguments: -*** 'void *data': pointer -*** 'struct t_gui_buffer *buffer': buffer pointer -*** 'const char *input_data': input data + arguments and return value: +** 'void *data': pointer +** 'struct t_gui_buffer *buffer': buffer pointer +** 'const char *input_data': input data +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat -* 'close_callback': function called when buffer is closed, arguments: -*** 'void *data': pointer -*** 'struct t_gui_buffer *buffer': buffer pointer +* 'close_callback': function called when buffer is closed, arguments and return + value: +** 'void *data': pointer +** 'struct t_gui_buffer *buffer': buffer pointer +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Return value: @@ -10061,8 +10156,12 @@ struct t_gui_bar_item *weechat_bar_item_new (const char *name, Arguments: * 'name': bar item name -* 'build_callback': function called when bar item is built: it must return - content of bar item +* 'build_callback': function called when bar item is built, arguments and + return value: +** 'void *data': pointer +** 'struct t_gui_bar_item *item': item pointer +** 'struct t_gui_window *window': window pointer +** return value: content of bar item * 'build_callback_data': pointer given to build callback, when it is called by WeeChat @@ -11565,7 +11664,15 @@ int weechat_upgrade_read (struct t_upgrade_file *upgrade_file, Arguments: * 'upgrade_file': upgrade file pointer -* 'callback_read': function called for each object read in upgrade file +* 'callback_read': function called for each object read in upgrade file, + arguments and return value: +** 'void *data': pointer +** 'struct t_upgrade_file *upgrade_file': pointer to upgrade file +** 'int object_id': object id +** 'struct t_infolist *infolist': infolist with content of object +** return value: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_read_data': pointer given to read callback when it is called by WeeChat diff --git a/doc/fr/weechat_plugin_api.fr.txt b/doc/fr/weechat_plugin_api.fr.txt index 255862bf5..43e9b9c53 100644 --- a/doc/fr/weechat_plugin_api.fr.txt +++ b/doc/fr/weechat_plugin_api.fr.txt @@ -3006,10 +3006,20 @@ Paramètres : * 'callback_hash_key' : fonction appelée pour rendre le "hash" d'une clé (la clé sous forme de nombre entier), peut être NULL si le type de clé est "string" (une fonction par défaut est utilisée pour les chaînes, et seulement pour les - chaînes) + chaînes). Paramètres et valeur de retour : +** 'struct t_hashtable *hashtable' : pointeur vers la hashtable +** 'const void *key' : clé +** valeur de retour : "hash" de la clé * 'callback_keycmp' : fonction appelée pour comparer deux clés, peut être NULL si le type de valeur est "string" (une fonction par défaut est utilisée pour - les chaînes, et seulement pour les chaînes) + les chaînes, et seulement pour les chaînes). Paramètres et valeur de retour : +** 'struct t_hashtable *hashtable' : pointeur vers la hashtable +** 'const void *key1' : première clé +** 'const void *key2' : seconde clé +** valeur de retour : +*** nombre négatif si 'key1' est inférieur à 'key2' +*** 0 si 'key1' est égal à 'key2' +*** nombre positif si 'key1' est supérieur à 'key2' Valeur de retour : @@ -3504,10 +3514,15 @@ Paramètres : * 'name' : nom du nouveau fichier de configuration (sans chemin ou extension) * 'callback_reload' : fonction appelée quand le fichier de configuration est - rechargé avec `/reload` (optionnel, peut être NULL), paramètres : + rechargé avec `/reload` (optionnel, peut être NULL), paramètres et valeur de + retour : ** 'void *data' : pointeur ** 'struct t_config_file *config_file' : pointeur vers le fichier de configuration +** valeur de retour : +*** 'WEECHAT_CONFIG_READ_OK' +*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' +*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' * 'callback_reload_data' : pointeur donné au "callback" de rechargement lorsqu'il est appelé par WeeChat @@ -3605,36 +3620,50 @@ Paramètres : dans la section, ou 0 si c'est interdit * 'callback_read' : fonction appelée quand une option de la section est lue depuis le disque (devrait être NULL dans la plupart des cas, sauf si des - options de la section nécessitent une fonction personnalisée), paramètres : + options de la section nécessitent une fonction personnalisée), paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_file *config_file' : pointeur vers le fichier de configuration ** 'struct t_config_section *section' : pointeur vers la section ** 'const char *option_name' : nom de l'option ** 'const char *value' : valeur +** valeur de retour : +*** 'WEECHAT_CONFIG_READ_OK' +*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' +*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' * 'callback_read_data' : pointeur donné au "callback" quand il est appelé par WeeChat * 'callback_write' : fonction appelée lorsque la section est écrite dans le fichier (devrait être NULL dans la plupart des cas, sauf si la section - nécessite d'être écrite par une fonction personnalisée), paramètres : + nécessite d'être écrite par une fonction personnalisée), paramètres et valeur + de retour : ** 'void *data' : pointeur ** 'struct t_config_file *config_file' : pointeur vers le fichier de configuration ** 'struct t_config_section *section' : pointeur vers la section ** 'const char *option_name' : nom de l'option +** valeur de retour : +*** 'WEECHAT_CONFIG_WRITE_OK' +*** 'WEECHAT_CONFIG_WRITE_ERROR' +*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' * callback_write_data : pointeur donné au "callback" lorsqu'il est appelé par WeeChat * callback_write_default : fonction appelée lorsque les valeurs par défaut - doivent être écrites dans le fichier, paramètres : + doivent être écrites dans le fichier, paramètres et valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_file *config_file' : pointeur vers le fichier de configuration ** 'const char *section_name' : nom de la section +** valeur de retour : +*** 'WEECHAT_CONFIG_WRITE_OK' +*** 'WEECHAT_CONFIG_WRITE_ERROR' +*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' * 'callback_write_default_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat * 'callback_create_option' : fonction appelée lorsqu'une nouvelle option est créée dans la section (NULL si la section n'autorise pas la création de - nouvelles options), paramètres : + nouvelles options), paramètres et valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_file *config_file' : pointeur vers le fichier de configuration @@ -3645,12 +3674,17 @@ Paramètres : appelé par WeeChat * 'callback_delete_option' : fonction appelée lorsqu'une option est supprimée de la section (NULL si la section n'autorise pas la suppression d'options), - paramètres : + paramètres et valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_file *config_file' : pointeur vers le fichier de configuration ** 'struct t_config_section *section' : pointeur vers la section ** 'struct t_config_option *option' : pointeur vers l'option +** valeur de retour : +*** 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' +*** 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' +*** 'WEECHAT_CONFIG_OPTION_SET_ERROR' +*** 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' * 'callback_delete_option_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -3878,22 +3912,31 @@ Paramètres : * 'null_value_allowed' : 1 si 'null' (valeur non définie) est autorisé pour l'option, sinon 0 * 'callback_check_value' : fonction appelée pour vérifier la nouvelle valeur - de l'option (optionnel), paramètres : + de l'option (optionnel), paramètres et valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_option *option' : pointeur vers l'option ** 'const char *value' : nouvelle valeur pour l'option +** valeur de retour : +*** 1 si la valeur est ok +*** 0 si la valeur est invalide * 'callback_check_value_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat * 'callback_change' : fonction appelée lorsque la valeur de l'option a changé - (optionnel), paramètres : + (optionnel), paramètres et valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_option *option' : pointeur vers l'option +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_change_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat * 'callback_delete' : fonction appelée lorsque l'option est supprimée - (optionnel), paramètres : + (optionnel), paramètres et valeur de retour : ** 'void *data' : pointeur ** 'struct t_config_option *option' : pointeur vers l'option +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_delete_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6109,13 +6152,17 @@ Paramètres : complétions sont possibles pour un paramètre, séparées par "|". Plusieurs modèles de complétions sont possibles pour une même commande, séparés par "||". -* 'callback' : fonction appelée lorsque la commande est utilisée, paramètres : +* 'callback' : fonction appelée lorsque la commande est utilisée, paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'struct t_gui_buffer *buffer' : tampon où la commande est exécutée ** 'int argc' : nombre de paramètres passés à la commande ** 'char **argv' : paramètres pour la commande ** 'char **argv_eol' : paramètres pour la commande (jusqu'à fin de ligne pour chaque paramètre) +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6227,10 +6274,15 @@ Paramètres : * 'command' : commande à intercepter, peut commencer ou se terminer par le caractère joker "*" (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'callback' : fonction appelée lorsque la commande est exécutée, paramètres : +* 'callback' : fonction appelée lorsque la commande est exécutée, paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'struct t_gui_buffer *buffer' : tampon où la command est exécutée ** 'const char *command' : la commande exécutée, avec ses paramètres +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_OK_EAT' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6300,10 +6352,14 @@ Paramètres : alors le timer sera appelé chaque minutes quand la seconde sera 00 * 'max_calls' : nombre maximum d'appels au timer (si 0, le timer n'a pas de fin) -* 'callback' : fonction appelée quand le délai est atteint, paramètres : +* 'callback' : fonction appelée quand le délai est atteint, paramètres et valeur + de retour : ** 'void *data' : pointeur ** 'int remaining_calls' : nombre d'appels restants (-1 si le timer n'a pas de fin) +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6368,9 +6424,12 @@ Paramètres : * 'flag_write' : 1 = intercepter un évènement d'éctiture, 0 = ignorer * 'flag_exception' : 1 = intercepter un évènement d'exception, 0 = ignorer * 'callback' : fonction appelée lorsqu'un des évènements sélectionnés se - produit pour le fichier (ou la socket), paramètres : + produit pour le fichier (ou la socket), paramètres et valeur de retour : ** 'void *data' : pointeur ** 'int fd' : descripteur de fichier +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6437,7 +6496,7 @@ Paramètres : * '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 - ou quand le fils s'est terminé, paramètres : + ou quand le fils s'est terminé, paramètres et valeur de retour : ** 'void *data' : pointeur ** 'const char *command' : commande exécutée par le fils ** 'int return_code' : code retour : @@ -6447,6 +6506,9 @@ Paramètres : la commande) ** 'out' : sortie standard de la commande (stdout) ** 'err' : erreurs de la commande (stderr) +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6570,7 +6632,7 @@ Paramètres : * 'local_hostname' : nom de machine local à utiliser pour la connexion (optionnel) * 'callback' : fonction appelée lorsque la connexion est ok ou a échoué, - paramètres : + paramètres et valeur de retour : ** 'void *data' : pointeur ** 'int status' : connection status : *** 'WEECHAT_HOOK_CONNECT_OK' : connextion ok @@ -6586,6 +6648,9 @@ Paramètres : ** 'gnutls_rc' : valeur retour de 'gnutls_handshake()' ** 'const char *error' : valeur retour de 'gnutls_strerror(gnutls_rc)' ** 'const char *ip_address' : adresse IP trouvée +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6711,7 +6776,8 @@ Paramètres : (optionnel) * 'strip_colors' : si 1, les couleurs seront supprimées du message affiché, avant d'appeler le "callback" -* 'callback' : fonction appelée lorsqu'un message est affiché, paramètres : +* 'callback' : fonction appelée lorsqu'un message est affiché, paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'struct t_gui_buffer *buffer' : pointeur vers le tampon ** 'time_t date' : date @@ -6721,6 +6787,9 @@ Paramètres : ** 'int highlight' : 1 si la ligne contient un highlight, sinon 0 ** 'const char *prefix' : préfixe ** 'const char *message' : message +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -6995,7 +7064,8 @@ 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 : +* '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 : @@ -7003,6 +7073,9 @@ Paramètres : *** '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_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -7272,10 +7345,14 @@ 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 : +* '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_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -7553,10 +7630,13 @@ Paramètres : commande `/set` (par exemple : `weechat.look.item_time_format`) (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) * 'callback' : fonction appelée lorsque l'option de configuration est modifiée, - paramètres : + paramètres et valeur de retour : ** 'void *data' : pointeur ** 'const char *option' : nom de l'option ** 'const char *value' : nouvelle valeur pour l'option +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -7622,13 +7702,16 @@ Paramètres : * 'description' : description de la complétion * 'callback' : fonction appelée lorsque la complétion est utilisée (l'utilisateur est en train de compléter quelque chose qui fait appel à cette - complétion), paramètres : + complétion), paramètres et valeur de retour : ** 'void *data' : pointeur ** 'const char *completion_item' : nom de la complétion ** 'struct t_gui_buffer *buffer' : tampon où la complétion est effectuée ** 'struct t_gui_completion *completion' : structure utilisée pour ajouter les mots pour la complétion (voir <<_weechat_hook_completion_list_add,weechat_hook_completion_list_add>>) +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -7876,12 +7959,13 @@ 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 : +* '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 (la fonction doit retourner une - copie de cette chaîne, aucun changement n'est autorisé dans cette chaîne) +** 'const char *string' : chaîne à modifier +** valeur de retour : nouvelle chaîne * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -8001,11 +8085,13 @@ Paramètres : (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) * 'description' : description * 'args_description' : description des paramètres (optionnel, peut être NULL) -* 'callback' : fonction appelée quand l'information est demandée, paramètres : +* 'callback' : fonction appelée quand l'information est demandée, paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'const char *info_name' : nom de l'information ** 'const char *arguments' : paramètres additionnels, dépendant de l'information +** valeur de retour : valeur de l'information demandée * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -8077,10 +8163,12 @@ Paramètres : (optionnel, peut être NULL) * 'output_description' : description de la hashtable retournée par le "callback" (optionnel, peut être NULL) -* 'callback' : fonction appelée quand l'information est demandée, paramètres : +* 'callback' : fonction appelée quand l'information est demandée, paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'const char *info_name' : nom de l'information ** 'struct t_hashtable *hashtable' : hashtable, dépendant de l'information +** valeur de retour : hashtable demandée * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -8139,10 +8227,10 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, const char *description, const char *pointer_description, const char *args_description, - const char *(*callback)(void *data, - const char *infolist_name, - void *pointer, - const char *arguments), + struct t_infolist *(*callback)(void *data, + const char *infolist_name, + void *pointer, + const char *arguments), void *callback_data); ---------------------------------------- @@ -8153,12 +8241,14 @@ Paramètres : * 'description' : description * 'pointer_description' : description du pointeur (optionnel, peut être NULL) * 'args_description' : description des paramètres (optionnel, peut être NULL) -* 'callback' : fonction appelée quand l'infolist est demandée, paramètres : +* 'callback' : fonction appelée quand l'infolist est demandée, paramètres et + valeur de retour : ** 'void *data' : pointeur ** 'const char *infolist_name' : nom de l'infolist ** 'void *pointer' : pointeur vers un objet que l'infolist doit retourner (pour obtenir unituqment cet objet dans l'infolist) ** 'const char *arguments' : paramètres additionnels, dépendant de l'infolist +** valeur de retour : infolist demandée * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -8304,15 +8394,22 @@ Paramètres : * 'name' : nom du tampon (doit être unique pour l'extension) * 'input_callback' : fonction appelée lorsque du texte saisi est envoyé au - tampon, paramètres : -*** 'void *data' : pointeur -*** 'struct t_gui_buffer *buffer' : pointeur vers le tampon -*** 'const char *input_data' : données en entrée + tampon, paramètres et valeur de retour : +** 'void *data' : pointeur +** 'struct t_gui_buffer *buffer' : pointeur vers le tampon +** 'const char *input_data' : données en entrée +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'close_callback' : fonction appelée lorsque le tampon est fermé, paramètres : -*** 'void *data' : pointeur -*** 'struct t_gui_buffer *buffer' : pointeur vers le tampon +* 'close_callback' : fonction appelée lorsque le tampon est fermé, paramètres et + valeur de retour : +** 'void *data' : pointeur +** 'struct t_gui_buffer *buffer' : pointeur vers le tampon +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -10218,8 +10315,12 @@ struct t_gui_bar_item *weechat_bar_item_new (const char *name, Paramètres : * 'name' : nom de l'objet de barre -* 'build_callback' : fonction appelée lorsque l'objet est construit : elle doit - retourner le contenu de l'objet de barre +* 'build_callback' : fonction appelée lorsque l'objet est construit, paramètres + et valeur de retour : +** 'void *data' : pointeur +** 'struct t_gui_bar_item *item' : pointeur vers l'objet de barre +** 'struct t_gui_window *window' : pointeur vers la fenêtre +** valeur de retour : contenu de l'objet de barre * 'build_callback_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat @@ -11746,7 +11847,14 @@ Paramètres : * 'upgrade_file' : pointeur vers le fichier de mise à jour * 'callback_read' : fonction appelée pour chaque objet lu dans le fichier de - mise à jour + mise à jour, paramètres et valeur de retour : +** 'void *data' : pointeur +** 'struct t_upgrade_file *upgrade_file' : pointeur vers le fichier de mise à jour +** 'int object_id' : identifiant de l'objet +** 'struct t_infolist *infolist' : infolist avec le contenu de l'objet +** valeur de retour : +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_read_data' : pointeur donné au "callback" lorsqu'il est appelé par WeeChat diff --git a/doc/it/weechat_plugin_api.it.txt b/doc/it/weechat_plugin_api.it.txt index 5287da15b..b773a2a6f 100644 --- a/doc/it/weechat_plugin_api.it.txt +++ b/doc/it/weechat_plugin_api.it.txt @@ -2967,10 +2967,25 @@ Argomenti: * 'callback_hash_key': callback utilizzata per effettuare un "hash" di una chiave (chiave come valore intero), può essere NULL se il tipo della chiave è "string" (viene usata una funzione predefinita per le stringhe, e solo per le - stringhe) + stringhe), argomenti e valore restituito: +** 'struct t_hashtable *hashtable': puntatore alla tabella hash +// TRANSLATION MISSING +** 'const void *key': key +// TRANSLATION MISSING +** return value: hash of the key * 'callback_keycmp': callback utilizzata per comparare due chiavi, può essere NULL se il tipo di valore è "string" (una funzione di confronto predefinita è - usata per le stringhe e solo per le stringhe) + usata per le stringhe e solo per le stringhe), argomenti e valore restituito: +** 'struct t_hashtable *hashtable': puntatore alla tabella hash +// TRANSLATION MISSING +** 'const void *key1': first key +// TRANSLATION MISSING +** 'const void *key2': second key +// TRANSLATION MISSING +** return value: +*** negative number if 'key1' is less than 'key2' +*** 0 if 'key1' equals 'key2' +*** positive number if 'key1' is greater than 'key2' Valore restituito: @@ -3462,9 +3477,14 @@ Argomenti: * 'name': nome del file di configurazione (senza percorso o estensione) * 'callback_reload': funzione chiamata quando il file di configurazione viene - ricaricato con `/reload` (opzionale, può essere NULL), argomenti: + ricaricato con `/reload` (opzionale, può essere NULL), argomenti e valore + restituito: ** 'void *data': puntatore ** 'struct t_config_file *config_file': puntatore al file di configurazione +** valore restituito: +*** 'WEECHAT_CONFIG_READ_OK' +*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' +*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' * 'callback_reload_data': puntatore fornito per ricaricare il callback quando richiesto da WeeChat @@ -3562,45 +3582,67 @@ Argomenti: oppure 0 se non gli è consentito * 'callback_read': funzione chiamata quando un'opzione nella sezione viene letta da disco (dovrebbe essere NULL in molti casi, tranne se l'opzione nella sezione - necessita di una funzione personalizza), argomenti: + necessita di una funzione personalizza), argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_file *config_file': puntatore al file di configurazione ** 'struct t_config_section *section': puntatore alla sezione ** 'const char *option_name': nome dell'opzione ** 'const char *value': valore +** valore restituito: +*** 'WEECHAT_CONFIG_READ_OK' +*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' +*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' * 'callback_read_data': puntatore fornito al callback quando chiamato da WeeChat * 'callback_write': funzione chiamata quando la sezione è scritta nel file (dovrebbe essere NULL in molti casi, tranne se la sezione necessita di una funzione - personalizzata), argomenti: + personalizzata), argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_file *config_file': puntatore al file di configurazione ** 'struct t_config_section *section': puntatore alla sezione ** 'const char *option_name': nome dell'opzione +** valore restituito: +*** 'WEECHAT_CONFIG_WRITE_OK' +*** 'WEECHAT_CONFIG_WRITE_ERROR' +*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' * callback_write_data: puntatore fornito al callback quando chiamato da WeeChat * callback_write_default: funzione chiamata quando i valori predefiniti per la sezione - devono essere scritti in un file, argomenti: + devono essere scritti in un file, argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_file *config_file': puntatore al file di configurazione ** 'const char *section_name': nome della sezione +** valore restituito: +*** 'WEECHAT_CONFIG_WRITE_OK' +*** 'WEECHAT_CONFIG_WRITE_ERROR' +*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' * 'callback_write_default_data': puntatore fornito al callback quando chiamato da WeeChat * 'callback_create_option': funzione chiamata quando viene creata una nuova opzione nella sezione (NULL se la sezione non consente di creare nuove - opzioni), argomenti: + opzioni), argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_file *config_file': puntatore al file di configurazione ** 'struct t_config_section *section': puntatore alla sezione ** 'const char *option_name': nome dell'opzione ** 'const char *value': valore +** valore restituito: +*** 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' +*** 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' +*** 'WEECHAT_CONFIG_OPTION_SET_ERROR' +*** 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' * 'callback_create_option_data': puntatore fornito al callback quando chiamato da WeeChat * 'callback_delete_option': funzione chiamata quando un'opzione viene eliminata nella sezione (NULL se la sezione non consente di eliminare delle opzioni), - argomenti: + argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_file *config_file': puntatore al file di configurazione ** 'struct t_config_section *section': puntatore alla sezione ** 'struct t_config_option *option': puntatore all'opzione +** valore restituito: +*** 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' +*** 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' +*** 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' +*** 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' * 'callback_delete_option_data': puntatore fornito al callback quando chiamato da WeeChat @@ -3826,22 +3868,33 @@ Argomenti: * 'null_value_allowed': 1 se 'null' (valore non definito) è consentito per l'opzione, altrimenti 0 * 'callback_check_value': funzione chiamata per verificare il nuovo valore per - l'opzione (ozionale), argomenti: + l'opzione (ozionale), argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_option *option': puntatore all'opzione ** 'const char *value': nuovo valore per l'opzione +** valore restituito: +// TRANSLATION MISSING +*** 1 if value is ok +// TRANSLATION MISSING +*** 0 if value is invalid * 'callback_check_value_data': puntatore fornito alla callback check_value quando chiamato da WeeChat * 'callback_change': funzione chiamata quando il valore dell'opzione è stata - cambiata (opzionale), argomenti: + cambiata (opzionale), argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_option *option': puntatore all'opzione +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_change_data': puntatore fornito per cambiare alla callback quando chiamato da WeeChat * 'callback_delete': funzione chiamata quando l'opzione verrà eliminata - (opzionale), argomenti: + (opzionale), argomenti e valore restituito: ** 'void *data': puntatore ** 'struct t_config_option *option': puntatore all'opzione +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_delete_data': puntatore fornito per eiliminare alla callback quando chiamato da WeeChat @@ -6045,13 +6098,17 @@ Argomenti: per ogni argomento, separati da spazio. Sono possibili più completamenti sono possibili per un singolo argomento, separati da "|". Più modelli sono possibili per lo stesso comando, separati da "||". -* 'callback': funzione chiamata quando viene utilizzato il comando, argomenti: +* 'callback': funzione chiamata quando viene utilizzato il comando, argomenti e + valore restituito: ** 'void *data': puntatore ** 'struct t_gui_buffer *buffer': buffer quando il comando viene eseguito ** 'int argc': numero di argomenti forniti per un comando ** 'char **argv': argomenti forniti per un comando ** 'char **argv_eol': argomenti forniti per un comando (fino a fine riga per ogni argomento) +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito dalla callback quando chiamata da WeeChat I codici predefiniti per il completamento sono: @@ -6164,10 +6221,15 @@ Argomenti: * 'command': comando su cui eseguire l'hook, può iniziare o terminare con "*" (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* 'callback': funzione chiamata quando il comando è in esecuzione, argomenti: +* 'callback': funzione chiamata quando il comando è in esecuzione, argomenti e + valore restituito: ** 'void *data': puntatore ** 'struct t_gui_buffer *buffer': buffer dove viene eseguito il comando ** 'const char *command': il comando eseguito, con i propri argomenti +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_OK_EAT' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat [NOTE] @@ -6235,9 +6297,13 @@ Argomenti: if interval = 60000 (60 seconds), and align_second = 60, then timer is called each minute when second is 00 * 'max_calls': number of calls to timer (if 0, then timer has no end) -* 'callback': function called when time is reached, arguments: +* 'callback': function called when time is reached, argomenti e valore + restituito: ** 'void *data': pointer ** 'int remaining_calls': remaining calls (-1 if timer has no end) +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': pointer given to callback when it is called by WeeChat Valore restituito: @@ -6301,9 +6367,12 @@ Argomenti: * 'flag_write': 1 = cattura l'evento scrittura (write), 0 = ignora * 'flag_exception': 1 = cattura l'eccezione evento (event), 0 = ignora * 'callback': funzione che chiama un evento selezionato che si verifica - per un file (o un socket), argomenti: + per un file (o un socket), argomenti e valore restituito: ** 'void *data': puntatore ** 'int fd': descrittore file +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla calback quando chiamata da WeeChat Valore restituito: @@ -6369,7 +6438,7 @@ Argomenti: * 'timeout': timeout per il comando (in millisecondi): dopo questo timeout, il processo figlio viene terminato (0 vuol dire nessun timeout) * 'callback': funzione chiamata quando i dati dal processo figlio sono disponibili, - oppure quando è terminato, argomenti: + oppure quando è terminato, argomenti e valore restituito: ** 'void *data': puntatore ** 'const char *command': comando eseguito dal processo figlio ** 'int return_code': codice restituito: @@ -6379,6 +6448,9 @@ Argomenti: esecuzione del comando) ** 'out': output standard del comando (stdout) ** 'err': output di errore del comando (stderr) +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando fornita da WeeChat Valore restituito: @@ -6500,7 +6572,7 @@ Argomenti: * 'local_hostname': nome host locale da utilizzare per la connessione (opzionale) * 'callback': funzione chiamata quando la connessione è avvenuta con - successo oppure no, argomenti: + successo oppure no, argomenti e valore restituito: ** 'void *data': puntatore ** 'int status': stato della connessione: *** 'WEECHAT_HOOK_CONNECT_OK': connessione avvenuta con successo @@ -6515,6 +6587,9 @@ Argomenti: ** 'gnutls_rc': valore del risultato di 'gnutls_handshake()' ** 'const char *error': valore del risultato di 'gnutls_strerror(gnutls_rc)' ** 'const char *ip_address': indirizzo IP trovato +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -6638,7 +6713,8 @@ Argomenti: * 'message': verranno catturati solo i messaggi con questa stringa (opzionale) * 'strip_colors': se 1, i colori verranno estratti dal messaggio visualizzato, prima di chiamare la callback -* 'callback': funzione chiamata quando viene stampato un messaggio, argomenti: +* 'callback': funzione chiamata quando viene stampato un messaggio, argomenti e + valore restituito: ** 'void *data': puntatore ** 'struct t_gui_buffer *buffer': puntatore al buffer ** 'time_t date': data @@ -6648,6 +6724,9 @@ Argomenti: ** 'int highlight': 1 se la riga viene evidenziata, altrimenti 0 ** 'const char *prefix': prefisso ** 'const char *message': messaggio +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -6928,7 +7007,8 @@ Argomenti: [NOTE] ^(1)^ 'xxx' è il nome del server IRC, 'yyy' è il nome del comando IRC. -* 'callback': funzione chiamata a segnale ricevuto, argomenti: +* '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: @@ -6936,6 +7016,9 @@ Argomenti: *** 'WEECHAT_HOOK_SIGNAL_INT': numero intero *** 'WEECHAT_HOOK_SIGNAL_POINTER': puntatore ** 'void *signal_data': dati inviati con il segnale +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -7204,10 +7287,14 @@ Argomenti: ^(1)^ 'xxx' è l'argomento del segnale usato nella redirezione, 'yyy' è lo schema di redirezione. -* 'callback': funzione chiamata a segnale ricevuto, argomenti: +* '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' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -7478,10 +7565,13 @@ Argomenti: (priorità consentita, consultare la note riguardo la <<hook_priority,priority>>) * 'callback': funzione chiamata quando l'opzione di configurazione è cambiata, - argomenti: + argomenti e valore restituito: ** 'void *data': puntatore ** 'const char *option': nome dell'opzione ** 'const char *value': nuovo valore per l'opzione +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -7545,13 +7635,17 @@ Argomenti: (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) * 'callback': funzione chiamata quando viene usato l'elemento completamento - (l'utente sta completando qualcosa usando questo elemento), argomenti: + (l'utente sta completando qualcosa usando questo elemento), argomenti e valore + restituito: ** 'void *data': puntatore ** 'const char *completion_item': nome dell'elemento del completamento ** 'struct t_gui_buffer *buffer': buffer dove viene eseguito il completamento ** 'struct t_gui_completion *completion': struttura usata per aggiungere parole per il completamento (consultare <<_weechat_hook_completion_list_add,weechat_hook_completion_list_add>>) +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat [NOTE] @@ -7800,13 +7894,13 @@ Argomenti: ^(2)^ 'yyy' è il nome della barra. * 'callback': funzione chiamata quando viene usato il modificatore, - argomenti: + 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 (la funzione deve restituire - una copia di questa stringa, non è consentito alcun cambiamento in - questa stringa) +** 'const char *string': stringa da modificare +// TRANSLATION MISSING +** valore restituito: new string * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -7926,10 +8020,13 @@ Argomenti: <<hook_priority,priority>>) * 'description': descrizione * 'args_description': descrizione degli argomenti -* 'callback': funzione chiamata alla richiesta di una info, argomenti: +* 'callback': funzione chiamata alla richiesta di una info, argomenti e valore + restituito: ** 'void *data': puntatore ** 'const char *info_name': nome della info ** 'const char *arguments': argomenti addizionali, dipendono dalle info +// TRANSLATION MISSING +** valore restituito: value of info asked * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -8000,10 +8097,13 @@ Argomenti: essere NULL) * 'output_description': descrizione della tabella hash restituita dalla callback (opzionale, può essere NULL) -* 'callback': funzione chiamata alla richiesta della info, argomenti: +* 'callback': funzione chiamata alla richiesta della info, argomenti e valore + restituito: ** 'void *data': puntatore ** 'const char *info_name': nome della info ** 'struct t_hashtable *hashtable': tabella hash, in base alla info +// TRANSLATION MISSING +** valore restituito: hashtable asked * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -8061,10 +8161,10 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, const char *description, const char *pointer_description, const char *args_description, - const char *(*callback)(void *data, - const char *infolist_name, - void *pointer, - const char *arguments), + struct t_infolist *(*callback)(void *data, + const char *infolist_name, + void *pointer, + const char *arguments), void *callback_data); ---------------------------------------- @@ -8076,12 +8176,15 @@ Argomenti: * 'description': descrizione * 'pointer_description': descrizione del puntatore (opzionale, può essere NULL) * 'args_description': descrizione degli argomenti (opzionale, può essere NULL) -* 'callback': funzione chiamata alla richiesta della lista info, argomenti: +* 'callback': funzione chiamata alla richiesta della lista info, argomenti e + valore restituito: ** 'void *data': puntatore ** 'const char *infolist_name': nome della lista info ** 'void *pointer': puntatore ad un oggetto che la lista info deve restituire (per ricevere un solo elemento della lista info) ** 'const char *arguments': argomento aggiuntivo, dipende dalla lista info +// TRANSLATION MISSING +** valore restituito: infolist asked * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -8227,14 +8330,21 @@ Argomenti: * 'name': nome del buffer (deve essere unico per il plugin) * 'input_callback': funzione chiamata quando il testo in input è stato - inserito nel buffer, argomenti: -*** 'void *data': puntatore -*** 'struct t_gui_buffer *buffer': puntatore al buffer -*** 'const char *input_data': dati in input + inserito nel buffer, argomenti e valore restituito: +** 'void *data': puntatore +** 'struct t_gui_buffer *buffer': puntatore al buffer +** 'const char *input_data': dati in input +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat -* 'close_callback': funzione chiamata alla chiusura del buffer, argomenti: -*** 'void *data': puntatore -*** 'struct t_gui_buffer *buffer': puntatore al buffer +* 'close_callback': funzione chiamata alla chiusura del buffer, argomenti e + valore restituito: +** 'void *data': puntatore +** 'struct t_gui_buffer *buffer': puntatore al buffer +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat Valore restituito: @@ -10131,7 +10241,12 @@ Argomenti: * 'name': nome dell'elemento barra * 'build_callback': funzione chiamata quando l'elemento barra viene - compilato; deve restituire il contenuto dell'elemento barra + compilato, argomenti e valore restituito: +** 'void *data': puntatore +** 'struct t_gui_bar_item *item': puntatore all'elemento barra +** 'struct t_gui_window *window': puntatore alla finestra +// TRANSLATION MISSING +** valore restituito: content of bar item * 'build_callback_data': puntatore fornito alla callback quando chiamata da WeeChat @@ -11663,7 +11778,16 @@ Argomenti: * 'upgrade_file': puntatore al file di aggiornamento * 'callback_read': funzione chiamata per ogni oggetto letto nel file - di aggiornamento + di aggiornamento, argomenti e valore restituito: +** 'void *data': puntatore +** 'struct t_upgrade_file *upgrade_file': puntatore al file di aggiornamento +// TRANSLATION MISSING +** 'int object_id': object id +// TRANSLATION MISSING +** 'struct t_infolist *infolist': infolist with content of object +** valore restituito: +*** 'WEECHAT_RC_OK' +*** 'WEECHAT_RC_ERROR' * 'callback_read_data': puntatore assegnato per la lettura della chiamata quando chiamato da WeeChat |