diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/en/weechat_plugin_api.en.asciidoc | 2959 | ||||
| -rw-r--r-- | doc/fr/weechat_plugin_api.fr.asciidoc | 2976 | ||||
| -rw-r--r-- | doc/it/weechat_plugin_api.it.asciidoc | 2951 | ||||
| -rw-r--r-- | doc/ja/weechat_plugin_api.ja.asciidoc | 2978 |
4 files changed, 5933 insertions, 5931 deletions
diff --git a/doc/en/weechat_plugin_api.en.asciidoc b/doc/en/weechat_plugin_api.en.asciidoc index 101538e27..ec4e5210c 100644 --- a/doc/en/weechat_plugin_api.en.asciidoc +++ b/doc/en/weechat_plugin_api.en.asciidoc @@ -5,7 +5,7 @@ :toc: left :toclevels: 4 :sectnums: -:sectnumlevels: 2 +:sectnumlevels: 3 :docinfo1: @@ -83,21 +83,21 @@ int weechat_plugin_init (struct t_weechat_plugin *plugin, Arguments: -* 'plugin': pointer to WeeChat plugin structure -* 'argc': number of arguments for plugin (given on command line by user) -* 'argv': arguments for plugin +* _plugin_: pointer to WeeChat plugin structure +* _argc_: number of arguments for plugin (given on command line by user) +* _argv_: arguments for plugin Return value: -* 'WEECHAT_RC_OK' if successful (plugin will be loaded) -* 'WEECHAT_RC_ERROR' if error (plugin will NOT be loaded) +* _WEECHAT_RC_OK_ if successful (plugin will be loaded) +* _WEECHAT_RC_ERROR_ if error (plugin will NOT be loaded) [[plugin_priority]] ===== Plugin priority When plugins are auto-loaded (for example on startup), WeeChat first loads all -plugins, and then calls the 'init' functions, using the priority defined in -each plugin. A high priority means that the 'init' function is called first. +plugins, and then calls the _init_ functions, using the priority defined in +each plugin. A high priority means that the _init_ function is called first. Default priority is 1000 (with such priority, the plugin is loaded after all default plugins). @@ -119,17 +119,17 @@ int weechat_plugin_end (struct t_weechat_plugin *plugin); Arguments: -* 'plugin': pointer to WeeChat plugin structure +* _plugin_: pointer to WeeChat plugin structure Return value: -* 'WEECHAT_RC_OK' if successful -* 'WEECHAT_RC_ERROR' if error +* _WEECHAT_RC_OK_ if successful +* _WEECHAT_RC_ERROR_ if error [[compile_plugin]] === Compile plugin -Compile does not need WeeChat sources, only file 'weechat-plugin.h' is +Compile does not need WeeChat sources, only file _weechat-plugin.h_ is required. To compile a plugin which has one file "toto.c" (under GNU/Linux): @@ -142,9 +142,9 @@ $ gcc -shared -fPIC -o libtoto.so toto.o [[load_plugin]] === Load plugin -Copy file 'libtoto.so' into system plugins directory (for example -'/usr/local/lib/weechat/plugins') or into user's plugins directory (for example -'/home/xxx/.weechat/plugins'). +Copy file _libtoto.so_ into system plugins directory (for example +_/usr/local/lib/weechat/plugins_) or into user's plugins directory (for example +_/home/xxx/.weechat/plugins_). Under WeeChat: @@ -155,7 +155,7 @@ Under WeeChat: [[plugin_example]] === Plugin example -Full example of plugin, which adds a command '/double': displays two times +Full example of plugin, which adds a command _/double_: displays two times arguments on current buffer, or execute two times a command (OK that's not very useful, but that's just an example!): @@ -255,7 +255,7 @@ const char *weechat_plugin_get_name (struct t_weechat_plugin *plugin); Arguments: -* 'plugin': pointer to WeeChat plugin structure (can be NULL) +* _plugin_: pointer to WeeChat plugin structure (can be NULL) Return value: @@ -289,8 +289,8 @@ UTF-8 and locale. ==== charset_set -Set new plugin charset (default charset is 'UTF-8', so if your plugin uses -'UTF-8', you don't need to call this function). +Set new plugin charset (default charset is _UTF-8_, so if your plugin uses +_UTF-8_, you don't need to call this function). Prototype: @@ -301,7 +301,7 @@ void weechat_charset_set (const char *charset); Arguments: -* 'charset': new charset to use +* _charset_: new charset to use C example: @@ -334,8 +334,8 @@ char *weechat_iconv_to_internal (const char *charset, const char *string); Arguments: -* 'charset': charset to convert -* 'string': string to convert +* _charset_: charset to convert +* _string_: string to convert Return value: @@ -374,8 +374,8 @@ char *weechat_iconv_from_internal (const char *charset, const char *string); Arguments: -* 'charset': target charset -* 'string': string to convert +* _charset_: target charset +* _string_: string to convert Return value: @@ -414,7 +414,7 @@ const char *weechat_gettext (const char *string); Arguments: -* 'string': string to translate +* _string_: string to translate Return value: @@ -440,7 +440,7 @@ str = weechat.gettext("hello") ==== ngettext -Return translated string, using single or plural form, according to 'count' +Return translated string, using single or plural form, according to _count_ argument. Prototype: @@ -453,9 +453,9 @@ const char *weechat_ngettext (const char *string, const char *plural, Arguments: -* 'string': string to translate, single form -* 'plural': string to translate, plural form -* 'count': used to choose between single and plural form (choice is made +* _string_: string to translate, single form +* _plural_: string to translate, plural form +* _count_: used to choose between single and plural form (choice is made according to local language) Return value: @@ -483,7 +483,7 @@ str = weechat.ngettext("file", "files", num_files) ==== strndup -Return duplicated string, with 'length' chars max. +Return duplicated string, with _length_ chars max. Prototype: @@ -494,8 +494,8 @@ char *weechat_strndup (const char *string, int length); Arguments: -* 'string': string to duplicate -* 'length': max chars to duplicate +* _string_: string to duplicate +* _length_: max chars to duplicate Return value: @@ -526,7 +526,7 @@ void weechat_string_tolower (char *string); Arguments: -* 'string': string to convert +* _string_: string to convert C example: @@ -552,7 +552,7 @@ void weechat_string_toupper (char *string); Arguments: -* 'string': string to convert +* _string_: string to convert C example: @@ -580,8 +580,8 @@ int weechat_strcasecmp (const char *string1, const char *string2); Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison +* _string1_: first string for comparison +* _string2_: second string for comparison Return value: @@ -615,12 +615,12 @@ int weechat_strcasecmp_range (const char *string1, const char *string2, int rang Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison -* 'range': number of chars in case comparison, for example: -** 26: "A-Z" are lowered to "a-z" -** 29: "A-Z [ \ ]" are lowered to "a-z { | }" -** 30: "A-Z [ \ ] ^" are lowered to "a-z { | } ~" +* _string1_: first string for comparison +* _string2_: second string for comparison +* _range_: number of chars in case comparison, for example: +** 26: `A-Z` are lowered to `a-z` +** 29: `A-Z [ \ ]` are lowered to `a-z { | }` +** 30: `A-Z [ \ ] ^` are lowered to `a-z { | } ~` [NOTE] Values 29 and 30 are used by some protocols like IRC. @@ -645,7 +645,7 @@ This function is not available in scripting API. _Updated in 1.0._ -Locale and case independent string comparison, for 'max' chars. +Locale and case independent string comparison, for _max_ chars. Prototype: @@ -656,9 +656,9 @@ int weechat_strncasecmp (const char *string1, const char *string2, int max); Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison -* 'max': max chars to compare +* _string1_: first string for comparison +* _string2_: second string for comparison +* _max_: max chars to compare Return value: @@ -680,7 +680,7 @@ This function is not available in scripting API. _WeeChat ≥ 0.3.7, updated in 1.0._ -Locale and case independent string comparison, for 'max' chars, using a range +Locale and case independent string comparison, for _max_ chars, using a range for case comparison. Prototype: @@ -692,13 +692,13 @@ int weechat_strncasecmp_range (const char *string1, const char *string2, int max Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison -* 'max': max chars to compare -* 'range': number of chars in case comparison, for example: -** 26: "A-Z" are lowered to "a-z" -** 29: "A-Z [ \ ]" are lowered to "a-z { | }" -** 30: "A-Z [ \ ] ^" are lowered to "a-z { | } ~" +* _string1_: first string for comparison +* _string2_: second string for comparison +* _max_: max chars to compare +* _range_: number of chars in case comparison, for example: +** 26: `A-Z` are lowered to `a-z` +** 29: `A-Z [ \ ]` are lowered to `a-z { | }` +** 30: `A-Z [ \ ] ^` are lowered to `a-z { | } ~` [NOTE] Values 29 and 30 are used by some protocols like IRC. @@ -737,10 +737,10 @@ int weechat_strcmp_ignore_chars (const char *string1, const char *string2, Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison -* 'chars_ignored': string with chars to ignored -* 'case_sensitive': 1 for case sensitive comparison, otherwise 0 +* _string1_: first string for comparison +* _string2_: second string for comparison +* _chars_ignored_: string with chars to ignored +* _case_sensitive_: 1 for case sensitive comparison, otherwise 0 Return value: @@ -773,13 +773,13 @@ const char *weechat_strcasestr (const char *string, const char *search); Arguments: -* 'string': string -* 'search': string to search in 'string' +* _string_: string +* _search_: string to search in _string_ Return value: * pointer to string found, or NULL if not found - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) C example: @@ -808,7 +808,7 @@ int weechat_strlen_screen (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -848,10 +848,10 @@ int weechat_string_match (const char *string, const char *mask, Arguments: -* 'string': string -* 'mask': mask with wildcards ("*"), each wildcard matches 0 or more chars in +* _string_: string +* _mask_: mask with wildcards (`+*+`), each wildcard matches 0 or more chars in the string -* 'case_sensitive': 1 for case sensitive comparison, otherwise 0 +* _case_sensitive_: 1 for case sensitive comparison, otherwise 0 [NOTE] Since version 1.0, wildcards are allowed inside the mask @@ -891,8 +891,8 @@ match5 = weechat.string_match("abcdef", "*b*d*", 0) # 1 _WeeChat ≥ 0.3.3._ -Replace leading `~` by string with home directory. If string does not start -with `~`, then same string is returned. +Replace leading `+~+` by string with home directory. If string does not start +with `+~+`, then same string is returned. Prototype: @@ -903,11 +903,11 @@ char *weechat_string_expand_home (const char *path); Arguments: -* 'path': path +* _path_: path Return value: -* path with leading `~` replaced by home directory (must be freed by calling +* path with leading `+~+` replaced by home directory (must be freed by calling "free" after use) C example: @@ -930,7 +930,7 @@ _WeeChat ≥ 1.3._ Evaluate a path in 3 steps: . replace leading `%h` by WeeChat home directory, -. replace leading `~` by user home directory (call to +. replace leading `+~+` by user home directory (call to <<_string_expand_home,weechat_string_expand_home>>), . evaluate variables (see <<_string_eval_expression,weechat_string_eval_expression>>). @@ -947,12 +947,12 @@ char *weechat_string_eval_path_home (const char *path, Arguments: -* 'path': path -* 'pointers': hashtable for call to function +* _path_: path +* _pointers_: hashtable for call to function <<_string_eval_expression,weechat_string_eval_expression>> -* 'extra_vars': hashtable for call to function +* _extra_vars_: hashtable for call to function <<_string_eval_expression,weechat_string_eval_expression>> -* 'options': hashtable for call to function +* _options_: hashtable for call to function <<_string_eval_expression,weechat_string_eval_expression>> Return value: @@ -995,8 +995,8 @@ char *weechat_string_remove_quotes (const char *string, const char *quotes); Arguments: -* 'string': string -* 'quotes': string with list of quotes +* _string_: string +* _quotes_: string with list of quotes Return value: @@ -1030,10 +1030,10 @@ char *weechat_string_strip (const char *string, int left, int right, Arguments: -* 'string': string -* 'left': strip left chars if different from 0 -* 'right': strip right chars if different from 0 -* 'chars': string with chars to strip +* _string_: string +* _left_: strip left chars if different from 0 +* _right_: strip right chars if different from 0 +* _chars_: string with chars to strip Return value: @@ -1057,20 +1057,20 @@ _WeeChat ≥ 1.0._ Convert escaped chars to their value: -* `\"`: double quote -* `\\`: backslash -* `\a`: alert (BEL) -* `\b`: backspace -* `\e`: escape -* `\f`: form feed -* `\n`: new line -* `\r`: carriage return -* `\t`: horizontal tab -* `\v`: vertical tab -* `\0ooo`: char as octal value (ooo is 0 to 3 digits) -* `\xhh`: char as hexadecimal value (hh is 1 to 2 digits) -* `\uhhhh`: unicode char as hexadecimal value (hhhh is 1 to 4 digits) -* `\Uhhhhhhhh`: unicode char as hexadecimal value (hhhhhhhh is 1 to 8 digits) +* `+\"+`: double quote +* `+\\+`: backslash +* `+\a+`: alert (BEL) +* `+\b+`: backspace +* `+\e+`: escape +* `+\f+`: form feed +* `+\n+`: new line +* `+\r+`: carriage return +* `+\t+`: horizontal tab +* `+\v+`: vertical tab +* `+\0ooo+`: char as octal value (`ooo` is 0 to 3 digits) +* `+\xhh+`: char as hexadecimal value (`hh` is 1 to 2 digits) +* `+\uhhhh+`: unicode char as hexadecimal value (`hhhh` is 1 to 4 digits) +* `+\Uhhhhhhhh+`: unicode char as hexadecimal value (`hhhhhhhh` is 1 to 8 digits) Prototype: @@ -1081,7 +1081,7 @@ char *weechat_string_convert_escaped_chars (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -1103,7 +1103,7 @@ This function is not available in scripting API. ==== string_mask_to_regex -Return a regex, built with a mask, where only special char is "`*`". All other +Return a regex, built with a mask, where only special char is `+*+`. All other special chars for regex are escaped. Prototype: @@ -1115,7 +1115,7 @@ char *weechat_string_mask_to_regex (const char *mask); Arguments: -* 'mask': mask +* _mask_: mask Return value: @@ -1158,13 +1158,13 @@ const char *weechat_string_regex_flags (const char *regex, int default_flags, in Arguments: -* 'regex': POSIX extended regular expression -* 'default_flags': combination of following values (see `man regcomp`): +* _regex_: POSIX extended regular expression +* _default_flags_: combination of following values (see `man regcomp`): ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE ** REG_NOSUB -* 'flags': pointer value is set with flags used in regular expression (default +* _flags_: pointer value is set with flags used in regular expression (default flags + flags set in regular expression) Flags must be at beginning of regular expression. Format is: @@ -1172,14 +1172,14 @@ Flags must be at beginning of regular expression. Format is: Allowed flags are: -* 'e': POSIX extended regular expression ('REG_EXTENDED') -* 'i': case insensitive ('REG_ICASE') -* 'n': match-any-character operators don't match a newline ('REG_NEWLINE') -* 's': support for substring addressing of matches is not required ('REG_NOSUB') +* _e_: POSIX extended regular expression (_REG_EXTENDED_) +* _i_: case insensitive (_REG_ICASE_) +* _n_: match-any-character operators don't match a newline (_REG_NEWLINE_) +* _s_: support for substring addressing of matches is not required (_REG_NOSUB_) Return value: -* pointer in 'regex', after flags +* pointer in _regex_, after flags C example: @@ -1211,9 +1211,9 @@ int weechat_string_regcomp (void *preg, const char *regex, int default_flags) Arguments: -* 'preg': pointer to 'regex_t' structure -* 'regex': POSIX extended regular expression -* 'default_flags': combination of following values (see `man regcomp`): +* _preg_: pointer to _regex_t_ structure +* _regex_: POSIX extended regular expression +* _default_flags_: combination of following values (see `man regcomp`): ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE @@ -1252,8 +1252,8 @@ int weechat_string_has_highlight (const char *string, Arguments: -* 'string': string -* 'highlight_words': list of highlight words, separated by comma +* _string_: string +* _highlight_words_: list of highlight words, separated by comma Return value: @@ -1284,7 +1284,7 @@ _WeeChat ≥ 0.3.4._ Check if a string has one or more highlights, using a POSIX extended regular expression. + For at least one match of regular expression on string, it must be surrounded -by delimiters (chars different from: alphanumeric, "-", "_" and "|"). +by delimiters (chars different from: alphanumeric, `+-+`, `+_+` and `+|+`). Prototype: @@ -1295,8 +1295,8 @@ int weechat_string_has_highlight_regex (const char *string, const char *regex); Arguments: -* 'string': string -* 'regex': POSIX extended regular expression +* _string_: string +* _regex_: POSIX extended regular expression Return value: @@ -1334,13 +1334,13 @@ char *weechat_string_replace (const char *string, const char *search, Arguments: -* 'string': string -* 'search': string to replace -* 'replace': replacement for string 'search' +* _string_: string +* _search_: string to replace +* _replace_: replacement for string _search_ Return value: -* string with 'search' replaced by 'replace' (must be freed by calling "free" +* string with _search_ replaced by _replace_ (must be freed by calling "free" after use) C example: @@ -1374,24 +1374,25 @@ char *weechat_string_replace_regex (const char *string, void *regex, Arguments: -* 'string': string -* 'regex': pointer to a regular expression ('regex_t' structure) compiled with +* _string_: string +* _regex_: pointer to a regular expression (_regex_t_ structure) compiled with WeeChat function <<_string_regcomp,weechat_string_regcomp>> or regcomp (see `man regcomp`) -* 'replace': replacement text, where following references are allowed: -** `$0` to `$99`: match 0 to 99 in regular expression (0 is the whole match, +* _replace_: replacement text, where following references are allowed: +** `+$0+` to `+$99+`: match 0 to 99 in regular expression (0 is the whole match, 1 to 99 are groups captured between parentheses) -** `$+`: the last match (with highest number) -** `$.*N`: match `N` (can be `+` or `0` to `99`), with all chars replaced by `*` - (the `*` char can be any char between space (32) and `~` (126)) -* 'reference_char': the char used for reference to match (commonly '$') -* 'callback': an optional callback called for each reference in 'replace' +** `+$++`: the last match (with highest number) +** `+$.*N+`: match `+N+` (can be `+++` or `+0+` to `+99+`), with all chars + replaced by `+*+` (the `+*+` char can be any char between space (32) and + `+~+` (126)) +* _reference_char_: the char used for reference to match (commonly `+$+`) +* _callback_: an optional callback called for each reference in _replace_ (except for matches replaced by a char); the callback must return: ** newly allocated string: it is used as replacement text (it is freed after use) ** NULL: the text received in callback is used as replacement text (without changes) -* 'callback_data': pointer given to callback when it is called +* _callback_data_: pointer given to callback when it is called Return value: @@ -1434,15 +1435,15 @@ char **weechat_string_split (const char *string, const char *separators, Arguments: -* 'string': string to split -* 'separators': delimiters used for split -* 'keep_eol': +* _string_: string to split +* _separators_: delimiters used for split +* _keep_eol_: ** 0: each string will contain one word ** 1: each string will contain all string until end of line (see example below) ** 2: same as 1, but do not remove separators at end of string before split _(WeeChat ≥ 0.3.6)_ -* 'num_items_max': maximum number of items created (0 = no limit) -* 'num_items': pointer to int which will contain number of items created +* _num_items_max_: maximum number of items created (0 = no limit) +* _num_items_: pointer to int which will contain number of items created Return value: @@ -1504,8 +1505,8 @@ char **weechat_string_split_shell (const char *string, int *num_items); Arguments: -* 'string': string to split -* 'num_items': pointer to int which will contain number of items created +* _string_: string to split +* _num_items_: pointer to int which will contain number of items created Return value: @@ -1544,7 +1545,7 @@ void weechat_string_free_split (char **split_string); Arguments: -* 'split_string': string split by function +* _split_string_: string split by function <<_string_split,weechat_string_split>> C example: @@ -1575,9 +1576,9 @@ char *weechat_string_build_with_split_string (char **split_string, Arguments: -* 'split_string': string split by function +* _split_string_: string split by function <<_string_split,weechat_string_split>> -* 'separator': string used to separate strings +* _separator_: string used to separate strings Return value: @@ -1601,7 +1602,7 @@ This function is not available in scripting API. ==== string_split_command -Split a list of commands separated by 'separator' (which can be escaped by "\" +Split a list of commands separated by _separator_ (which can be escaped by `+\+` in string). Prototype: @@ -1613,8 +1614,8 @@ char **weechat_string_split_command (const char *command, char separator); Arguments: -* 'command': command to split -* 'separator': separator +* _command_: command to split +* _separator_: separator Return value: @@ -1649,7 +1650,7 @@ void weechat_string_free_split_command (char **split_command); Arguments: -* 'split_command': command split by +* _split_command_: command split by <<_string_split_command,weechat_string_split_command>> C example: @@ -1678,7 +1679,7 @@ char *weechat_string_format_size (unsigned long long size); Arguments: -* 'size': size (in bytes) +* _size_: size (in bytes) Return value: @@ -1728,8 +1729,8 @@ char *weechat_string_remove_color (const char *string, Arguments: -* 'string': string -* 'replacement': if not NULL and not empty, WeeChat color codes are replaced by +* _string_: string +* _replacement_: if not NULL and not empty, WeeChat color codes are replaced by first char of this string, otherwise WeeChat color codes and following chars (if related to color) are removed from string @@ -1778,9 +1779,9 @@ void weechat_string_encode_base64 (const char *from, int length, char *to); Arguments: -* 'from': string to encode -* 'length': length of string to encode (for example `strlen(from)`) -* 'to': pointer to string to store result (must be long enough, result is +* _from_: string to encode +* _length_: length of string to encode (for example `strlen(from)`) +* _to_: pointer to string to store result (must be long enough, result is longer than initial string) C example: @@ -1810,13 +1811,13 @@ int weechat_string_decode_base64 (const char *from, char *to); Arguments: -* 'from': string to decode -* 'to': pointer to string to store result (must be long enough, result is +* _from_: string to decode +* _to_: pointer to string to store result (must be long enough, result is shorter than initial string) Return value: -* length of string stored in *to (does not count final '\0') +* length of string stored in _*to_ (does not count final _\0_) C example: @@ -1847,12 +1848,12 @@ char *string_hex_dump (const char *data, int data_size, int bytes_per_line, Arguments: -* 'data': the data to dump -* 'data_size': number of bytes to dump in 'data' -* 'bytes_per_line': number of bytes to display in each line -* 'prefix': the prefix to display at the beginning of each line +* _data_: the data to dump +* _data_size_: number of bytes to dump in _data_ +* _bytes_per_line_: number of bytes to display in each line +* _prefix_: the prefix to display at the beginning of each line (optional, can be NULL) -* 'suffix': the suffix to display at the end of each line +* _suffix_: the suffix to display at the end of each line (optional, can be NULL) Return value: @@ -1876,7 +1877,7 @@ This function is not available in scripting API. _WeeChat ≥ 0.3.2._ -Check if first char of string is a command char (default command char is '/'). +Check if first char of string is a command char (default command char is `+/+`). Prototype: @@ -1887,7 +1888,7 @@ int weechat_string_is_command_char (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -1929,7 +1930,7 @@ const char *weechat_string_input_for_buffer (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -1980,28 +1981,28 @@ char *weechat_string_eval_expression (const char *expr, Arguments: -* 'expr': the expression to evaluate (see table below) -* 'pointers': hashtable with pointers (keys must be string, values must be +* _expr_: the expression to evaluate (see table below) +* _pointers_: hashtable with pointers (keys must be string, values must be pointer); pointers "window" and "buffer" are automatically added if they are not in hashtable (with pointer to current window/buffer) (can be NULL): -** 'regex': pointer to a regular expression ('regex_t' structure) compiled with +** _regex_: pointer to a regular expression (_regex_t_ structure) compiled with WeeChat function <<_string_regcomp,weechat_string_regcomp>> or - regcomp (see `man regcomp`); this option is similar to 'regex' in hashtable - 'options' (below), but is used for better performance -* 'extra_vars': extra variables that will be expanded (can be NULL) -* 'options': a hashtable with some options (keys and values must be string) + regcomp (see `man regcomp`); this option is similar to _regex_ in hashtable + _options_ (below), but is used for better performance +* _extra_vars_: extra variables that will be expanded (can be NULL) +* _options_: a hashtable with some options (keys and values must be string) (can be NULL): -** 'type': default behavior is just to replace values in expression, other +** _type_: default behavior is just to replace values in expression, other types can be selected: -*** 'condition': the expression is evaluated as a condition: operators and +*** _condition_: the expression is evaluated as a condition: operators and parentheses are used, result is a boolean ("0" or "1") -** 'prefix': prefix before variables to replace (default: "${") -** 'suffix': suffix after variables to replace (default: "}") -** 'regex': a regex used to replace text in 'expr' (which is then not +** _prefix_: prefix before variables to replace (default: `+${+`) +** _suffix_: suffix after variables to replace (default: `+}+`) +** _regex_: a regex used to replace text in _expr_ (which is then not evaluated) -** 'regex_replace': the replacement text to use with 'regex', to replace - text in 'expr' (the 'regex_replace' is evaluated on each match of 'regex' - against 'expr', until no match is found) +** _regex_replace_: the replacement text to use with _regex_, to replace + text in _expr_ (the _regex_replace_ is evaluated on each match of _regex_ + against _expr_, until no match is found) Return value: @@ -2015,7 +2016,7 @@ expanded to last): |=== | Format | Description | Examples | Results -| `${name}` | Variable `name` from hashtable 'extra_vars' | +| `${name}` | Variable `name` from hashtable _extra_vars_ | `${name}` | `value` | `${eval:xxx}` + @@ -2033,13 +2034,13 @@ expanded to last): `©` | `${hide:x,value}` | - String with hidden chars (all chars in `value` replaced `x`) | + String with hidden chars (all chars in `value` replaced by `x`) | `${hide:*,password}` | `********` | `${re:N}` | - Regex captured group: 0 = whole string matching, 1 to 99 = group captured, - `+` = last group captured | + Regex captured group: `0` = whole string matching, `1` to `99` = group + captured, `+++` = last group captured | `${re:1}` | `test` @@ -2184,7 +2185,7 @@ int weechat_utf8_has_8bits (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -2218,10 +2219,10 @@ int weechat_utf8_is_valid (const char *string, int length, char **error); Arguments: -* 'string': string -* 'length': max number of UTF-8 chars to check; if ≤ 0, the whole string is +* _string_: string +* _length_: max number of UTF-8 chars to check; if ≤ 0, the whole string is checked _(WeeChat ≥ 1.4)_ -* 'error': if not NULL, '*error' is set with pointer to first non valid UTF-8 +* _error_: if not NULL, _*error_ is set with pointer to first non valid UTF-8 char in string, if any Return value: @@ -2259,8 +2260,8 @@ void weechat_utf8_normalize (char *string, char replacement); Arguments: -* 'string': string -* 'replacement': replacement char for invalid chars +* _string_: string +* _replacement_: replacement char for invalid chars C example: @@ -2288,14 +2289,14 @@ const char *weechat_utf8_prev_char (const char *string_start, Arguments: -* 'string_start': start of string (function will not return a char before this +* _string_start_: start of string (function will not return a char before this pointer) -* 'string': pointer to string (must be ≥ 'string_start') +* _string_: pointer to string (must be ≥ _string_start_) Return value: * pointer to previous UTF-8 char, NULL if not found (start of string reached) - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) C example: @@ -2322,12 +2323,12 @@ const char *weechat_utf8_next_char (const char *string); Arguments: -* 'string': string +* _string_: string Return value: * pointer to next UTF-8 char, NULL if not found (end of string reached) - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) C example: @@ -2352,7 +2353,7 @@ int weechat_utf8_char_int (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -2381,7 +2382,7 @@ int weechat_utf8_char_size (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -2410,7 +2411,7 @@ int weechat_utf8_strlen (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -2428,7 +2429,7 @@ This function is not available in scripting API. ==== utf8_strnlen -Return UTF-8 string length (in UTF-8 chars), for max 'bytes' in string. +Return UTF-8 string length (in UTF-8 chars), for max _bytes_ in string. Prototype: @@ -2439,8 +2440,8 @@ int weechat_utf8_strnlen (const char *string, int bytes); Arguments: -* 'string': string -* 'bytes': max bytes +* _string_: string +* _bytes_: max bytes Return value: @@ -2469,7 +2470,7 @@ int weechat_utf8_strlen_screen (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -2500,8 +2501,8 @@ int weechat_utf8_charcmp (const char *string1, const char *string2); Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison +* _string1_: first string for comparison +* _string2_: second string for comparison Return value: @@ -2534,8 +2535,8 @@ int weechat_utf8_charcasecmp (const char *string1, const char *string2); Arguments: -* 'string1': first string for comparison -* 'string2': second string for comparison +* _string1_: first string for comparison +* _string2_: second string for comparison Return value: @@ -2566,7 +2567,7 @@ int weechat_utf8_char_size_screen (const char *string); Arguments: -* 'string': string +* _string_: string Return value: @@ -2597,13 +2598,13 @@ const char *weechat_utf8_add_offset (const char *string, int offset); Arguments: -* 'string': string -* 'offset': number of chars +* _string_: string +* _offset_: number of chars Return value: * pointer to string, N chars after (NULL if it's not reachable) - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) C example: @@ -2629,8 +2630,8 @@ int weechat_utf8_real_pos (const char *string, int pos); Arguments: -* 'string': string -* 'pos': position (number of chars) +* _string_: string +* _pos_: position (number of chars) Return value: @@ -2659,8 +2660,8 @@ int weechat_utf8_pos (const char *string, int real_pos); Arguments: -* 'string': string -* 'real_pos': position (bytes) +* _string_: string +* _real_pos_: position (bytes) Return value: @@ -2678,7 +2679,7 @@ This function is not available in scripting API. ==== utf8_strndup -Return duplicate string, with 'length' chars max. +Return duplicate string, with _length_ chars max. Prototype: @@ -2689,8 +2690,8 @@ char *weechat_utf8_strndup (const char *string, int length); Arguments: -* 'string': string -* 'length': max chars to duplicate +* _string_: string +* _length_: max chars to duplicate Return value: @@ -2726,8 +2727,8 @@ int weechat_mkdir_home (char *directory, int mode); Arguments: -* 'directory': name of directory to create -* 'mode': mode for directory +* _directory_: name of directory to create +* _mode_: mode for directory Return value: @@ -2767,8 +2768,8 @@ int weechat_mkdir (char *directory, int mode); Arguments: -* 'directory': name of directory to create -* 'mode': mode for directory +* _directory_: name of directory to create +* _mode_: mode for directory Return value: @@ -2808,8 +2809,8 @@ int weechat_mkdir_parents (char *directory, int mode); Arguments: -* 'directory': name of directory to create -* 'mode': mode for directory +* _directory_: name of directory to create +* _mode_: mode for directory Return value: @@ -2855,12 +2856,12 @@ void weechat_exec_on_files (const char *directory, Arguments: -* 'directory': directory for searching files -* 'hidden_files': 1 to include hidden files, otherwise 0 -* 'callback': function called for each file found, arguments: -** 'void *data': pointer -** 'const char *filename': filename found -* 'callback_data': pointer given to callback when it is called by WeeChat +* _directory_: directory for searching files +* _hidden_files_: 1 to include hidden files, otherwise 0 +* _callback_: function called for each file found, arguments: +** _void *data_: pointer +** _const char *filename_: filename found +* _callback_data_: pointer given to callback when it is called by WeeChat C example: @@ -2892,7 +2893,7 @@ char *weechat_file_get_content (const char *filename); Arguments: -* 'filename': path and file name +* _filename_: path and file name Return value: @@ -2930,8 +2931,8 @@ int weechat_util_timeval_cmp (struct timeval *tv1, struct timeval *tv2); Arguments: -* 'tv1': first "timeval" structure -* 'tv2': second "timeval" structure +* _tv1_: first "timeval" structure +* _tv2_: second "timeval" structure Return value: @@ -2967,8 +2968,8 @@ long long weechat_util_timeval_diff (struct timeval *tv1, struct timeval *tv2); Arguments: -* 'tv1': first "timeval" structure -* 'tv2': second "timeval" structure +* _tv1_: first "timeval" structure +* _tv2_: second "timeval" structure Return value: @@ -3002,8 +3003,8 @@ void weechat_util_timeval_add (struct timeval *tv, long long interval); Arguments: -* 'tv': timeval structure -* 'interval': interval (in microseconds) +* _tv_: timeval structure +* _interval_: interval (in microseconds) [NOTE] With WeeChat ≤ 1.0, the interval was expressed in milliseconds. @@ -3023,7 +3024,7 @@ This function is not available in scripting API. _WeeChat ≥ 0.3.2, updated in 1.3._ Get date/time as a string built with "strftime" and the format defined in -option 'weechat.look.time_format'. +option _weechat.look.time_format_. Prototype: @@ -3034,7 +3035,7 @@ const char *weechat_util_get_time_string (const time_t *date); Arguments: -* 'date': pointer to date +* _date_: pointer to date Return value: @@ -3067,7 +3068,7 @@ int weechat_util_version_number (const char *version); Arguments: -* 'version': WeeChat version as string (example: "0.3.9" or "0.3.9-dev") +* _version_: WeeChat version as string (example: "0.3.9" or "0.3.9-dev") C example: @@ -3136,13 +3137,13 @@ struct t_weelist_item *weechat_list_add (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'data': data to insert in list -* 'where': position in list: -** 'WEECHAT_LIST_POS_SORT': add in list, keeping list sorted -** 'WEECHAT_LIST_POS_BEGINNING': add to beginning of list -** 'WEECHAT_LIST_POS_END': add to end of list -* 'user_data': any pointer +* _weelist_: list pointer +* _data_: data to insert in list +* _where_: position in list: +** _WEECHAT_LIST_POS_SORT_: add in list, keeping list sorted +** _WEECHAT_LIST_POS_BEGINNING_: add to beginning of list +** _WEECHAT_LIST_POS_END_: add to end of list +* _user_data_: any pointer Return value: @@ -3181,8 +3182,8 @@ struct t_weelist_item *weechat_list_search (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'data': data to search in list +* _weelist_: list pointer +* _data_: data to search in list Return value: @@ -3222,8 +3223,8 @@ int weechat_list_search_pos (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'data': data to search in list +* _weelist_: list pointer +* _data_: data to search in list Return value: @@ -3261,8 +3262,8 @@ struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'data': data to search in list +* _weelist_: list pointer +* _data_: data to search in list Return value: @@ -3302,8 +3303,8 @@ int weechat_list_casesearch_pos (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'data': data to search in list +* _weelist_: list pointer +* _data_: data to search in list Return value: @@ -3341,8 +3342,8 @@ struct t_weelist_item *weechat_list_get (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'position': position in list (first item is 0) +* _weelist_: list pointer +* _position_: position in list (first item is 0) Return value: @@ -3379,8 +3380,8 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); Arguments: -* 'item': item pointer -* 'value': new value for item +* _item_: item pointer +* _value_: new value for item C example: @@ -3413,7 +3414,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); Arguments: -* 'item': item pointer +* _item_: item pointer Return value: @@ -3450,7 +3451,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); Arguments: -* 'item': item pointer +* _item_: item pointer Return value: @@ -3487,7 +3488,7 @@ const char *weechat_list_string (struct t_weelist_item *item); Arguments: -* 'item': item pointer +* _item_: item pointer Return value: @@ -3524,7 +3525,7 @@ char *weechat_list_size (struct t_weelist *weelist); Arguments: -* 'weelist': list pointer +* _weelist_: list pointer Return value: @@ -3562,8 +3563,8 @@ void weechat_list_remove (struct t_weelist *weelist, Arguments: -* 'weelist': list pointer -* 'item': item pointer +* _weelist_: list pointer +* _item_: item pointer C example: @@ -3596,7 +3597,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); Arguments: -* 'weelist': list pointer +* _weelist_: list pointer C example: @@ -3629,7 +3630,7 @@ void weechat_list_free (struct t_weelist *weelist); Arguments: -* 'weelist': list pointer +* _weelist_: list pointer C example: @@ -3676,37 +3677,37 @@ struct t_hashtable *weechat_hashtable_new (int size, Arguments: -* 'size': size of internal array to store hashed keys, a high value uses more +* _size_: size of internal array to store hashed keys, a high value uses more memory, but has better performance (this is *not* a limit for number of items in hashtable) -* 'type_keys': type for keys in hashtable: -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'type_values': type for values in hashtable: -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'callback_hash_key': callback used to "hash" a key (key as integer value), can +* _type_keys_: type for keys in hashtable: +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _type_values_: type for values in hashtable: +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _callback_hash_key_: callback used to "hash" a key (key as integer value), can be NULL if key type is not "buffer" (a default hash function is used), arguments and return value: -** 'struct t_hashtable *hashtable': hashtable pointer -** 'const void *key': key +** _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 key type +* _callback_keycmp_: callback used to compare two keys, can be NULL if key type is not "buffer" (a default comparison function is used), arguments and return value: -** 'struct t_hashtable *hashtable': hashtable pointer -** 'const void *key1': first key -** 'const void *key2': second key +** _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' +*** negative number if _key1_ is less than _key2_ +*** 0 if _key1_ equals _key2_ +*** positive number if _key1_ is greater than _key2_ Return value: @@ -3743,12 +3744,12 @@ struct t_hashtable_item *weechat_hashtable_set_with_size (struct t_hashtable *ha Arguments: -* 'hashtable': hashtable pointer -* 'key': key pointer -* 'key_size': size of key (in bytes), used only if type of keys in hashtable +* _hashtable_: hashtable pointer +* _key_: key pointer +* _key_size_: size of key (in bytes), used only if type of keys in hashtable is "buffer" -* 'value': value pointer -* 'value_size': size of value (in bytes), used only if type of values in +* _value_: value pointer +* _value_size_: size of value (in bytes), used only if type of values in hashtable is "buffer" Return value: @@ -3782,9 +3783,9 @@ struct t_hashtable_item *weechat_hashtable_set (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'key': key pointer -* 'value': value pointer +* _hashtable_: hashtable pointer +* _key_: key pointer +* _value_: value pointer Return value: @@ -3815,8 +3816,8 @@ void *weechat_hashtable_get (struct t_hashtable *hashtable, void *key); Arguments: -* 'hashtable': hashtable pointer -* 'key': key pointer +* _hashtable_: hashtable pointer +* _key_: key pointer Return value: @@ -3847,8 +3848,8 @@ int weechat_hashtable_has_key (struct t_hashtable *hashtable, void *key); Arguments: -* 'hashtable': hashtable pointer -* 'key': key pointer +* _hashtable_: hashtable pointer +* _key_: key pointer Return value: @@ -3888,9 +3889,9 @@ void weechat_hashtable_map (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'callback_map': function called for each entry in hashtable -* 'callback_map_data': pointer given to map callback when it is called +* _hashtable_: hashtable pointer +* _callback_map_: function called for each entry in hashtable +* _callback_map_data_: pointer given to map callback when it is called C example: @@ -3932,12 +3933,12 @@ void weechat_hashtable_map_string (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'callback_map': function called for each entry in hashtable -* 'callback_map_data': pointer given to map callback when it is called +* _hashtable_: hashtable pointer +* _callback_map_: function called for each entry in hashtable +* _callback_map_data_: pointer given to map callback when it is called [NOTE] -The strings 'key' and 'value' sent to callback are temporary strings, they +The strings _key_ and _value_ sent to callback are temporary strings, they are deleted after call to callback. C example: @@ -3974,7 +3975,7 @@ struct t_hashtable *weechat_hashtable_dup (struct t_hashtable *hashtable); Arguments: -* 'hashtable': hashtable pointer +* _hashtable_: hashtable pointer Return value: @@ -4006,10 +4007,10 @@ int weechat_hashtable_get_integer (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'property': property name: -** 'size': size of internal array "htable" in hashtable -** 'items_count': number of items in hashtable +* _hashtable_: hashtable pointer +* _property_: property name: +** _size_: size of internal array "htable" in hashtable +** _items_count_: number of items in hashtable Return value: @@ -4041,26 +4042,26 @@ const char *weechat_hashtable_get_string (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'property': property name: -** 'type_keys': type for keys: -*** 'integer': integer -*** 'string': string -*** 'pointer': pointer -*** 'buffer': buffer -*** 'time': time -** 'type_values': type for values: -*** 'integer': integer -*** 'string': string -*** 'pointer': pointer -*** 'buffer': buffer -*** 'time': time -** 'keys': string with list of keys (format: "key1,key2,key3") -** 'keys_sorted': string with list of sorted keys (format: "key1,key2,key3") -** 'values': string with list of values (format: "value1,value2,value3") -** 'keys_values': string with list of keys and values +* _hashtable_: hashtable pointer +* _property_: property name: +** _type_keys_: type for keys: +*** _integer_: integer +*** _string_: string +*** _pointer_: pointer +*** _buffer_: buffer +*** _time_: time +** _type_values_: type for values: +*** _integer_: integer +*** _string_: string +*** _pointer_: pointer +*** _buffer_: buffer +*** _time_: time +** _keys_: string with list of keys (format: "key1,key2,key3") +** _keys_sorted_: string with list of sorted keys (format: "key1,key2,key3") +** _values_: string with list of values (format: "value1,value2,value3") +** _keys_values_: string with list of keys and values (format: "key1:value1,key2:value2,key3:value3") -** 'keys_values_sorted': string with list of keys and values (sorted by keys) +** _keys_values_sorted_: string with list of keys and values (sorted by keys) (format: "key1:value1,key2:value2,key3:value3") Return value: @@ -4096,12 +4097,12 @@ void weechat_hashtable_set_pointer (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'property': property name: -** 'callback_free_key': set callback function used to free keys in hashtable +* _hashtable_: hashtable pointer +* _property_: property name: +** _callback_free_key_: set callback function used to free keys in hashtable _(WeeChat ≥ 0.4.2)_ -** 'callback_free_value': set callback function used to free values in hashtable -* 'pointer': new pointer value for property +** _callback_free_value_: set callback function used to free values in hashtable +* _pointer_: new pointer value for property C example: @@ -4143,9 +4144,9 @@ int weechat_hashtable_add_to_infolist (struct t_hashtable *hashtable, Arguments: -* 'hashtable': hashtable pointer -* 'infolist_item': infolist item pointer -* 'prefix': string used as prefix for names in infolist +* _hashtable_: hashtable pointer +* _infolist_item_: infolist item pointer +* _prefix_: string used as prefix for names in infolist Return value: @@ -4186,8 +4187,8 @@ void weechat_hashtable_remove (struct t_hashtable *hashtable, const void *key); Arguments: -* 'hashtable': hashtable pointer -* 'key': key pointer +* _hashtable_: hashtable pointer +* _key_: key pointer C example: @@ -4214,7 +4215,7 @@ void weechat_hashtable_remove_all (struct t_hashtable *hashtable); Arguments: -* 'hashtable': hashtable pointer +* _hashtable_: hashtable pointer C example: @@ -4241,7 +4242,7 @@ void weechat_hashtable_free (struct t_hashtable *hashtable); Arguments: -* 'hashtable': hashtable pointer +* _hashtable_: hashtable pointer C example: @@ -4278,19 +4279,19 @@ struct t_config_file *weechat_config_new (const char *name, Arguments: -* 'name': name of configuration file (without path or extension) -* 'callback_reload': function called when configuration file is reloaded with +* _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 and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_config_file *config_file': configuration file pointer +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_reload_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_reload_data': pointer given to callback when it is called by +* _callback_reload_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the configuration file is freed @@ -4392,97 +4393,97 @@ struct t_config_section *weechat_config_new_section ( Arguments: -* 'config_file': configuration file pointer -* 'name': name of section -* 'user_can_add_options': 1 if user can create new options in section, or 0 if +* _config_file_: configuration file pointer +* _name_: name of section +* _user_can_add_options_: 1 if user can create new options in section, or 0 if it is forbidden -* 'user_can_delete_options': 1 if user can delete options in section, or 0 if +* _user_can_delete_options_: 1 if user can delete options in section, or 0 if it is forbidden -* 'callback_read': function called when an option in section is read from disk +* _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 and return value: -** 'const void *pointer': pointer -** '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 +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_read_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_read_data': pointer given to callback when it is called by WeeChat; +* _callback_read_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_write': function called when section is written in file (should be +* _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 and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_config_file *config_file': configuration file pointer -** 'struct t_config_section *section': section pointer -** 'const char *section_name': name of section +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_config_file *config_file_: configuration file pointer +** _struct t_config_section *section_: section 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_pointer': pointer given to callback when it is called by +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_write_data': pointer given to callback when it is called by WeeChat; +* _callback_write_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_write_default': function called when default values for section +* _callback_write_default_: function called when default values for section must be written in file, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_config_file *config_file': configuration file pointer -** 'const char *section_name': name of section +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_default_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_write_default_data': pointer given to callback when it is called by +* _callback_write_default_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_create_option': function called when a new option is created in +* _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 and return value: -** 'const void *pointer': pointer -** '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 +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called +*** _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_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_create_option_data': pointer given to callback when it is called by +* _callback_create_option_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_delete_option': function called when an option is deleted in +* _callback_delete_option_: function called when an option is deleted in section (NULL if section does not allow options to be deleted), arguments and return value: -** 'const void *pointer': pointer -** '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 +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called +*** _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_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_delete_option_data': pointer given to callback when it is called by +* _callback_delete_option_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed @@ -4640,8 +4641,8 @@ struct t_config_section *weechat_config_search_section ( Arguments: -* 'config_file': configuration file pointer -* 'section_name': name of section to search +* _config_file_: configuration file pointer +* _section_name_: name of section to search Return value: @@ -4708,58 +4709,58 @@ struct t_config_option *weechat_config_new_option ( Arguments: -* 'config_file': configuration file pointer -* 'section': section pointer -* 'name': name of option; with WeeChat ≥ 1.4, the name can include a parent +* _config_file_: configuration file pointer +* _section_: section pointer +* _name_: name of option; with WeeChat ≥ 1.4, the name can include a parent option name (the value of parent option will be displayed in `/set` command output if this option is "null"), the syntax is then: "name << file.section.option" -* 'type': type of option: -** 'boolean': boolean value (on/off) -** 'integer': integer value (with optional strings for values) -** 'string': string value -** 'color': color -* 'description': description of option -* 'string_values': values as string (separated by "|"), used for type 'integer' - (optional) -* 'min': minimum value (for type 'integer') -* 'max': maximum value (for type 'integer') -* 'default_value': default value for option (used when option is reset) -* 'value': value for option -* 'null_value_allowed': 1 if 'null' (undefined value) is allowed for option, +* _type_: type of option: +** _boolean_: boolean value (on/off) +** _integer_: integer value (with optional strings for values) +** _string_: string value +** _color_: color +* _description_: description of option +* _string_values_: values as string (separated by `+|+`), used for type + _integer_ (optional) +* _min_: minimum value (for type _integer_) +* _max_: maximum value (for type _integer_) +* _default_value_: default value for option (used when option is reset) +* _value_: value for option +* _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 +* _callback_check_value_: function called to check new value for option (optional), arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_config_option *option': option pointer -** 'const char *value': new value for option +** _const void *pointer_: pointer +** _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_pointer': pointer given to check_value callback when it +* _callback_check_value_pointer_: pointer given to check_value callback when it is called by WeeChat -* 'callback_check_value_data': pointer given to callback when it is called by +* _callback_check_value_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the option is freed -* 'callback_change': function called when value of option has changed +* _callback_change_: function called when value of option has changed (optional), arguments: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_config_option *option': option pointer -* 'callback_change_pointer': pointer given to change callback when it is called +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_config_option *option_: option pointer +* _callback_change_pointer_: pointer given to change callback when it is called by WeeChat -* 'callback_change_data': pointer given to callback when it is called by +* _callback_change_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the option is freed -* 'callback_delete': function called when option will be deleted (optional), +* _callback_delete_: function called when option will be deleted (optional), arguments: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_config_option *option': option pointer -* 'callback_delete_pointer': pointer given to delete callback when it is called +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_config_option *option_: option pointer +* _callback_delete_pointer_: pointer given to delete callback when it is called by WeeChat -* 'callback_delete_data': pointer given to callback when it is called by +* _callback_delete_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the option is freed @@ -4900,7 +4901,7 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color", [NOTE] In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6 strings (due to a Ruby limitation of 15 arguments by function), see the -'WeeChat Scripting Guide' for more info _(fixed in version 0.4.1)_. +_WeeChat Scripting Guide_ for more info _(fixed in version 0.4.1)_. ==== config_search_option @@ -4918,9 +4919,9 @@ struct t_config_option *weechat_config_search_option ( Arguments: -* 'config_file': configuration file pointer -* 'section': section pointer -* 'name': name of option to search +* _config_file_: configuration file pointer +* _section_: section pointer +* _name_: name of option to search Return value: @@ -4962,12 +4963,12 @@ void weechat_config_search_section_option (struct t_config_file *config_file, Arguments: -* 'config_file': configuration file pointer -* 'section': section pointer -* 'option_name': option name -* 'section_found': pointer to section pointer, will be set to section of option, +* _config_file_: configuration file pointer +* _section_: section pointer +* _option_name_: option name +* _section_found_: pointer to section pointer, will be set to section of option, if found -* 'option_found': pointer to an option pointer, will be set to option pointer, +* _option_found_: pointer to an option pointer, will be set to option pointer, if found C example: @@ -5012,14 +5013,14 @@ void weechat_config_search_with_string (const char *option_name, Arguments: -* 'option_name': full option name (format: "file.section.option") -* 'config_file': pointer to configuration file pointer, will be set with +* _option_name_: full option name (format: "file.section.option") +* _config_file_: pointer to configuration file pointer, will be set with pointer to configuration file of option found -* 'section': pointer to section pointer, will be set to section of option, if +* _section_: pointer to section pointer, will be set to section of option, if found -* 'option': pointer to an option pointer, will be set to option pointer, if +* _option_: pointer to an option pointer, will be set to option pointer, if found -* 'pos_option_name': pointer to a string pointer, will be set to pointer to +* _pos_option_name_: pointer to a string pointer, will be set to pointer to name of option, if found C example: @@ -5062,7 +5063,7 @@ int weechat_config_string_to_boolean (const char *text); Arguments: -* 'text': text to analyze +* _text_: text to analyze Return value: @@ -5109,15 +5110,15 @@ int weechat_config_option_reset (struct t_config_option *option, Arguments: -* 'option': option pointer -* 'run_callback': 1 for calling callback if value of option is changed, +* _option_: option pointer +* _run_callback_: 1 for calling callback if value of option is changed, otherwise 0 Return value: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' if option value has been reset -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' if value was not changed -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' if an error occurred +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ if option value has been reset +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ if value was not changed +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ if an error occurred C example: @@ -5168,16 +5169,16 @@ int weechat_config_option_set (struct t_config_option *option, Arguments: -* 'option': option pointer -* 'value': new value for option -* 'run_callback': 1 for calling change callback if value of option is changed, +* _option_: option pointer +* _value_: new value for option +* _run_callback_: 1 for calling change callback if value of option is changed, otherwise 0 Return value: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' if option value has been changed -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' if value was not changed -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' if an error occurred +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ if option value has been changed +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ if value was not changed +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ if an error occurred C example: @@ -5228,8 +5229,8 @@ int weechat_config_option_set_null (struct t_config_option *option, Arguments: -* 'option': option pointer -* 'run_callback': 1 for calling change callback if value of option is changed +* _option_: option pointer +* _run_callback_: 1 for calling change callback if value of option is changed (if it was not null), otherwise 0 [NOTE] @@ -5238,9 +5239,9 @@ You can set value to null only if it is allowed for option (see Return value: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' if option value has been changed -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' if value was not changed -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' if an error occurred +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ if option value has been changed +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ if value was not changed +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ if an error occurred C example: @@ -5290,14 +5291,14 @@ int weechat_config_option_unset (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value: -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' if option value has not been reset -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' if option value has been reset -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' if option has been removed -* 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' if an error occurred +* _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ if option value has not been reset +* _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ if option value has been reset +* _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ if option has been removed +* _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ if an error occurred C example: @@ -5353,8 +5354,8 @@ void weechat_config_option_rename (struct t_config_option *option, Arguments: -* 'option': option pointer -* 'new_name': new name for option +* _option_: option pointer +* _new_name_: new name for option C example: @@ -5388,21 +5389,21 @@ void *weechat_config_option_get_pointer (struct t_config_option *option, Arguments: -* 'option': option pointer -* 'property': property name: -** 'config_file': configuration file pointer ('struct t_config_file *') -** 'section': section pointer ('struct t_config_section *') -** 'name': option name ('char *') -** 'parent_name': name of parent option ('char *') _(WeeChat ≥ 1.4)_ -** 'type': option type ('int *') -** 'description': option description ('char *') -** 'string_values': string values ('char *') -** 'min': minimum value ('int *') -** 'max': maximum value ('int *') -** 'default_value': default value (depends on type) -** 'value': current value (depends on type) -** 'prev_option': previous option pointer ('struct t_config_option *') -** 'next_option': next option pointer ('struct t_config_option *') +* _option_: option pointer +* _property_: property name: +** _config_file_: configuration file pointer (_struct t_config_file *_) +** _section_: section pointer (_struct t_config_section *_) +** _name_: option name (_char *_) +** _parent_name_: name of parent option (_char *_) _(WeeChat ≥ 1.4)_ +** _type_: option type (_int *_) +** _description_: option description (_char *_) +** _string_values_: string values (_char *_) +** _min_: minimum value (_int *_) +** _max_: maximum value (_int *_) +** _default_value_: default value (depends on type) +** _value_: current value (depends on type) +** _prev_option_: previous option pointer (_struct t_config_option *_) +** _next_option_: next option pointer (_struct t_config_option *_) Return value: @@ -5431,7 +5432,7 @@ int weechat_config_option_is_null (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value: @@ -5477,7 +5478,7 @@ int weechat_config_option_default_is_null (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value: @@ -5523,14 +5524,14 @@ int weechat_config_boolean (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': boolean value of option (0 or 1) -* 'integer': 0 -* 'string': 0 -* 'color': 0 +* _boolean_: boolean value of option (0 or 1) +* _integer_: 0 +* _string_: 0 +* _color_: 0 C example: @@ -5573,14 +5574,14 @@ int weechat_config_boolean_default (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': default boolean value of option (0 or 1) -* 'integer': 0 -* 'string': 0 -* 'color': 0 +* _boolean_: default boolean value of option (0 or 1) +* _integer_: 0 +* _string_: 0 +* _color_: 0 C example: @@ -5623,14 +5624,14 @@ int weechat_config_integer (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': boolean value of option (0 or 1) -* 'integer': integer value of option -* 'string': 0 -* 'color': color index +* _boolean_: boolean value of option (0 or 1) +* _integer_: integer value of option +* _string_: 0 +* _color_: color index C example: @@ -5665,14 +5666,14 @@ int weechat_config_integer_default (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': default boolean value of option (0 or 1) -* 'integer': default integer value of option -* 'string': 0 -* 'color': default color index +* _boolean_: default boolean value of option (0 or 1) +* _integer_: default integer value of option +* _string_: 0 +* _color_: default color index C example: @@ -5707,15 +5708,15 @@ const char *weechat_config_string (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': "on" if value is true, otherwise "off" -* 'integer': string value if the option is an integer with string values, +* _boolean_: "on" if value is true, otherwise "off" +* _integer_: string value if the option is an integer with string values, otherwise NULL -* 'string': string value of option -* 'color': name of color +* _string_: string value of option +* _color_: name of color C example: @@ -5750,15 +5751,15 @@ const char *weechat_config_string_default (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': "on" if default value is true, otherwise "off" -* 'integer': default string value if the option is an integer with string +* _boolean_: "on" if default value is true, otherwise "off" +* _integer_: default string value if the option is an integer with string values, otherwise NULL -* 'string': default string value of option -* 'color': name of default color +* _string_: default string value of option +* _color_: name of default color C example: @@ -5793,14 +5794,14 @@ const char *weechat_config_color (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': NULL -* 'integer': NULL -* 'string': NULL -* 'color': name of color +* _boolean_: NULL +* _integer_: NULL +* _string_: NULL +* _color_: name of color C example: @@ -5835,14 +5836,14 @@ const char *weechat_config_color_default (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer Return value, depending on the option type: -* 'boolean': NULL -* 'integer': NULL -* 'string': NULL -* 'color': name of default color +* _boolean_: NULL +* _integer_: NULL +* _string_: NULL +* _color_: name of default color C example: @@ -5879,8 +5880,8 @@ void weechat_config_write_option (struct t_config_file *config_file, Arguments: -* 'config_file': configuration file pointer -* 'option': option pointer +* _config_file_: configuration file pointer +* _option_: option pointer C example: @@ -5929,9 +5930,9 @@ void weechat_config_write_line (struct t_config_file *config_file, Arguments: -* 'config_file': configuration file pointer -* 'option_name': option name -* 'value': value (if NULL, then line with section name is written, for +* _config_file_: configuration file pointer +* _option_name_: option name +* _value_: value (if NULL, then line with section name is written, for example: "[section]") C example: @@ -5979,13 +5980,13 @@ int weechat_config_write (struct t_config_file *config_file); Arguments: -* 'config_file': configuration file pointer +* _config_file_: configuration file pointer Return value: -* 'WEECHAT_CONFIG_WRITE_OK' if configuration was written -* 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' if there was not enough memory -* 'WEECHAT_CONFIG_WRITE_ERROR' if another error occurred +* _WEECHAT_CONFIG_WRITE_OK_ if configuration was written +* _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ if there was not enough memory +* _WEECHAT_CONFIG_WRITE_ERROR_ if another error occurred C example: @@ -6035,13 +6036,13 @@ int weechat_config_read (struct t_config_file *config_file); Arguments: -* 'config_file': configuration file pointer +* _config_file_: configuration file pointer Return value: -* 'WEECHAT_CONFIG_READ_OK' if configuration was loaded -* 'WEECHAT_CONFIG_READ_MEMORY_ERROR' if there was not enough memory -* 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' if file was not found +* _WEECHAT_CONFIG_READ_OK_ if configuration was loaded +* _WEECHAT_CONFIG_READ_MEMORY_ERROR_ if there was not enough memory +* _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ if file was not found C example: @@ -6091,13 +6092,13 @@ int weechat_config_reload (struct t_config_file *config_file); Arguments: -* 'config_file': configuration file pointer +* _config_file_: configuration file pointer Return value: -* 'WEECHAT_CONFIG_READ_OK' if configuration was reloaded -* 'WEECHAT_CONFIG_READ_MEMORY_ERROR' if there was not enough memory -* 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' if file was not found +* _WEECHAT_CONFIG_READ_OK_ if configuration was reloaded +* _WEECHAT_CONFIG_READ_MEMORY_ERROR_ if there was not enough memory +* _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ if file was not found C example: @@ -6147,7 +6148,7 @@ void weechat_config_option_free (struct t_config_option *option); Arguments: -* 'option': option pointer +* _option_: option pointer C example: @@ -6180,7 +6181,7 @@ void weechat_config_section_free_options (struct t_config_section *section); Arguments: -* 'section': section pointer +* _section_: section pointer C example: @@ -6213,7 +6214,7 @@ void weechat_config_section_free (struct t_config_section *section); Arguments: -* 'section': section pointer +* _section_: section pointer C example: @@ -6246,7 +6247,7 @@ void weechat_config_free (struct t_config_file *config_file); Arguments: -* 'config_file': configuration file pointer +* _config_file_: configuration file pointer C example: @@ -6279,7 +6280,7 @@ struct t_config_option *weechat_config_get (const char *option_name); Arguments: -* 'option_name': full option name (format: "file.section.option") +* _option_name_: full option name (format: "file.section.option") Return value: @@ -6316,7 +6317,7 @@ const char *weechat_config_get_plugin (const char *option_name); Arguments: -* 'option_name': option name, WeeChat will add prefix "plugins.var.xxx." +* _option_name_: option name, WeeChat will add prefix "plugins.var.xxx." (where "xxx" is current plugin name) Return value: @@ -6356,7 +6357,7 @@ int weechat_config_is_set_plugin (const char *option_name); Arguments: -* 'option_name': option name, WeeChat will add prefix "plugins.var.xxx." +* _option_name_: option name, WeeChat will add prefix "plugins.var.xxx." (where "xxx" is current plugin name) Return value: @@ -6406,16 +6407,16 @@ int weechat_config_set_plugin (const char *option_name, const char *value); Arguments: -* 'option_name': option name, WeeChat will add prefix "plugins.var.xxx." +* _option_name_: option name, WeeChat will add prefix "plugins.var.xxx." (where "xxx" is current plugin name) -* 'value': new value for option +* _value_: new value for option Return value: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' if option value has been changed -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' if value was not changed -* 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' if option was not found -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' if other error occurred +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ if option value has been changed +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ if value was not changed +* _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ if option was not found +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ if other error occurred C example: @@ -6473,9 +6474,9 @@ void weechat_config_set_desc_plugin (const char *option_name, Arguments: -* 'option_name': option name, WeeChat will add prefix "plugins.desc.xxx." +* _option_name_: option name, WeeChat will add prefix "plugins.desc.xxx." (where "xxx" is current plugin name) -* 'description': description for option +* _description_: description for option [NOTE] It is not a problem if option (plugins.var.xxx.option_name) does not exist. @@ -6514,15 +6515,15 @@ int weechat_config_unset_plugin (const char *option_name); Arguments: -* 'option_name': option name, WeeChat will add prefix "plugins.var.xxx." +* _option_name_: option name, WeeChat will add prefix "plugins.var.xxx." (where xxx is current plugin name) Return value: -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' if option value has not been reset -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' if option value has been reset -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' if option has been removed -* 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' if an error occurred +* _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ if option value has not been reset +* _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ if option value has been reset +* _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ if option has been removed +* _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ if an error occurred C example: @@ -6589,12 +6590,12 @@ int weechat_key_bind (const char *context, struct t_hashtable *keys); Arguments: -* 'context': context for keys: -** 'default': default context (common actions) -** 'search': search context (when searching text in buffer) -** 'cursor': free movement of cursor on screen -** 'mouse': keys for mouse events -* 'keys': hashtable with key bindings +* _context_: context for keys: +** _default_: default context (common actions) +** _search_: search context (when searching text in buffer) +** _cursor_: free movement of cursor on screen +** _mouse_: keys for mouse events +* _keys_: hashtable with key bindings Return value: @@ -6651,9 +6652,9 @@ int weechat_key_unbind (const char *context, const char *key); Arguments: -* 'context': context for keys (see <<_key_bind,weechat_key_bind>>) -* 'key': key to remove or a special value "area:XXX" to remove all keys having - 'XXX' as first or second area +* _context_: context for keys (see <<_key_bind,weechat_key_bind>>) +* _key_: key to remove or a special value "area:XXX" to remove all keys having + _XXX_ as first or second area Return value: @@ -6704,7 +6705,7 @@ const char *weechat_prefix (const char *prefix); Arguments: -* 'prefix': name of prefix (see table below) +* _prefix_: name of prefix (see table below) Return value: @@ -6713,14 +6714,14 @@ Return value: List of prefixes: -[width="70%",cols="^2e,^1,^3,5",options="header"] +[width="70%",cols="^2m,^1,^3,5",options="header"] |=== -| Prefix | Value | Color | Description -| error | `=!=` | yellow | Error message -| network | `--` | magenta | Message from network -| action | `*` | white | Self action -| join | `-->` | lightgreen | Someone joins current chat -| quit | `<--` | lightred | Someone leaves current chat +| Prefix | Value | Color | Description +| error | `+=!=+` | yellow | Error message +| network | `+--+` | magenta | Message from network +| action | `+*+` | white | Self action +| join | `+-->+` | lightgreen | Someone joins current chat +| quit | `+<--+` | lightred | Someone leaves current chat |=== [NOTE] @@ -6757,49 +6758,49 @@ const char *weechat_color (const char *color_name); Arguments: -* 'color_name': name of color, one of: +* _color_name_: name of color, one of: ** WeeChat color option name (from weechat.color.xxx), for example - 'chat_delimiters' + _chat_delimiters_ ** option name (format: file.section.option), for example - 'irc.color.message_quit' (_WeeChat ≥ 1.2_) + _irc.color.message_quit_ (_WeeChat ≥ 1.2_) ** color with optional attributes/background (see below) ** attribute: -*** 'bold': set bold -*** '-bold': remove bold -*** 'reverse': set reverse -*** '-reverse': remove reverse -*** 'italic': set italic -*** '-italic': remove italic -*** 'underline': set underline -*** '-underline': remove underline -*** 'emphasis': toggle the emphasis for text (note: this should be used only in +*** _bold_: set bold +*** _-bold_: remove bold +*** _reverse_: set reverse +*** _-reverse_: remove reverse +*** _italic_: set italic +*** _-italic_: remove italic +*** _underline_: set underline +*** _-underline_: remove underline +*** _emphasis_: toggle the emphasis for text (note: this should be used only in bars, because WeeChat uses text emphasis when searching text in buffer) _(WeeChat ≥ 0.4.2)_ ** bar color name: -*** 'bar_fg': foreground color for bar -*** 'bar_delim': delimiters color for bar -*** 'bar_bg': background color for bar +*** _bar_fg_: foreground color for bar +*** _bar_delim_: delimiters color for bar +*** _bar_bg_: background color for bar ** reset: -*** 'reset': reset color and attributes -*** 'resetcolor': reset color (keep attributes) _(WeeChat ≥ 0.3.6)_ +*** _reset_: reset color and attributes +*** _resetcolor_: reset color (keep attributes) _(WeeChat ≥ 0.3.6)_ Format of color is: attributes (optional) + color name + ",background" (optional). Possible attributes are: -* `*` : bold text -* `!` : reverse video -* `/` : italic -* `_` : underlined text -* `|` : keep attributes: do not reset bold/reverse/italic/underlined when +* `+*+` : bold text +* `+!+` : reverse video +* `+/+` : italic +* `+_+` : underlined text +* `+|+` : keep attributes: do not reset bold/reverse/italic/underlined when changing color _(WeeChat ≥ 0.3.6)_ Examples: -* `yellow` : yellow -* `_green` : underlined green -* `*214` : bold orange -* `yellow,red` : yellow on red -* `|cyan` : cyan (and keep any attribute which was set previously) +* `+yellow+` : yellow +* `+_green+` : underlined green +* `+*214+` : bold orange +* `+yellow,red+` : yellow on red +* `+|cyan+` : cyan (and keep any attribute which was set previously) Return value: @@ -6840,8 +6841,8 @@ void weechat_printf (struct t_gui_buffer *buffer, const char *message, ...); Arguments: -* 'buffer': buffer pointer, if NULL, message is displayed on WeeChat buffer -* 'message': message to display +* _buffer_: buffer pointer, if NULL, message is displayed on WeeChat buffer +* _message_: message to display [NOTE] The first tabulation in message ("\t") is used to separate prefix from message. + @@ -6899,9 +6900,9 @@ void weechat_printf_date (struct t_gui_buffer *buffer, time_t date, Arguments: -* 'buffer': buffer pointer, if NULL, message is displayed on WeeChat buffer -* 'date': date for message (0 means current date/time) -* 'message': message to display +* _buffer_: buffer pointer, if NULL, message is displayed on WeeChat buffer +* _date_: date for message (0 means current date/time) +* _message_: message to display C example: @@ -6927,9 +6928,9 @@ void weechat_printf_tags (struct t_gui_buffer *buffer, const char *tags, Arguments: -* 'buffer': buffer pointer, if NULL, message is displayed on WeeChat buffer -* 'tags': comma separated list of tags -* 'message': message to display +* _buffer_: buffer pointer, if NULL, message is displayed on WeeChat buffer +* _tags_: comma separated list of tags +* _message_: message to display C example: @@ -6956,10 +6957,10 @@ void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date, Arguments: -* 'buffer': buffer pointer, if NULL, message is displayed on WeeChat buffer -* 'date': date for message (0 means current date/time) -* 'tags': comma separated list of tags -* 'message': message to display +* _buffer_: buffer pointer, if NULL, message is displayed on WeeChat buffer +* _date_: date for message (0 means current date/time) +* _tags_: comma separated list of tags +* _message_: message to display Tags commonly used (non-exhaustive list): @@ -7025,12 +7026,12 @@ void weechat_printf_y (struct t_gui_buffer *buffer, int y, Arguments: -* 'buffer': buffer pointer -* 'y': line number (first line is 0); a negative value adds a line after last - line displayed: absolute value of 'y' is the number of lines after last line +* _buffer_: buffer pointer +* _y_: line number (first line is 0); a negative value adds a line after last + line displayed: absolute value of _y_ is the number of lines after last line (for example -1 is immediately after last line, -2 is 2 lines after last line) _(WeeChat ≥ 1.0)_ -* 'message': message to display +* _message_: message to display C example: @@ -7066,7 +7067,7 @@ void weechat_log_printf (const char *message, ...); Arguments: -* 'message': message to write +* _message_: message to write C example: @@ -7147,28 +7148,28 @@ struct t_hook *weechat_hook_command (const char *command, Arguments: -* 'command': command name +* _command_: command name (priority allowed, see note about <<hook_priority,priority>>) -* 'description': description for command (displayed with `/help command`) -* 'args': arguments for command (displayed with `/help command`) -* 'args_description': description of arguments (displayed with `/help command`) -* 'completion': completion template for command: list of completions for each +* _description_: description for command (displayed with `/help command`) +* _args_: arguments for command (displayed with `/help command`) +* _args_description_: description of arguments (displayed with `/help command`) +* _completion_: completion template for command: list of completions for each 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 and return value: -** 'const void *pointer': pointer -** '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, separated by `+|+`. Many templates are possible for same command, + separated by `+||+`. +* _callback_: function called when command is used, arguments and return value: +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7178,9 +7179,9 @@ include::autogen/plugin_api/completions.asciidoc[] Special codes: -* '%%command': reuse completion template from command 'command' -* '%-': stop completion -* '%*': repeat last completion +* `+%%command+`: reuse completion template from command _command_ +* `+%-+`: stop completion +* `+%*+`: repeat last completion Return value: @@ -7215,21 +7216,21 @@ struct t_hook *my_command_hook = &my_command_cb, NULL, NULL); ---- -For example, if command called is `/command abc def ghi`, then 'argv' and -'argv_eol' have following values: +For example, if command called is `/command abc def ghi`, then _argv_ and +_argv_eol_ have following values: -* 'argv': -** 'argv[0]' == "/command" -** 'argv[1]' == "abc" -** 'argv[2]' == "def" -** 'argv[3]' == "ghi" -* 'argv_eol': -** 'argv_eol[0]' == "/command abc def ghi" -** 'argv_eol[1]' == "abc def ghi" -** 'argv_eol[2]' == "def ghi" -** 'argv_eol[3]' == "ghi" +* _argv_: +** _argv[0]_ == "/command" +** _argv[1]_ == "abc" +** _argv[2]_ == "def" +** _argv[3]_ == "ghi" +* _argv_eol_: +** _argv_eol[0]_ == "/command abc def ghi" +** _argv_eol[1]_ == "abc def ghi" +** _argv_eol[2]_ == "def ghi" +** _argv_eol[3]_ == "ghi" -For scripts, 'args' has value "abc def ghi". +For scripts, _args_ has value "abc def ghi". Script (Python): @@ -7277,24 +7278,24 @@ struct t_hook *weechat_hook_command_run (const char *command, Arguments: -* 'command': command to hook (wildcard "*" is allowed) +* _command_: command to hook (wildcard `+*+` is allowed) (priority allowed, see note about <<hook_priority,priority>>) -* 'callback': function called when command is run, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_gui_buffer *buffer': buffer where command is executed -** 'const char *command': the command executed, with its arguments +* _callback_: function called when command is run, arguments and return value: +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted [NOTE] -Callback can return 'WEECHAT_RC_OK' or 'WEECHAT_RC_OK_EAT' (command will not +Callback can return _WEECHAT_RC_OK_ or _WEECHAT_RC_OK_EAT_ (command will not be executed by WeeChat after callback). Return value: @@ -7355,20 +7356,20 @@ struct t_hook *weechat_hook_timer (long interval, Arguments: -* 'interval': interval between two calls (milliseconds, so 1000 = 1 second) -* 'align_second': alignment on a second. For example, if current time is 09:00, +* _interval_: interval between two calls (milliseconds, so 1000 = 1 second) +* _align_second_: alignment on a second. For example, if current time is 09:00, if interval = 60000 (60 seconds), and align_second = 60, then timer is called each minute when second is 0 -* 'max_calls': number of calls to timer (if 0, then timer has no end) -* 'callback': function called when time is reached, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'int remaining_calls': remaining calls (-1 if timer has no end) +* _max_calls_: number of calls to timer (if 0, then timer has no end) +* _callback_: function called when time is reached, arguments and return value: +** _const void *pointer_: pointer +** _void *data_: pointer +** _int remaining_calls_: remaining calls (-1 if timer has no end) ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7431,21 +7432,21 @@ struct t_hook *weechat_hook_fd (int fd, Arguments: -* 'fd': file descriptor -* 'flag_read': 1 = catch read event, 0 = ignore -* 'flag_write': 1 = catch write event, 0 = ignore -* 'flag_exception': 1 = catch exception event, 0 = ignore +* _fd_: file descriptor +* _flag_read_: 1 = catch read event, 0 = ignore +* _flag_write_: 1 = catch write event, 0 = ignore +* _flag_exception_: 1 = catch exception event, 0 = ignore (_WeeChat ≥ 1.3_: this argument is ignored and not used any more) -* 'callback': function called a selected event occurs for file (or socket), +* _callback_: function called a selected event occurs for file (or socket), arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'int fd': file descriptor +** _const void *pointer_: pointer +** _void *data_: pointer +** _int fd_: file descriptor ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7499,7 +7500,7 @@ shell does). + If the split is not correct (according to quotes in your command), or if you want to use shell, you can use function <<_hook_process_hashtable,weechat_hook_process_hashtable>> with -arguments in the hashtable 'options' _(WeeChat ≥ 0.4.0)_. +arguments in the hashtable _options_ _(WeeChat ≥ 0.4.0)_. Prototype: @@ -7520,34 +7521,34 @@ struct t_hook *weechat_hook_process (const char *command, Arguments: -* 'command': command to launch in child process, URL _(WeeChat ≥ 0.3.7)_ or +* _command_: command to launch in child process, URL _(WeeChat ≥ 0.3.7)_ or function _(WeeChat ≥ 1.5)_ (see below) -* 'timeout': timeout for command (in milliseconds): after this timeout, child +* _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 +* _callback_: function called when data from child is available, or when child has ended, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *command': command executed by child -** 'int return_code': return code: -*** '>= 0': child return code for a command, and for URL possible values are: -**** '0': transfer OK -**** '1': invalid URL -**** '2': transfer error -**** '3': not enough memory -**** '4': error with a file -*** '< 0': -**** 'WEECHAT_HOOK_PROCESS_RUNNING': data available, but child still running) -**** 'WEECHAT_HOOK_PROCESS_ERROR': error when launching command -**** 'WEECHAT_HOOK_PROCESS_CHILD': callback is called in the child process -** 'out': standard output of command (stdout) -** 'err': error output of command (stderr) +** _const void *pointer_: pointer +** _void *data_: pointer +** _const char *command_: command executed by child +** _int return_code_: return code: +*** _>= 0_: child return code for a command, and for URL possible values are: +**** _0_: transfer OK +**** _1_: invalid URL +**** _2_: transfer error +**** _3_: not enough memory +**** _4_: error with a file +*** _< 0_: +**** _WEECHAT_HOOK_PROCESS_RUNNING_: data available, but child still running) +**** _WEECHAT_HOOK_PROCESS_ERROR_: error when launching command +**** _WEECHAT_HOOK_PROCESS_CHILD_: callback is called in the child process +** _out_: standard output of command (stdout) +** _err_: error output of command (stderr) ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ *** child process return code (in case of function with "func:" in command) -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7564,11 +7565,11 @@ with function <<_hook_process_hashtable,weechat_hook_process_hashtable>>. The command can also be a function name with format: "func:name", to execute the function "name" _(WeeChat ≥ 1.5)_. This function receives a single argument -('data') and must return a string, which is sent to the callback. + +(_data_) and must return a string, which is sent to the callback. + In C API, the callback is called with the return code set to -'WEECHAT_HOOK_PROCESS_CHILD', which means the callback is running in the child +_WEECHAT_HOOK_PROCESS_CHILD_, which means the callback is running in the child process (after fork). + -In scripting API, the function 'name' is called directly and its result +In scripting API, the function _name_ is called directly and its result (string) is sent to the callback (like the output of an external command). [TIP] @@ -7739,7 +7740,7 @@ struct t_hook *weechat_hook_process_hashtable (const char *command, Arguments are the same as function <<_hook_process,weechat_hook_process>>, with an extra argument: -* 'options': options for command executed; the hashtable is duplicated in +* _options_: options for command executed; the hashtable is duplicated in function, so it's safe to free it after this call For a standard command (not beginning with "url:"), following options are @@ -7754,7 +7755,7 @@ available: any string | Arguments for command; if no argument is given with these options, the command is automatically split like the shell does (and then command - arguments are read in the 'command' argument) + arguments are read in the _command_ argument) | stdin + _(WeeChat ≥ 0.4.3)_ | @@ -7772,7 +7773,7 @@ available: _(WeeChat ≥ 1.0)_ | (not used) | Run the process in a detached mode: stdout and stderr are redirected to - '/dev/null' + _/dev/null_ |=== For command "url:...", following options are available (see @@ -7786,8 +7787,8 @@ options with type "mask", format is: "value1+value2+value3". For URL, two extra options (strings) are allowed for input/output file: -* 'file_in': file to read and send with URLs (post file) -* 'file_out': write downloaded URL/file in this file (instead of standard +* _file_in_: file to read and send with URLs (post file) +* _file_out_: write downloaded URL/file in this file (instead of standard output) Return value: @@ -7952,51 +7953,51 @@ struct t_hook *weechat_hook_connect (const char *proxy, Arguments: -* 'proxy': name of proxy to use for connection (optional, NULL means connection +* _proxy_: name of proxy to use for connection (optional, NULL means connection without proxy) -* 'address': name or IP address to connect to -* 'port': port number -* 'ipv6': 1 to use IPv6 (with fallback to IPv4), 0 to use only IPv4 -* 'retry': retry count, used to fallback to IPv4 hosts if IPv6 hosts connect +* _address_: name or IP address to connect to +* _port_: port number +* _ipv6_: 1 to use IPv6 (with fallback to IPv4), 0 to use only IPv4 +* _retry_: retry count, used to fallback to IPv4 hosts if IPv6 hosts connect but then fail to accept the client -* 'gnutls_sess': GnuTLS session (optional) -* 'gnutls_cb': GnuTLS callback (optional) -* 'gnutls_dhkey_size': size of the key used during the Diffie-Hellman Key +* _gnutls_sess_: GnuTLS session (optional) +* _gnutls_cb_: GnuTLS callback (optional) +* _gnutls_dhkey_size_: size of the key used during the Diffie-Hellman Key Exchange (GnuTLS) -* 'gnutls_priorities': priorities for gnutls (for syntax, see documentation of - function 'gnutls_priority_init' in gnutls manual), basic values are: -** 'PERFORMANCE' -** 'NORMAL' (default) -** 'SECURE128' -** 'SECURE256' -** 'EXPORT' -** 'NONE' -* 'local_hostname': local hostname to use for connection (optional) -* 'callback': function called when connection is OK or failed, arguments and +* _gnutls_priorities_: priorities for gnutls (for syntax, see documentation of + function _gnutls_priority_init_ in gnutls manual), basic values are: +** _PERFORMANCE_ +** _NORMAL_ (default) +** _SECURE128_ +** _SECURE256_ +** _EXPORT_ +** _NONE_ +* _local_hostname_: local hostname to use for connection (optional) +* _callback_: function called when connection is OK or failed, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'int status': connection status: -*** 'WEECHAT_HOOK_CONNECT_OK': connection OK -*** 'WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND': address not found -*** 'WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND': IP address not found -*** 'WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED': connection refused -*** 'WEECHAT_HOOK_CONNECT_PROXY_ERROR': error with proxy -*** 'WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR': error with local hostname -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR': GnuTLS init error -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR': GnuTLS handshake error -*** 'WEECHAT_HOOK_CONNECT_MEMORY_ERROR': insufficient memory -*** 'WEECHAT_HOOK_CONNECT_TIMEOUT': timeout -*** 'WEECHAT_HOOK_CONNECT_SOCKET_ERROR': unable to create socket -** 'gnutls_rc': return value of 'gnutls_handshake()' -** 'sock': socket used to connect -** 'const char *error': return value of 'gnutls_strerror(gnutls_rc)' -** 'const char *ip_address': IP address found +** _const void *pointer_: pointer +** _void *data_: pointer +** _int status_: connection status: +*** _WEECHAT_HOOK_CONNECT_OK_: connection OK +*** _WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND_: address not found +*** _WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND_: IP address not found +*** _WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED_: connection refused +*** _WEECHAT_HOOK_CONNECT_PROXY_ERROR_: error with proxy +*** _WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR_: error with local hostname +*** _WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR_: GnuTLS init error +*** _WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR_: GnuTLS handshake error +*** _WEECHAT_HOOK_CONNECT_MEMORY_ERROR_: insufficient memory +*** _WEECHAT_HOOK_CONNECT_TIMEOUT_: timeout +*** _WEECHAT_HOOK_CONNECT_SOCKET_ERROR_: unable to create socket +** _gnutls_rc_: return value of _gnutls_handshake()_ +** _sock_: socket used to connect +** _const char *error_: return value of _gnutls_strerror(gnutls_rc)_ +** _const char *ip_address_: IP address found ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -8127,34 +8128,34 @@ struct t_hook *weechat_hook_print (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer, if NULL, messages from any buffer are caught -* 'tags': catch only messages with these tags (optional): +* _buffer_: buffer pointer, if NULL, messages from any buffer are caught +* _tags_: catch only messages with these tags (optional): ** with WeeChat ≥ 0.4.3: comma-separated list of tags that must be in message (logical "or"); it is possible to combine many tags as a logical "and" with - separator "+"; wildcard "*" is allowed in tags + separator `+++`; wildcard `+*+` is allowed in tags ** with WeeChat ≤ 0.4.2: comma-separated list of tags that must all be in message (logical "and") -* 'message': only messages with this string will be caught (optional, case +* _message_: only messages with this string will be caught (optional, case insensitive) -* 'strip_colors': if 1, colors will be stripped from message displayed, before +* _strip_colors_: if 1, colors will be stripped from message displayed, before calling callback -* 'callback': function called when a message is printed, arguments and return +* _callback_: function called when a message is printed, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_gui_buffer *buffer': buffer pointer -** 'time_t date': date -** 'int tags_count': number of tags for line -** 'const char **tags': array with tags for line -** 'int displayed': 1 if line is displayed, 0 if it is filtered (hidden) -** 'int highlight': 1 if line has highlight, otherwise 0 -** 'const char *prefix': prefix -** 'const char *message': message +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_gui_buffer *buffer_: buffer pointer +** _time_t date_: date +** _int tags_count_: number of tags for line +** _const char **tags_: array with tags for line +** _int displayed_: 1 if line is displayed, 0 if it is filtered (hidden) +** _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_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -8163,10 +8164,10 @@ Return value: * pointer to new hook, NULL if error occurred [IMPORTANT] -In scripts, with WeeChat ≥ 1.0, the callback arguments 'displayed' and -'highlight' are integers (with WeeChat ≤ 0.4.3, they were strings). + +In scripts, with WeeChat ≥ 1.0, the callback arguments _displayed_ and +_highlight_ are integers (with WeeChat ≤ 0.4.3, they were strings). + To be compatible with all versions, it is recommended to convert the argument -to integer before testing it, for example in Python: "`if int(highlight):`". +to integer before testing it, for example in Python: `if int(highlight):`. C example: @@ -8226,26 +8227,26 @@ struct t_hook *weechat_hook_signal (const char *signal, Arguments: -* 'signal': signal to catch, wildcard "*" is allowed +* _signal_: signal to catch, wildcard `+*+` is allowed (priority allowed, see note about <<hook_priority,priority>>) (see table below) -* 'callback': function called when signal is received, arguments and return +* _callback_: function called when signal is received, arguments and return value: -** 'const void *pointer': pointer -** '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 +** _const void *pointer_: pointer +** _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_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ (stop sending the signal immediately) _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -8703,17 +8704,17 @@ List of signals sent by WeeChat and plugins: | weechat | key_combo_default + _(WeeChat ≥ 1.0)_ | String: key combo | - Key combo in 'default' context + Key combo in _default_ context | weechat | key_combo_search + _(WeeChat ≥ 1.0)_ | String: key combo | - Key combo in 'search' context + Key combo in _search_ context | weechat | key_combo_cursor + _(WeeChat ≥ 1.0)_ | String: key combo | - Key combo in 'cursor' context + Key combo in _cursor_ context | weechat | mouse_enabled + _(WeeChat ≥ 1.1)_ | @@ -8891,7 +8892,7 @@ List of signals sent by WeeChat and plugins: |=== [NOTE] -^(1)^ 'xxx' is IRC server name, 'yyy' is IRC command name. +^(1)^ _xxx_ is IRC server name, _yyy_ is IRC command name. C example: @@ -8942,18 +8943,18 @@ int weechat_hook_signal_send (const char *signal, const char *type_data, Arguments: -* 'signal': signal to send -* 'type_data': type of data sent with signal (see +* _signal_: signal to send +* _type_data_: type of data sent with signal (see <<_hook_signal,weechat_hook_signal>>) -* 'signal_data': data sent with signal +* _signal_data_: data sent with signal Return value _(WeeChat ≥ 1.0)_: -* return code of last callback executed ('WEECHAT_RC_OK' if no callback was +* return code of last callback executed (_WEECHAT_RC_OK_ if no callback was executed): -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ C example: @@ -9000,22 +9001,22 @@ weechat.hook_signal_send("logger_backlog", weechat.WEECHAT_HOOK_SIGNAL_POINTER, Five signals can be sent to install a script, according to language: -* 'perl_script_install' -* 'python_script_install' -* 'ruby_script_install' -* 'lua_script_install' -* 'tcl_script_install' -* 'guile_script_install' -* 'javascript_script_install' +* _perl_script_install_ +* _python_script_install_ +* _ruby_script_install_ +* _lua_script_install_ +* _tcl_script_install_ +* _guile_script_install_ +* _javascript_script_install_ The callback will do following actions when receiving signal: . unload and remove installed script -. move new script to directory '~/.weechat/xxx/' (where 'xxx' is language) -. create link to new script in directory '~/.weechat/xxx/autoload/' +. move new script to directory _~/.weechat/xxx/_ (where _xxx_ is language) +. create link to new script in directory _~/.weechat/xxx/autoload/_ . load new script -These signals are used by 'script' plugin to install scripts. +These signals are used by _script_ plugin to install scripts. Argument is a string with path to script to install. @@ -9040,20 +9041,20 @@ weechat.hook_signal_send("python_script_install", WEECHAT_HOOK_SIGNAL_STRING, Five signals can be sent to remove list of scripts, according to language: -* 'perl_script_remove' -* 'python_script_remove' -* 'ruby_script_remove' -* 'lua_script_remove' -* 'tcl_script_remove' -* 'guile_script_remove' -* 'javascript_script_remove' +* _perl_script_remove_ +* _python_script_remove_ +* _ruby_script_remove_ +* _lua_script_remove_ +* _tcl_script_remove_ +* _guile_script_remove_ +* _javascript_script_remove_ For each script in list, the callback will unload then remove script. -These signals are used by 'script' plugin to remove scripts. +These signals are used by _script_ plugin to remove scripts. Argument is a string with comma-separated list of script to remove (script -is name without path, for example 'script.py'). +is name without path, for example _script.py_). C example: @@ -9088,11 +9089,11 @@ Argument is a string with following format: * channel name (optional) * semicolon * comma-separated list of options (optional): -** 'priority_high': queue with high priority (like user messages); this is the +** _priority_high_: queue with high priority (like user messages); this is the default priority -** 'priority_low': queue with low priority (like messages automatically sent by +** _priority_low_: queue with low priority (like messages automatically sent by WeeChat) -** 'user_message': force user message (don't execute a command) +** _user_message_: force user message (don't execute a command) * semicolon * comma-separated list of tags used when sending message (optional) * semicolon @@ -9145,22 +9146,22 @@ struct t_hook *weechat_hook_hsignal (const char *signal, Arguments: -* 'signal': signal to catch, wildcard "*" is allowed +* _signal_: signal to catch, wildcard `+*+` is allowed (priority allowed, see note about <<hook_priority,priority>>) (see table below) -* 'callback': function called when signal is received, arguments and return +* _callback_: function called when signal is received, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *signal': signal received -** 'struct t_hashtable *hashtable': hashtable +** _const void *pointer_: pointer +** _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_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ (stop sending the signal immediately) _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9181,49 +9182,49 @@ List of hsignals: | weechat | nicklist_group_added + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'group' ('struct t_gui_nick_group *'): group | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _group_ (_struct t_gui_nick_group *_): group | Group added in nicklist | weechat | nicklist_nick_added + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'nick' ('struct t_gui_nick *'): nick | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _nick_ (_struct t_gui_nick *_): nick | Nick added in nicklist | weechat | nicklist_group_removing + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'group' ('struct t_gui_nick_group *'): group | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _group_ (_struct t_gui_nick_group *_): group | Removing group from nicklist | weechat | nicklist_nick_removing + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'nick' ('struct t_gui_nick *'): nick | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _nick_ (_struct t_gui_nick *_): nick | Removing nick from nicklist | weechat | nicklist_group_changed + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'group' ('struct t_gui_nick_group *'): group | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _group_ (_struct t_gui_nick_group *_): group | Group changed in nicklist | weechat | nicklist_nick_changed + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'nick' ('struct t_gui_nick *'): nick | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _nick_ (_struct t_gui_nick *_): nick | Nick changed in nicklist |=== [NOTE] -^(1)^ 'xxx' is signal argument used in redirection, 'yyy' is redirection +^(1)^ _xxx_ is signal argument used in redirection, _yyy_ is redirection pattern. C example: @@ -9272,16 +9273,16 @@ int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable Arguments: -* 'signal': signal to send -* 'hashtable': hashtable +* _signal_: signal to send +* _hashtable_: hashtable Return value _(WeeChat ≥ 1.0)_: -* return code of last callback executed ('WEECHAT_RC_OK' if no callback was +* return code of last callback executed (_WEECHAT_RC_OK_ if no callback was executed): -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ C example: @@ -9322,51 +9323,51 @@ command to a callback. Argument is a hashtable with following entries (keys and values are string): -* 'server': internal server name (required) -* 'pattern': redirect pattern to use (required), either a default one (defined +* _server_: internal server name (required) +* _pattern_: redirect pattern to use (required), either a default one (defined by irc plugin), or a user pattern (see <<hsignal_irc_redirect_pattern>>), default patterns are: -** 'ison' -** 'list' -** 'mode_channel' -** 'mode_channel_ban' ("mode #channel b") -** 'mode_channel_ban_exception' ("mode #channel e") -** 'mode_channel_invite' ("mode #channel I") -** 'mode_user' -** 'monitor' -** 'names' -** 'ping' -** 'time' -** 'topic' -** 'userhost' -** 'who' -** 'whois' -** 'whowas' -* 'signal': signal name (required) -* 'count': number of times redirection will work (optional, 1 by default) -* 'string': string that must be in irc messages received (optional, but +** _ison_ +** _list_ +** _mode_channel_ +** _mode_channel_ban_ ("mode #channel b") +** _mode_channel_ban_exception_ ("mode #channel e") +** _mode_channel_invite_ ("mode #channel I") +** _mode_user_ +** _monitor_ +** _names_ +** _ping_ +** _time_ +** _topic_ +** _userhost_ +** _who_ +** _whois_ +** _whowas_ +* _signal_: signal name (required) +* _count_: number of times redirection will work (optional, 1 by default) +* _string_: string that must be in irc messages received (optional, but recommended, if a string can be used to identify messages) -* 'timeout': timeout for redirect, in seconds (optional, 60 by default) -* 'cmd_filter': comma-separated list of irc commands to filter (only these +* _timeout_: timeout for redirect, in seconds (optional, 60 by default) +* _cmd_filter_: comma-separated list of irc commands to filter (only these commands will be sent to callbacks, other will be ignored) (optional) Immediately after sending this hsignal, you must send command to irc server, and redirection will be used for this command. When complete answer to your command has been be received, a hsignal will be -send. This hsignal has name 'irc_redirection_xxx_yyy' where 'xxx' is the -'signal' and 'yyy' the 'pattern' used. +send. This hsignal has name _irc_redirection_xxx_yyy_ where _xxx_ is the +_signal_ and _yyy_ the _pattern_ used. Hashtable sent in hsignal has following content (key and values are strings): -* 'output': output of command (messages are separated by "\n") -* 'output_size': number of bytes in 'output' (as string) -* 'error': error string (if an error occurred): -** 'timeout': redirection stopped after timeout -* 'server': internal server name -* 'pattern': redirect pattern -* 'signal': signal name -* 'command': redirected command +* _output_: output of command (messages are separated by "\n") +* _output_size_: number of bytes in _output_ (as string) +* _error_: error string (if an error occurred): +** _timeout_: redirection stopped after timeout +* _server_: internal server name +* _pattern_: redirect pattern +* _signal_: signal name +* _command_: redirected command C example: @@ -9427,14 +9428,14 @@ redirect (see <<hsignal_irc_redirect_command>>). Argument is a hashtable with following entries (keys and values are string): -* 'pattern': name of pattern (required) -* 'timeout': default timeout for pattern, in seconds (optional, 60 by default) -* 'cmd_start': comma-separated list of commands starting redirect (optional) -* 'cmd_stop': comma-separated list of commands stopping redirect (required) -* 'cmd_extra': comma-separated list of commands that may be received +* _pattern_: name of pattern (required) +* _timeout_: default timeout for pattern, in seconds (optional, 60 by default) +* _cmd_start_: comma-separated list of commands starting redirect (optional) +* _cmd_stop_: comma-separated list of commands stopping redirect (required) +* _cmd_extra_: comma-separated list of commands that may be received after stop commands (optional) -For each command in 'cmd_start', 'cmd_stop' and 'cmd_extra', it is possible to +For each command in _cmd_start_, _cmd_stop_ and _cmd_extra_, it is possible to give integer with position of "string" that must be found in received message, for example: @@ -9510,20 +9511,20 @@ struct t_hook *weechat_hook_config (const char *option, Arguments: -* 'option': option, format is full name, as used with command `/set` (for - example: `weechat.look.item_time_format`), wildcard "*" is allowed +* _option_: option, format is full name, as used with command `/set` (for + example: `weechat.look.item_time_format`), wildcard `+*+` is allowed (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: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *option': name of option -** 'const char *value': new value for option +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9587,24 +9588,24 @@ struct t_hook *weechat_hook_completion (const char *completion_item, Arguments: -* 'completion_item': name of completion item, after you can use '%(name)' in - a command hooked (argument 'completion') +* _completion_item_: name of completion item, after you can use _%(name)_ in + a command hooked (argument _completion_) (priority allowed, see note about <<hook_priority,priority>>) -* 'description': description of completion -* 'callback': function called when completion item is used (user is completing +* _description_: description of completion +* _callback_: function called when completion item is used (user is completing something using this item), arguments and return value: -** 'const void *pointer': pointer -** '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 +** _const void *pointer_: pointer +** _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 <<_hook_completion_list_add,weechat_hook_completion_list_add>>) ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9619,7 +9620,7 @@ The callback must only call function and must *NOT* update the command line. + To update the command line when key[Tab] is pressed, you can use the function <<_hook_command_run,weechat_hook_command_run>> with command: -"/input complete_next" (and you must return 'WEECHAT_RC_OK_EAT' if your callback +"/input complete_next" (and you must return _WEECHAT_RC_OK_EAT_ if your callback has updated the command line, so that WeeChat will not perform the completion). Return value: @@ -9680,11 +9681,11 @@ const char *weechat_hook_completion_get_string (struct t_gui_completion *complet Arguments: -* 'completion': completion pointer -* 'property': property name: -** 'base_command': command used for completion -** 'base_word': word being completed -** 'args': command arguments (including base word) +* _completion_: completion pointer +* _property_: property name: +** _base_command_: command used for completion +** _base_word_: word being completed +** _args_: command arguments (including base word) C example: @@ -9737,13 +9738,13 @@ void weechat_hook_completion_list_add (struct t_gui_completion *completion, Arguments: -* 'completion': completion pointer -* 'word': word to add -* 'nick_completion': 1 if word is a nick, otherwise 0 -* 'where': position where word will be inserted in list: -** 'WEECHAT_LIST_POS_SORT': any position, to keep list sorted -** 'WEECHAT_LIST_POS_BEGINNING': beginning of list -** 'WEECHAT_LIST_POS_END': end of list +* _completion_: completion pointer +* _word_: word to add +* _nick_completion_: 1 if word is a nick, otherwise 0 +* _where_: position where word will be inserted in list: +** _WEECHAT_LIST_POS_SORT_: any position, to keep list sorted +** _WEECHAT_LIST_POS_BEGINNING_: beginning of list +** _WEECHAT_LIST_POS_END_: end of list C example: see <<_hook_completion,weechat_hook_completion>>. @@ -9779,18 +9780,18 @@ struct t_hook *weechat_hook_modifier (const char *modifier, Arguments: -* 'modifier': modifier name, list of modifiers used by Weechat or plugins +* _modifier_: modifier name, list of modifiers used by Weechat or plugins (priority allowed, see note about <<hook_priority,priority>>) (see table below) -* 'callback': function called when modifier is used, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *modifier': name of modifier -** 'const char *modifier_data': data for modifier -** 'const char *string': string to modify +* _callback_: function called when modifier is used, arguments and return value: +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9911,8 +9912,8 @@ List of modifiers used by WeeChat and plugins: |=== [NOTE] -^(1)^ 'xxx' is IRC command name. + -^(2)^ 'yyy' is bar name. +^(1)^ _xxx_ is IRC command name. + +^(2)^ _yyy_ is bar name. C example: @@ -9973,9 +9974,9 @@ char *weechat_hook_modifier_exec (const char *modifier, Arguments: -* 'modifier': modifier name -* 'modifier_data': modifier data -* 'string': string to modify +* _modifier_: modifier name +* _modifier_data_: modifier data +* _string_: string to modify Return value: @@ -10023,18 +10024,18 @@ struct t_hook *weechat_hook_info (const char *info_name, Arguments: -* 'info_name': name of info +* _info_name_: name of info (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 and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *info_name': name of info -** 'const char *arguments': additional arguments, depending on info +* _description_: description +* _args_description_: description of arguments (optional, can be NULL) +* _callback_: function called when info is asked, arguments and return value: +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10100,20 +10101,20 @@ struct t_hook *weechat_hook_info_hashtable (const char *info_name, Arguments: -* 'info_name': name of info +* _info_name_: name of info (priority allowed, see note about <<hook_priority,priority>>) -* 'description': description -* 'args_description': description of expected hashtable (optional, can be NULL) -* 'output_description': description of hashtable returned by callback +* _description_: description +* _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 and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *info_name': name of info -** 'struct t_hashtable *hashtable': hashtable, depending on info +* _callback_: function called when info is asked, arguments and return value: +** _const void *pointer_: pointer +** _void *data_: pointer +** _const char *info_name_: name of info +** _struct t_hashtable *hashtable_: hashtable, depending on info ** return value: hashtable asked -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10184,22 +10185,22 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, Arguments: -* 'infolist_name': name of infolist +* _infolist_name_: name of infolist (priority allowed, see note about <<hook_priority,priority>>) -* '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 and return +* _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 and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *infolist_name': name of infolist -** 'void *pointer': pointer to an object that infolist must return (to get only +** _const void *pointer_: pointer +** _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 +** _const char *arguments_: additional arguments, depending on infolist ** return value: infolist asked -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10271,17 +10272,17 @@ struct t_hook *weechat_hook_hdata (const char *hdata_name, Arguments: -* 'hdata_name': name of hdata +* _hdata_name_: name of hdata (priority allowed, see note about <<hook_priority,priority>>) -* 'description': description -* 'callback': function called when hdata is asked, arguments and return +* _description_: description +* _callback_: function called when hdata is asked, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'const char *hdata_name': name of hdata +** _const void *pointer_: pointer +** _void *data_: pointer +** _const char *hdata_name_: name of hdata ** return value: hdata asked -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10334,20 +10335,20 @@ struct t_hook *weechat_hook_focus (const char *area, Arguments: -* 'area': "chat" for chat area, or name of bar item +* _area_: "chat" for chat area, or name of bar item (priority allowed, see note about <<hook_priority,priority>>) -* 'callback': function called when focus is made, arguments and return +* _callback_: function called when focus is made, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_hashtable *info': hashtable with info on focus and strings returned +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_hashtable *info_: hashtable with info on focus and strings returned by other calls to focus callbacks (with higher priority) (see table below) ** return value: either "info" pointer (hashtable completed), or pointer to a new hashtable (created by callback, with keys and values of type "string"), - this new hashtable content will be added to 'info' for other calls to focus + this new hashtable content will be added to _info_ for other calls to focus callbacks -* 'callback_pointer': pointer given to callback when it is called by WeeChat -* 'callback_data': pointer given to callback when it is called by WeeChat; +* _callback_pointer_: pointer given to callback when it is called by WeeChat +* _callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10535,9 +10536,9 @@ void weechat_hook_set (struct t_hook *hook, const char *property, Arguments: -* 'hook': something hooked with "weechat_hook_xxx()" -* 'property': property name (see table below) -* 'value': new value for property +* _hook_: something hooked with "weechat_hook_xxx()" +* _property_: property name (see table below) +* _value_: new value for property Properties: @@ -10547,21 +10548,21 @@ Properties: | subplugin | any type | any string | Name of sub plugin (commonly script name, which is displayed in - `/help command` for a hook of type 'command') + `/help command` for a hook of type _command_) | stdin + _(WeeChat ≥ 0.4.3)_ | - 'process', 'process_hashtable' | any string | - Send data on standard input ('stdin') of child process + _process_, _process_hashtable_ | any string | + Send data on standard input (_stdin_) of child process | stdin_close + _(WeeChat ≥ 0.4.3)_ | - 'process', 'process_hashtable' | (not used) | - Close pipe used to send data on standard input ('stdin') of child process + _process_, _process_hashtable_ | (not used) | + Close pipe used to send data on standard input (_stdin_) of child process | signal + _(WeeChat ≥ 1.0)_ | - 'process', 'process_hashtable' | + _process_, _process_hashtable_ | signal number or one of these names: `hup`, `int`, `quit`, `kill`, `term`, `usr1`, `usr2` | Send a signal to the child process @@ -10609,7 +10610,7 @@ void weechat_unhook (struct t_hook *hook); Arguments: -* 'hook': something hooked with "weechat_hook_xxx()" +* _hook_: something hooked with "weechat_hook_xxx()" C example: @@ -10646,7 +10647,7 @@ void weechat_unhook_all (const char *subplugin); Arguments: -* 'subplugin': if not NULL, unhook only hooks with this "subplugin" set +* _subplugin_: if not NULL, unhook only hooks with this "subplugin" set (this argument is not available in scripting API) C example: @@ -10698,32 +10699,32 @@ struct t_gui_buffer *weechat_buffer_new (const char *name, Arguments: -* 'name': name of buffer (must be unique for plugin) -* 'input_callback': function called when input text is entered on buffer, +* _name_: name of buffer (must be unique for plugin) +* _input_callback_: function called when input text is entered on buffer, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_gui_buffer *buffer': buffer pointer -** 'const char *input_data': input data +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_gui_buffer *buffer_: buffer pointer +** _const char *input_data_: input data ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'input_callback_pointer': pointer given to callback when it is called by +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _input_callback_pointer_: pointer given to callback when it is called by WeeChat -* 'input_callback_data': pointer given to callback when it is called by +* _input_callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the buffer is closed -* 'close_callback': function called when buffer is closed, arguments and return +* _close_callback_: function called when buffer is closed, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_gui_buffer *buffer': buffer pointer +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_gui_buffer *buffer_: buffer pointer ** return value: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'close_callback_pointer': pointer given to callback when it is called by +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _close_callback_pointer_: pointer given to callback when it is called by WeeChat -* 'close_callback_data': pointer given to callback when it is called by +* _close_callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the buffer is closed @@ -10825,11 +10826,11 @@ struct t_gui_buffer *weechat_buffer_search (const char *plugin, Arguments: -* 'plugin': name of plugin, following special value is allowed: -** `==`: the name used is the buffer full name (for example: +* _plugin_: name of plugin, following special value is allowed: +** `+==+`: the name used is the buffer full name (for example: `irc.freenode.#weechat` instead of `freenode.#weechat`) _(WeeChat ≥ 1.0)_ -* 'name': name of buffer, if it is NULL or empty string, the current buffer is +* _name_: name of buffer, if it is NULL or empty string, the current buffer is returned (buffer displayed by current window); if the name starts with `(?i)`, the search is case insensitive _(WeeChat ≥ 1.0)_ @@ -10858,7 +10859,7 @@ buffer = weechat.buffer_search("my_plugin", "my_buffer") ==== buffer_search_main -Search WeeChat main buffer ('core' buffer, first buffer displayed when WeeChat +Search WeeChat main buffer (_core_ buffer, first buffer displayed when WeeChat is starting). Prototype: @@ -10870,7 +10871,7 @@ struct t_gui_buffer *weechat_buffer_search_main (); Return value: -* pointer to WeeChat main buffer ('core' buffer) +* pointer to WeeChat main buffer (_core_ buffer) C example: @@ -10903,7 +10904,7 @@ void weechat_buffer_clear (struct t_gui_buffer *buffer); Arguments: -* 'buffer': buffer pointer +* _buffer_: buffer pointer C example: @@ -10943,7 +10944,7 @@ void weechat_buffer_close (struct t_gui_buffer *buffer); Arguments: -* 'buffer': buffer pointer +* _buffer_: buffer pointer C example: @@ -10985,8 +10986,8 @@ void weechat_buffer_merge (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'target_buffer': target buffer, where buffer will be merged +* _buffer_: buffer pointer +* _target_buffer_: target buffer, where buffer will be merged C example: @@ -11023,9 +11024,9 @@ void weechat_buffer_unmerge (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'number': target number for detached buffer, if it is < 1, then buffer will - be moved to number of 'buffer' + 1 +* _buffer_: buffer pointer +* _number_: target number for detached buffer, if it is < 1, then buffer will + be moved to number of _buffer_ + 1 C example: @@ -11059,55 +11060,55 @@ int weechat_buffer_get_integer (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'property': property name: -** 'number': number of buffer (starts to 1) -** 'layout_number': number of buffer saved in layout -** 'layout_number_merge_order': order in merge for layout -** 'short_name_is_set': 1 if short name is set, 0 if not set -** 'type': buffer type (0: formatted, 1: free content) -** 'notify': notify level for buffer -** 'num_displayed': number of windows displaying buffer -** 'active': 2 if buffer is the only active (merged), 1 if buffer is active, +* _buffer_: buffer pointer +* _property_: property name: +** _number_: number of buffer (starts to 1) +** _layout_number_: number of buffer saved in layout +** _layout_number_merge_order_: order in merge for layout +** _short_name_is_set_: 1 if short name is set, 0 if not set +** _type_: buffer type (0: formatted, 1: free content) +** _notify_: notify level for buffer +** _num_displayed_: number of windows displaying buffer +** _active_: 2 if buffer is the only active (merged), 1 if buffer is active, 0 if buffer is merged and not selected -** 'hidden': 1 if buffer is hidden, otherwise 0 +** _hidden_: 1 if buffer is hidden, otherwise 0 _(WeeChat ≥ 1.0)_ -** 'zoomed': 1 if buffer is merged and zoomed, otherwise 0 +** _zoomed_: 1 if buffer is merged and zoomed, otherwise 0 _(WeeChat ≥ 1.0)_ -** 'print_hooks_enabled': 1 if print hooks are enabled, otherwise 0 -** 'day_change': 1 if messages for the day change are displayed, otherwise 0 +** _print_hooks_enabled_: 1 if print hooks are enabled, otherwise 0 +** _day_change_: 1 if messages for the day change are displayed, otherwise 0 _(WeeChat ≥ 0.4.3)_ -** 'clear': 1 if buffer can be cleared with command `/buffer clear`, otherwise 0 +** _clear_: 1 if buffer can be cleared with command `/buffer clear`, otherwise 0 _(WeeChat ≥ 1.0)_ -** 'filter': 1 if filters are enabled on buffer, otherwise 0 +** _filter_: 1 if filters are enabled on buffer, otherwise 0 _(WeeChat ≥ 1.0)_ -** 'lines_hidden': 1 if at least one line is hidden on buffer (filtered), or 0 +** _lines_hidden_: 1 if at least one line is hidden on buffer (filtered), or 0 if all lines are displayed -** 'prefix_max_length': max length for prefix in this buffer -** 'time_for_each_line': 1 if time is displayed for each line in buffer +** _prefix_max_length_: max length for prefix in this buffer +** _time_for_each_line_: 1 if time is displayed for each line in buffer (default), otherwise 0 -** 'nicklist': 1 if nicklist is enabled, otherwise 0 -** 'nicklist_case_sensitive': 1 if nicks are case sensitive, otherwise 0 -** 'nicklist_max_length': max length for a nick -** 'nicklist_display_groups': 1 if groups are displayed, otherwise 0 -** 'nicklist_count': number of nicks and groups in nicklist -** 'nicklist_groups_count': number of groups in nicklist -** 'nicklist_nicks_count': number of nicks in nicklist -** 'nicklist_visible_count': number of nicks/groups displayed -** 'input': 1 if input is enabled, otherwise 0 -** 'input_get_unknown_commands': 1 if unknown commands are sent to input +** _nicklist_: 1 if nicklist is enabled, otherwise 0 +** _nicklist_case_sensitive_: 1 if nicks are case sensitive, otherwise 0 +** _nicklist_max_length_: max length for a nick +** _nicklist_display_groups_: 1 if groups are displayed, otherwise 0 +** _nicklist_count_: number of nicks and groups in nicklist +** _nicklist_groups_count_: number of groups in nicklist +** _nicklist_nicks_count_: number of nicks in nicklist +** _nicklist_visible_count_: number of nicks/groups displayed +** _input_: 1 if input is enabled, otherwise 0 +** _input_get_unknown_commands_: 1 if unknown commands are sent to input callback, otherwise 0 -** 'input_size': input size (in bytes) -** 'input_length': input length (number of chars) -** 'input_pos': cursor position in buffer input -** 'input_1st_display': first char displayed on screen -** 'num_history': number of commands in history -** 'text_search': text search type: +** _input_size_: input size (in bytes) +** _input_length_: input length (number of chars) +** _input_pos_: cursor position in buffer input +** _input_1st_display_: first char displayed on screen +** _num_history_: number of commands in history +** _text_search_: text search type: *** 0: no search at this moment *** 1: backward search (direction: oldest messages) *** 2: forward search (direction: newest messages) -** 'text_search_exact': 1 if text search is case sensitive -** 'text_search_found': 1 if text found, otherwise 0 +** _text_search_exact_: 1 if text search is case sensitive +** _text_search_found_: 1 if text found, otherwise 0 Return value: @@ -11146,24 +11147,24 @@ const char *weechat_buffer_get_string (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'property': property name: -** 'plugin': name of plugin which created this buffer ("core" for WeeChat main +* _buffer_: buffer pointer +* _property_: property name: +** _plugin_: name of plugin which created this buffer ("core" for WeeChat main buffer) -** 'name': name of buffer -** 'full_name': full name of buffer ("plugin.name") _(WeeChat ≥ 0.3.7)_ -** 'short_name': short name of buffer (note: used for display only and can be +** _name_: name of buffer +** _full_name_: full name of buffer ("plugin.name") _(WeeChat ≥ 0.3.7)_ +** _short_name_: short name of buffer (note: used for display only and can be changed by user, this must not be used to find name of buffer, use instead - 'name', 'full_name' or local variable 'channel') -** 'title': title of buffer -** 'input': input text -** 'text_search_input': input saved before text search -** 'highlight_words': list of words to highlight -** 'highlight_regex': POSIX extended regular expression for highlight -** 'highlight_tags_restrict': restrict highlights to messages with these tags -** 'highlight_tags': force highlight on messages with these tags -** 'hotlist_max_level_nicks': max hotlist level for some nicks -** 'localvar_xxx': get content of local variable "xxx" (replace "xxx" by the + _name_, _full_name_ or local variable _channel_) +** _title_: title of buffer +** _input_: input text +** _text_search_input_: input saved before text search +** _highlight_words_: list of words to highlight +** _highlight_regex_: POSIX extended regular expression for highlight +** _highlight_tags_restrict_: restrict highlights to messages with these tags +** _highlight_tags_: force highlight on messages with these tags +** _hotlist_max_level_nicks_: max hotlist level for some nicks +** _localvar_xxx_: get content of local variable "xxx" (replace "xxx" by the name of variable to read) Return value: @@ -11206,11 +11207,11 @@ void *weechat_buffer_pointer (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'property': property name: -** 'plugin': pointer to plugin which created this buffer (NULL for WeeChat main +* _buffer_: buffer pointer +* _property_: property name: +** _plugin_: pointer to plugin which created this buffer (NULL for WeeChat main buffer) -** 'highlight_regex_compiled': regular expression 'highlight_regex' compiled +** _highlight_regex_compiled_: regular expression _highlight_regex_ compiled Return value: @@ -11249,9 +11250,9 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, Arguments: -* 'buffer': buffer pointer -* 'property': property name (see table below) -* 'value': new value for property +* _buffer_: buffer pointer +* _property_: property name (see table below) +* _value_: new value for property Properties: @@ -11295,7 +11296,7 @@ Properties: | type | "formatted" or "free" | Set type for buffer: "formatted" (for printing chat messages), or "free" (for - free content); when the value is "free", the property 'clear' is forced to "0" + free content); when the value is "free", the property _clear_ is forced to "0" _(WeeChat ≥ 1.0)_ | notify | "0", "1", "2", "3" | @@ -11378,11 +11379,11 @@ Properties: Comma separated list of nicks to remove from hotlist max levels | key_bind_xxx | any string | - Bind a new key 'xxx', specific to this buffer, value is command to execute + Bind a new key _xxx_, specific to this buffer, value is command to execute for this key | key_unbind_xxx | - | - Unbind key 'xxx' for this buffer + Unbind key _xxx_ for this buffer | input | any string | Set new value for buffer input @@ -11396,11 +11397,11 @@ Properties: receive it (no error about unknown command) | localvar_set_xxx | any string | - Set new value for local variable 'xxx' (variable is created if it does not + Set new value for local variable _xxx_ (variable is created if it does not exist) | localvar_del_xxx | - | - Remove local variable 'xxx' + Remove local variable _xxx_ |=== C example: @@ -11462,17 +11463,17 @@ void weechat_buffer_set_pointer (struct t_gui_buffer *buffer, const char *proper Arguments: -* 'buffer': buffer pointer -* 'property': property name: -** 'close_callback': set close callback function -** 'close_callback_data': set close callback data -** 'input_callback': set input callback function -** 'input_callback_data': set input callback data -** 'nickcmp_callback': set nick comparison callback function (this callback is +* _buffer_: buffer pointer +* _property_: property name: +** _close_callback_: set close callback function +** _close_callback_data_: set close callback data +** _input_callback_: set input callback function +** _input_callback_data_: set input callback data +** _nickcmp_callback_: set nick comparison callback function (this callback is called when searching nick in nicklist) _(WeeChat ≥ 0.3.9)_ -** 'nickcmp_callback_data': set nick comparison callback data +** _nickcmp_callback_data_: set nick comparison callback data _(WeeChat ≥ 0.3.9)_ -* 'pointer': new pointer value for property +* _pointer_: new pointer value for property Prototypes for callbacks: @@ -11521,8 +11522,8 @@ char *weechat_buffer_string_replace_local_var (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'string': string with text and local variables using format "$var" +* _buffer_: buffer pointer +* _string_: string with text and local variables using format "$var" Return value: @@ -11567,11 +11568,11 @@ int weechat_buffer_match_list (struct t_gui_buffer *buffer, const char *string); Arguments: -* 'buffer': buffer pointer -* 'string': comma-separated list of buffers: -** "*" means all buffers -** name beginning with "!" is excluded -** wildcard "*" is allowed in name +* _buffer_: buffer pointer +* _string_: comma-separated list of buffers: +** `+*+` means all buffers +** name beginning with `+!+` is excluded +** wildcard `+*+` is allowed in name Return value: @@ -11660,7 +11661,7 @@ struct t_gui_window *weechat_window_search_with_buffer (struct t_gui_buffer *buf Arguments: -* 'buffer': buffer pointer +* _buffer_: buffer pointer Return value: @@ -11701,25 +11702,25 @@ int weechat_window_get_integer (struct t_gui_window *window, Arguments: -* 'window': window pointer -* 'property': property name: -** 'number': number of window (starts to 1) -** 'win_x': X position of window in terminal (first column is 0) -** 'win_y': Y position of window in terminal (first line is 0) -** 'win_width': width of window, in chars -** 'win_height': height of window, in chars -** 'win_width_pct': percentage size, compared to parent window (for example 50 +* _window_: window pointer +* _property_: property name: +** _number_: number of window (starts to 1) +** _win_x_: X position of window in terminal (first column is 0) +** _win_y_: Y position of window in terminal (first line is 0) +** _win_width_: width of window, in chars +** _win_height_: height of window, in chars +** _win_width_pct_: percentage size, compared to parent window (for example 50 means half size) -** 'win_height_pct': percentage size, compared to parent window (for example 50 +** _win_height_pct_: percentage size, compared to parent window (for example 50 means half size) -** 'win_chat_x': X position of chat window in terminal (first column is 0) -** 'win_chat_y': Y position of chat window in terminal (first line is 0) -** 'win_chat_width': width of chat window, in chars -** 'win_chat_height': height of chat window, in chars -** 'first_line_displayed': 1 if first line of buffer is displayed on screen, +** _win_chat_x_: X position of chat window in terminal (first column is 0) +** _win_chat_y_: Y position of chat window in terminal (first line is 0) +** _win_chat_width_: width of chat window, in chars +** _win_chat_height_: height of chat window, in chars +** _first_line_displayed_: 1 if first line of buffer is displayed on screen, otherwise 0 -** 'scrolling': 1 if scroll is active on window (last line not displayed) -** 'lines_after': number of lines not displayed after last one displayed +** _scrolling_: 1 if scroll is active on window (last line not displayed) +** _lines_after_: number of lines not displayed after last one displayed (when scrolling) Return value: @@ -11765,8 +11766,8 @@ int weechat_window_get_string (struct t_gui_window *window, Arguments: -* 'window': window pointer -* 'property': property name +* _window_: window pointer +* _property_: property name Return value: @@ -11786,10 +11787,10 @@ void *weechat_window_get_pointer (struct t_gui_window *window, Arguments: -* 'window': window pointer -* 'property': property name: -** 'current': current window pointer -** 'buffer': pointer to buffer displayed by window +* _window_: window pointer +* _property_: property name: +** _current_: current window pointer +** _buffer_: pointer to buffer displayed by window Return value: @@ -11829,7 +11830,7 @@ void weechat_window_set_title (const char *title); Arguments: -* 'title': new title for terminal (NULL to reset title) +* _title_: new title for terminal (NULL to reset title) C example: @@ -11871,20 +11872,20 @@ struct t_gui_nick_group *weechat_nicklist_add_group (struct t_gui_buffer *buffer Arguments: -* 'buffer': buffer pointer -* 'parent_group': pointer to parent of group, NULL if group has no parent +* _buffer_: buffer pointer +* _parent_group_: pointer to parent of group, NULL if group has no parent (nicklist root) -* 'name': group name -* 'color': color option name: -** WeeChat option name, for example 'weechat.color.nicklist_group' -** color with optional background, for example 'yellow' or 'yellow,red' +* _name_: group name +* _color_: color option name: +** WeeChat option name, for example _weechat.color.nicklist_group_ +** color with optional background, for example _yellow_ or _yellow,red_ ** bar color name: -*** 'bar_fg': foreground color for bar -*** 'bar_delim': delimiters color for bar -*** 'bar_bg': background color for bar -* 'visible': -** '1': group and sub-groups/nicks are visible -** '0': group and sub-groups/nicks are hidden +*** _bar_fg_: foreground color for bar +*** _bar_delim_: delimiters color for bar +*** _bar_bg_: background color for bar +* _visible_: +** _1_: group and sub-groups/nicks are visible +** _0_: group and sub-groups/nicks are hidden [NOTE] The group name can begin with one or more digits, followed by pipe, and then @@ -11935,10 +11936,10 @@ struct t_gui_nick_group *weechat_nicklist_search_group (struct t_gui_buffer *buf Arguments: -* 'buffer': buffer pointer -* 'from_group': search from this group only, if NULL, then search in whole +* _buffer_: buffer pointer +* _from_group_: search from this group only, if NULL, then search in whole nicklist -* 'name': group name to search +* _name_: group name to search Return value: @@ -11982,27 +11983,27 @@ struct t_gui_nick_group *weechat_nicklist_add_nick (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': group pointer -* 'name': nick name -* 'color': color option name: -*** WeeChat option name (from weechat.color.xxx), for example 'chat_delimiters' -*** color with optional background, for example 'yellow' or 'yellow,red' +* _buffer_: buffer pointer +* _group_: group pointer +* _name_: nick name +* _color_: color option name: +*** WeeChat option name (from weechat.color.xxx), for example _chat_delimiters_ +*** color with optional background, for example _yellow_ or _yellow,red_ *** bar color name: -**** 'bar_fg': foreground color for bar -**** 'bar_delim': delimiters color for bar -**** 'bar_bg': background color for bar -* 'prefix': prefix displayed before nick -* 'prefix_color': color option name: -** WeeChat option name (from weechat.color.xxx), for example 'chat_delimiters' -** color with optional background, for example 'yellow' or 'yellow,red' +**** _bar_fg_: foreground color for bar +**** _bar_delim_: delimiters color for bar +**** _bar_bg_: background color for bar +* _prefix_: prefix displayed before nick +* _prefix_color_: color option name: +** WeeChat option name (from weechat.color.xxx), for example _chat_delimiters_ +** color with optional background, for example _yellow_ or _yellow,red_ ** bar color name: -*** 'bar_fg': foreground color for bar -*** 'bar_delim': delimiters color for bar -*** 'bar_bg': background color for bar -* 'visible': -** '1': nick is visible -** '0': nick is hidden +*** _bar_fg_: foreground color for bar +*** _bar_delim_: delimiters color for bar +*** _bar_bg_: background color for bar +* _visible_: +** _1_: nick is visible +** _0_: nick is hidden Return value: @@ -12050,10 +12051,10 @@ struct t_gui_nick *weechat_nicklist_search_nick (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'from_group': search from this group only, if NULL, then search in whole +* _buffer_: buffer pointer +* _from_group_: search from this group only, if NULL, then search in whole nicklist -* 'name': nick name to search +* _name_: nick name to search Return value: @@ -12092,8 +12093,8 @@ void weechat_nicklist_remove_group (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': group pointer to remove (all sub-groups/nicks will be removed too) +* _buffer_: buffer pointer +* _group_: group pointer to remove (all sub-groups/nicks will be removed too) C example: @@ -12127,8 +12128,8 @@ void weechat_nicklist_remove_nick (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'nick': nick pointer to remove +* _buffer_: buffer pointer +* _nick_: nick pointer to remove C example: @@ -12161,7 +12162,7 @@ void weechat_nicklist_remove_all (struct t_gui_buffer *buffer); Arguments: -* 'buffer': buffer pointer +* _buffer_: buffer pointer C example: @@ -12198,9 +12199,9 @@ void weechat_nicklist_get_next_item (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': pointer on pointer to group -* 'nick': pointer on pointer to nick +* _buffer_: buffer pointer +* _group_: pointer on pointer to group +* _nick_: pointer on pointer to nick C example: @@ -12248,11 +12249,11 @@ int weechat_nicklist_group_get_integer (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': group pointer -* 'property': property name: -** 'visible': 1 if group is visible, otherwise 0 -** 'level': group level (root is 0) +* _buffer_: buffer pointer +* _group_: group pointer +* _property_: property name: +** _visible_: 1 if group is visible, otherwise 0 +** _level_: group level (root is 0) Return value: @@ -12293,11 +12294,11 @@ const char *weechat_nicklist_group_get_string (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': group pointer -* 'property': property name: -** 'name': name of group -** 'color': group color in nicklist +* _buffer_: buffer pointer +* _group_: group pointer +* _property_: property name: +** _name_: name of group +** _color_: group color in nicklist Return value: @@ -12338,10 +12339,10 @@ void *weechat_nicklist_group_get_pointer (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': group pointer -* 'property': property name: -** 'parent': pointer to parent group +* _buffer_: buffer pointer +* _group_: group pointer +* _property_: property name: +** _parent_: pointer to parent group Return value: @@ -12383,10 +12384,10 @@ void weechat_nicklist_group_set (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'group': group pointer -* 'property': property name (see table below) -* 'value': new value for property +* _buffer_: buffer pointer +* _group_: group pointer +* _property_: property name (see table below) +* _value_: new value for property Properties: @@ -12452,10 +12453,10 @@ int weechat_nicklist_nick_get_integer (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'nick': nick pointer -* 'property': property name: -** 'visible': 1 if nick is visible, otherwise 0 +* _buffer_: buffer pointer +* _nick_: nick pointer +* _property_: property name: +** _visible_: 1 if nick is visible, otherwise 0 Return value: @@ -12496,13 +12497,13 @@ const char *weechat_nicklist_nick_get_string (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'nick': nick pointer -* 'property': property name: -** 'name': name of nick -** 'color': nick color in nicklist -** 'prefix': prefix of nick -** 'prefix_color': prefix color in nicklist +* _buffer_: buffer pointer +* _nick_: nick pointer +* _property_: property name: +** _name_: name of nick +** _color_: nick color in nicklist +** _prefix_: prefix of nick +** _prefix_color_: prefix color in nicklist Return value: @@ -12543,10 +12544,10 @@ void *weechat_nicklist_nick_get_pointer (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'nick': nick pointer -* 'property': property name: -** 'group': pointer to group containing this nick +* _buffer_: buffer pointer +* _nick_: nick pointer +* _property_: property name: +** _group_: pointer to group containing this nick Return value: @@ -12588,10 +12589,10 @@ void weechat_nicklist_nick_set (struct t_gui_buffer *buffer, Arguments: -* 'buffer': buffer pointer -* 'nick': nick pointer -* 'property': property name (see table below) -* 'value': new value for property +* _buffer_: buffer pointer +* _nick_: nick pointer +* _property_: property name (see table below) +* _value_: new value for property Properties: @@ -12671,7 +12672,7 @@ struct t_gui_bar_item *weechat_bar_item_search (const char *name); Arguments: -* 'name': bar item name +* _name_: bar item name Return value: @@ -12718,23 +12719,23 @@ 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, arguments and +* _name_: bar item name +* _build_callback_: function called when bar item is built, arguments and return value: -** 'const void *pointer': pointer -** 'void *data': pointer -** 'struct t_gui_bar_item *item': item pointer -** 'struct t_gui_window *window': window pointer (NULL when called for a root +** _const void *pointer_: pointer +** _void *data_: pointer +** _struct t_gui_bar_item *item_: item pointer +** _struct t_gui_window *window_: window pointer (NULL when called for a root bar) -** 'struct t_gui_buffer *buffer': buffer displayed in window (if window is NULL, +** _struct t_gui_buffer *buffer_: buffer displayed in window (if window is NULL, then it is current buffer) or buffer given in bar item with syntax: "@buffer:item" _(WeeChat ≥ 0.4.2)_ -** 'struct t_hashtable *extra_info': always NULL (argument is reserved for a +** _struct t_hashtable *extra_info_: always NULL (argument is reserved for a future version) _(WeeChat ≥ 0.4.2)_ ** return value: content of bar item -* 'build_callback_pointer': pointer given to build callback, when it is called +* _build_callback_pointer_: pointer given to build callback, when it is called by WeeChat -* 'build_callback_data': pointer given to callback when it is called by +* _build_callback_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the bar item is removed @@ -12765,7 +12766,7 @@ Script (Python): [IMPORTANT] For compatibility with versions ≤ 0.4.1, the default callback has only 3 -arguments: 'data', 'item' and 'window' (no 'buffer' and 'extra_info'). + +arguments: _data_, _item_ and _window_ (no _buffer_ and _extra_info_). + To use a callback with all arguments, you must add "(extra)" before the name, see example below (supported only in WeeChat ≥ 0.4.2). @@ -12800,7 +12801,7 @@ void weechat_bar_item_update (const char *name); Arguments: -* 'name': bar item name +* _name_: bar item name C example: @@ -12833,7 +12834,7 @@ void weechat_bar_item_remove (struct t_gui_bar_item *item); Arguments: -* 'item': bar item pointer +* _item_: bar item pointer C example: @@ -12866,7 +12867,7 @@ struct t_gui_bar *weechat_bar_search (const char *name); Arguments: -* 'name': bar name +* _name_: bar name Return value: @@ -12917,39 +12918,39 @@ struct t_gui_bar *weechat_bar_new (const char *name, Arguments: -* 'name': bar name -* 'hidden': -** 'on': bar is hidden -** 'off': bar is visible -* 'priority': bar priority (integer) -* 'type': -** 'root': bar displayed once, outside windows -** 'window': bar displayed in each window -* 'condition': condition for displaying bar: -** 'active': bar is displayed in active window only -** 'inactive': bar is displayed in inactive windows only -** 'nicklist': bar is displayed in windows with nicklist -** evaluated expression: see chapter about bars in 'WeeChat User's guide' -* 'position': 'top', 'bottom', 'left' or 'right' -* 'filling_top_bottom': -** 'horizontal': items are filled horizontally (space after each item) -** 'vertical': items are filled vertically (new line after each item) -** 'columns_horizontal': items are filled horizontally, displayed with columns -** 'columns_vertical': items are filled vertically, displayed with columns -* 'filling_left_right': -** 'horizontal': items are filled horizontally (space after each item) -** 'vertical': items are filled vertically (new line after each item) -** 'columns_horizontal': items are filled horizontally, displayed with columns -** 'columns_vertical': items are filled vertically, displayed with columns -* 'size': bar size in chars (0 means automatic size) -* 'size_max': max size for bar (0 means no max size) -* 'color_fg': color for text in bar -* 'color_delim': color for delimiters in bar -* 'color_bg': background color for bar -* 'separator': -** 'on': bar has separator line with other windows/bars -** 'off': no separator -* 'items': list of items in bar, separated by comma (space between items), or +* _name_: bar name +* _hidden_: +** _on_: bar is hidden +** _off_: bar is visible +* _priority_: bar priority (integer) +* _type_: +** _root_: bar displayed once, outside windows +** _window_: bar displayed in each window +* _condition_: condition for displaying bar: +** _active_: bar is displayed in active window only +** _inactive_: bar is displayed in inactive windows only +** _nicklist_: bar is displayed in windows with nicklist +** evaluated expression: see chapter about bars in _WeeChat User's guide_ +* _position_: _top_, _bottom_, _left_ or _right_ +* _filling_top_bottom_: +** _horizontal_: items are filled horizontally (space after each item) +** _vertical_: items are filled vertically (new line after each item) +** _columns_horizontal_: items are filled horizontally, displayed with columns +** _columns_vertical_: items are filled vertically, displayed with columns +* _filling_left_right_: +** _horizontal_: items are filled horizontally (space after each item) +** _vertical_: items are filled vertically (new line after each item) +** _columns_horizontal_: items are filled horizontally, displayed with columns +** _columns_vertical_: items are filled vertically, displayed with columns +* _size_: bar size in chars (0 means automatic size) +* _size_max_: max size for bar (0 means no max size) +* _color_fg_: color for text in bar +* _color_delim_: color for delimiters in bar +* _color_bg_: background color for bar +* _separator_: +** _on_: bar has separator line with other windows/bars +** _off_: no separator +* _items_: list of items in bar, separated by comma (space between items), or "+" (glued items) Return value: @@ -13005,11 +13006,11 @@ int weechat_bar_set (struct t_gui_bar *bar, const char *property, Arguments: -* 'bar': bar pointer -* 'property': name, hidden, priority, conditions, position, filling_top_bottom, +* _bar_: bar pointer +* _property_: name, hidden, priority, conditions, position, filling_top_bottom, filling_left_right, size, size_max, color_fg, color_delim, color_bg, separator, items (see <<_bar_new,weechat_bar_new>>) -* 'value': new value for property +* _value_: new value for property Return value: @@ -13046,7 +13047,7 @@ void weechat_bar_update (const char *name); Arguments: -* 'name': bar name +* _name_: bar name C example: @@ -13079,7 +13080,7 @@ void weechat_bar_remove (struct t_gui_bar *bar); Arguments: -* 'bar': bar pointer +* _bar_: bar pointer C example: @@ -13119,15 +13120,15 @@ int weechat_command (struct t_gui_buffer *buffer, const char *command); Arguments: -* 'buffer': buffer pointer (command is executed on this buffer, use NULL for +* _buffer_: buffer pointer (command is executed on this buffer, use NULL for current buffer) -* 'command': command to execute (if beginning with a "/"), or text to send to +* _command_: command to execute (if beginning with a "/"), or text to send to buffer Return value: (_WeeChat ≥ 1.1_) -* 'WEECHAT_RC_OK' if successful -* 'WEECHAT_RC_ERROR' if error +* _WEECHAT_RC_OK_ if successful +* _WEECHAT_RC_ERROR_ if error C example: @@ -13174,10 +13175,10 @@ int weechat_network_pass_proxy (const char *proxy, Arguments: -* 'proxy': proxy name to use -* 'sock': socket to use -* 'address': address (hostname or IP address) -* 'port': port +* _proxy_: proxy name to use +* _sock_: socket to use +* _address_: address (hostname or IP address) +* _port_: port Return value: @@ -13221,9 +13222,9 @@ int weechat_network_connect_to (const char *proxy, Arguments: -* 'proxy': proxy name to use -* 'address': address to connect to (with port) -* 'address_length': length of argument 'address' +* _proxy_: proxy name to use +* _address_: address to connect to (with port) +* _address_length_: length of argument _address_ Return value: @@ -13237,7 +13238,7 @@ struct sockaddr *addr; socklen_t length; int sock; -/* allocate/set address and port in 'addr', set 'length' */ +/* allocate/set address and port in _addr_, set _length_ */ /* ... */ sock = weechat_network_connect_to (NULL, addr, length); @@ -13272,8 +13273,8 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Arguments: -* 'info_name': name of info to read (see table below) -* 'arguments': arguments for info asked (optional, NULL if no argument is +* _info_name_: name of info to read (see table below) +* _arguments_: arguments for info asked (optional, NULL if no argument is needed) Return value: @@ -13324,8 +13325,8 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Arguments: -* 'info_name': name of info to read (see table below) -* 'hashtable': hashtable with arguments (depends on info asked) (optional, NULL +* _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) Return value: @@ -13376,7 +13377,7 @@ if (hashtable_in) ---- [NOTE] -See the 'WeeChat Scripting Guide' for more info about "irc_message_parse" +See the _WeeChat Scripting Guide_ for more info about "irc_message_parse" output. Script (Python): @@ -13403,11 +13404,11 @@ defined). For each item, there is variables like "name", "buffer", Each variable has a type and a value. Possible types are: -* 'integer': any integer value -* 'string': any string value -* 'pointer': any pointer -* 'buffer': buffer with fixed length, containing any data -* 'time': time value +* _integer_: any integer value +* _string_: any string value +* _pointer_: any pointer +* _buffer_: buffer with fixed length, containing any data +* _time_: time value ==== infolist_new @@ -13455,7 +13456,7 @@ struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); Arguments: -* 'infolist': infolist pointer +* _infolist_: infolist pointer Return value: @@ -13494,9 +13495,9 @@ struct t_infolist_var *weechat_infolist_new_var_integer (struct t_infolist_item Arguments: -* 'item': infolist item pointer -* 'name': variable name -* 'value': integer value +* _item_: infolist item pointer +* _name_: variable name +* _value_: integer value Return value: @@ -13537,9 +13538,9 @@ struct t_infolist_var *weechat_infolist_new_var_string (struct t_infolist_item * Arguments: -* 'item': infolist item pointer -* 'name': variable name -* 'value': string value +* _item_: infolist item pointer +* _name_: variable name +* _value_: string value Return value: @@ -13580,9 +13581,9 @@ struct t_infolist_var *weechat_infolist_new_var_pointer (struct t_infolist_item Arguments: -* 'item': infolist item pointer -* 'name': variable name -* 'pointer': pointer +* _item_: infolist item pointer +* _name_: variable name +* _pointer_: pointer Return value: @@ -13624,10 +13625,10 @@ struct t_infolist_var *weechat_infolist_new_var_buffer (struct t_infolist_item * Arguments: -* 'item': infolist item pointer -* 'name': variable name -* 'pointer': pointer to buffer -* 'size': size of buffer +* _item_: infolist item pointer +* _name_: variable name +* _pointer_: pointer to buffer +* _size_: size of buffer Return value: @@ -13663,9 +13664,9 @@ struct t_infolist_var *weechat_infolist_new_var_time (struct t_infolist_item *it Arguments: -* 'item': infolist item pointer -* 'name': variable name -* 'time': time value +* _item_: infolist item pointer +* _name_: variable name +* _time_: time value Return value: @@ -13713,10 +13714,10 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Arguments: -* 'infolist_name': name of infolist to read (see table below) -* 'pointer': pointer to an item, to get only this item in infolist (optional, +* _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 +* _arguments_: arguments for infolist asked (optional, NULL if no argument is needed) Return value: @@ -13759,7 +13760,7 @@ int weechat_infolist_next (struct t_infolist *infolist); Arguments: -* 'infolist': infolist pointer +* _infolist_: infolist pointer Return value: @@ -13808,7 +13809,7 @@ int weechat_infolist_prev (struct t_infolist *infolist); Arguments: -* 'infolist': infolist pointer +* _infolist_: infolist pointer Return value: @@ -13857,7 +13858,7 @@ void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); Arguments: -* 'infolist': infolist pointer +* _infolist_: infolist pointer C example: @@ -13893,8 +13894,8 @@ struct t_infolist_var *weechat_infolist_search_var (struct t_infolist *infolist, Arguments: -* 'infolist': infolist pointer -* 'name': variable name +* _infolist_: infolist pointer +* _name_: variable name Return value: @@ -13937,7 +13938,7 @@ const char *weechat_infolist_fields (struct t_infolist *infolist); Arguments: -* 'infolist': infolist pointer +* _infolist_: infolist pointer Return value: @@ -13980,8 +13981,8 @@ int weechat_infolist_integer (struct t_infolist *infolist, const char *var); Arguments: -* 'infolist': infolist pointer -* 'var': variable name (must be type "integer") +* _infolist_: infolist pointer +* _var_: variable name (must be type "integer") Return value: @@ -14019,8 +14020,8 @@ const char *weechat_infolist_string (struct t_infolist *infolist, const char *va Arguments: -* 'infolist': infolist pointer -* 'var': variable name (must be type "string") +* _infolist_: infolist pointer +* _var_: variable name (must be type "string") Return value: @@ -14058,8 +14059,8 @@ void *weechat_infolist_pointer (struct t_infolist *infolist, const char *var); Arguments: -* 'infolist': infolist pointer -* 'var': variable name (must be type "pointer") +* _infolist_: infolist pointer +* _var_: variable name (must be type "pointer") Return value: @@ -14098,9 +14099,9 @@ void *weechat_infolist_buffer (struct t_infolist *infolist, const char *var, Arguments: -* 'infolist': infolist pointer -* 'var': variable name (must be type "buffer") -* 'size': pointer to integer variable, will be set with buffer size +* _infolist_: infolist pointer +* _var_: variable name (must be type "buffer") +* _size_: pointer to integer variable, will be set with buffer size Return value: @@ -14132,8 +14133,8 @@ time_t weechat_infolist_time (struct t_infolist *infolist, const char *var); Arguments: -* 'infolist': infolist pointer -* 'var': variable name (must be type "time") +* _infolist_: infolist pointer +* _var_: variable name (must be type "time") Return value: @@ -14171,7 +14172,7 @@ void weechat_infolist_free (struct t_infolist *infolist); Arguments: -* 'infolist': infolist pointer +* _infolist_: infolist pointer C example: @@ -14234,23 +14235,23 @@ struct t_hdata *weechat_hdata_new (const char *hdata_name, const char *var_prev, Arguments: -* 'hdata_name': name of hdata -* 'var_prev': name of variable in structure which is a pointer to previous +* _hdata_name_: name of hdata +* _var_prev_: name of variable in structure which is a pointer to previous element in list (may be NULL if no such variable is available) -* 'var_next': name of variable in structure which is a pointer to next +* _var_next_: name of variable in structure which is a pointer to next element in list (may be NULL if no such variable is available) -* 'create_allowed': 1 if create of structure is allowed, otherwise 0 +* _create_allowed_: 1 if create of structure is allowed, otherwise 0 _(WeeChat ≥ 0.4.0)_ -* 'delete_allowed': 1 if delete of structure is allowed, otherwise 0 +* _delete_allowed_: 1 if delete of structure is allowed, otherwise 0 _(WeeChat ≥ 0.3.9)_ -* 'callback_update': callback to update data in hdata, can be NULL if no update +* _callback_update_: callback to update data in hdata, can be NULL if no update is allowed _(WeeChat ≥ 0.3.9)_, arguments and return value: -** 'void *data': pointer -** 'struct t_hdata *hdata': pointer to hdata -** 'struct t_hashtable *hashtable': hashtable with variables to update +** _void *data_: pointer +** _struct t_hdata *hdata_: pointer to hdata +** _struct t_hashtable *hashtable_: hashtable with variables to update (see <<_hdata_update,weechat_hdata_update>>) ** return value: number of variables updated -* 'callback_update_data': pointer given to update callback when it is called by +* _callback_update_data_: pointer given to update callback when it is called by WeeChat _(WeeChat ≥ 0.3.9)_ Return value: @@ -14283,10 +14284,10 @@ void weechat_hdata_new_var (struct t_hdata *hdata, const char *name, int offset, Arguments: -* 'hdata': hdata pointer -* 'name': variable name -* 'offset': offset of variable in structure -* 'type': variable type, one of: +* _hdata_: hdata pointer +* _name_: variable name +* _offset_: offset of variable in structure +* _type_: variable type, one of: ** WEECHAT_HDATA_CHAR ** WEECHAT_HDATA_INTEGER ** WEECHAT_HDATA_LONG @@ -14296,16 +14297,16 @@ Arguments: ** WEECHAT_HDATA_TIME ** WEECHAT_HDATA_HASHTABLE ** WEECHAT_HDATA_OTHER -* 'update_allowed': 1 if update of variable is allowed, otherwise 0 +* _update_allowed_: 1 if update of variable is allowed, otherwise 0 _(WeeChat ≥ 0.3.9)_ -* 'array_size': not NULL only if a variable is an array, and it can be: +* _array_size_: not NULL only if a variable is an array, and it can be: _(WeeChat ≥ 0.3.9)_ ** name of variable in hdata: this variable will be used as size of array (dynamic size for array) ** integer (as string): fixed size for array -** '*': automatic size: the size of array is computed by looking at values, when +** _*_: automatic size: the size of array is computed by looking at values, when the first NULL is found (only for type string, pointer or hashtable) -* 'hdata_name': name of a hdata (if it's a pointer to a structure with hdata) +* _hdata_name_: name of a hdata (if it's a pointer to a structure with hdata) C example: @@ -14365,11 +14366,11 @@ void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *poin Arguments: -* 'hdata': hdata pointer -* 'name': variable name -* 'pointer': list pointer -* 'flags': combination of following values: _(WeeChat ≥ 1.0)_ -** 'WEECHAT_HDATA_LIST_CHECK_POINTERS': list used to check pointers +* _hdata_: hdata pointer +* _name_: variable name +* _pointer_: list pointer +* _flags_: combination of following values: _(WeeChat ≥ 1.0)_ +** _WEECHAT_HDATA_LIST_CHECK_POINTERS_: list used to check pointers C example: @@ -14432,7 +14433,7 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Arguments: -* 'hdata_name': name of hdata (see list below) +* _hdata_name_: name of hdata (see list below) Return value: @@ -14475,8 +14476,8 @@ int weechat_hdata_get_var_offset (struct t_hdata *hdata, const char *name); Arguments: -* 'hdata': hdata pointer -* 'name': variable name +* _hdata_: hdata pointer +* _name_: variable name Return value: @@ -14515,8 +14516,8 @@ int weechat_hdata_get_var_type (struct t_hdata *hdata, const char *name); Arguments: -* 'hdata': hdata pointer -* 'name': variable name +* _hdata_: hdata pointer +* _name_: variable name Return value: @@ -14580,8 +14581,8 @@ const char *weechat_hdata_get_var_type_string (struct t_hdata *hdata, const char Arguments: -* 'hdata': hdata pointer -* 'name': variable name +* _hdata_: hdata pointer +* _name_: variable name Return value: @@ -14620,9 +14621,9 @@ int weechat_hdata_get_var_array_size (struct t_hdata *hdata, void *pointer, cons Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name Return value: @@ -14662,9 +14663,9 @@ const char *weechat_hdata_get_var_array_size_string (struct t_hdata *hdata, void Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name Return value: @@ -14704,8 +14705,8 @@ const char *weechat_hdata_get_var_hdata (struct t_hdata *hdata, const char *name Arguments: -* 'hdata': hdata pointer -* 'name': variable name +* _hdata_: hdata pointer +* _name_: variable name Return value: @@ -14744,9 +14745,9 @@ void *weechat_hdata_get_var (struct t_hdata *hdata, void *pointer, const char *n Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name Return value: @@ -14779,9 +14780,9 @@ void *weechat_hdata_get_var_at_offset (struct t_hdata *hdata, void *pointer, int Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'offset': offset of variable +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _offset_: offset of variable Return value: @@ -14815,8 +14816,8 @@ void *weechat_hdata_get_list (struct t_hdata *hdata, const char *name); Arguments: -* 'hdata': hdata pointer -* 'name': list name +* _hdata_: hdata pointer +* _name_: list name Return value: @@ -14857,12 +14858,12 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe Arguments: -* 'hdata': hdata pointer -* 'list': list pointer; if NULL _(WeeChat ≥ 1.0)_, the pointer is checked with +* _hdata_: hdata pointer +* _list_: list pointer; if NULL _(WeeChat ≥ 1.0)_, the pointer is checked with the lists in hdata that have flag "check pointers" (see <<_hdata_new_list,weechat_hdata_new_list>>), and if no such list exists, the pointer is considered as valid -* 'pointer': pointer to check +* _pointer_: pointer to check Return value: @@ -14918,9 +14919,9 @@ void *weechat_hdata_move (struct t_hdata *hdata, void *pointer, int count); Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to a WeeChat/plugin object -* 'count': number of jump(s) to execute (negative or positive integer, different +* _hdata_: hdata pointer +* _pointer_: pointer to a WeeChat/plugin object +* _count_: number of jump(s) to execute (negative or positive integer, different from 0) Return value: @@ -14965,7 +14966,7 @@ if buffer: _WeeChat ≥ 0.4.1._ -Search element in a list: the expression 'search' is evaluated for each element +Search element in a list: the expression _search_ is evaluated for each element in list, until element is found (or end of list). Prototype: @@ -14977,12 +14978,12 @@ void *weechat_hdata_search (struct t_hdata *hdata, void *pointer, const char *se Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to a WeeChat/plugin object -* 'search': expression to evaluate, default pointer in expression is the name of +* _hdata_: hdata pointer +* _pointer_: pointer to a WeeChat/plugin object +* _search_: expression to evaluate, default pointer in expression is the name of hdata (and this pointer changes for each element in list); for help on - expression, see command `/eval` in 'WeeChat User's guide' -* 'move': number of jump(s) to execute after unsuccessful search (negative or + expression, see command `/eval` in _WeeChat User's guide_ +* _move_: number of jump(s) to execute after unsuccessful search (negative or positive integer, different from 0) Return value: @@ -15036,9 +15037,9 @@ char weechat_hdata_char (struct t_hdata *hdata, void *pointer, const char *name) Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "char"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "char"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15078,9 +15079,9 @@ int weechat_hdata_integer (struct t_hdata *hdata, void *pointer, const char *nam Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "integer"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "integer"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15124,9 +15125,9 @@ long weechat_hdata_long (struct t_hdata *hdata, void *pointer, const char *name) Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "long"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "long"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15166,9 +15167,9 @@ const char *weechat_hdata_string (struct t_hdata *hdata, void *pointer, const ch Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "string"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "string"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15212,9 +15213,9 @@ void *weechat_hdata_pointer (struct t_hdata *hdata, void *pointer, const char *n Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "pointer"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "pointer"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15258,9 +15259,9 @@ time_t weechat_hdata_time (struct t_hdata *hdata, void *pointer, const char *nam Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "time"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "time"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15326,9 +15327,9 @@ struct t_hashtable *weechat_hdata_hashtable (struct t_hdata *hdata, void *pointe Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (must be type "hashtable"); for arrays, the name can be +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (must be type "hashtable"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" Return value: @@ -15382,11 +15383,11 @@ int weechat_hdata_set (struct t_hdata *hdata, void *pointer, const char *name, c Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (types allowed: char, integer, long, string, pointer, +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (types allowed: char, integer, long, string, pointer, time) -* 'value': new value for variable +* _value_: new value for variable Return value: @@ -15417,9 +15418,9 @@ int weechat_hdata_update (struct t_hdata *hdata, void *pointer, struct t_hashtab Arguments: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'hashtable': variables to update: keys are name of variables, values are new +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _hashtable_: variables to update: keys are name of variables, values are new values for variables (keys and values are string), some special keys are allowed: ** key `__create_allowed` (with any value): return 1 if create is allowed for @@ -15503,23 +15504,23 @@ const char *weechat_hdata_get_string (struct t_hdata *hdata, const char *propert Arguments: -* 'hdata': hdata pointer -* 'property': property name: -** 'var_keys': string with list of keys for variables in hdata +* _hdata_: hdata pointer +* _property_: property name: +** _var_keys_: string with list of keys for variables in hdata (format: "key1,key2,key3") -** 'var_values': string with list of values for variables in hdata +** _var_values_: string with list of values for variables in hdata (format: "value1,value2,value3") -** 'var_keys_values': string with list of keys and values for variables in hdata +** _var_keys_values_: string with list of keys and values for variables in hdata (format: "key1:value1,key2:value2,key3:value3") -** 'var_prev': name of variable in structure which is a pointer to previous +** _var_prev_: name of variable in structure which is a pointer to previous element in list -** 'var_next': name of variable in structure which is a pointer to next +** _var_next_: name of variable in structure which is a pointer to next element in list -** 'list_keys': string with list of keys for lists in hdata +** _list_keys_: string with list of keys for lists in hdata (format: "key1,key2,key3") -** 'list_values': string with list of values for lists in hdata +** _list_values_: string with list of values for lists in hdata (format: "value1,value2,value3") -** 'list_keys_values': string with list of keys and values for lists in hdata +** _list_keys_values_: string with list of keys and values for lists in hdata (format: "key1:value1,key2:value2,key3:value3") Return value: @@ -15573,22 +15574,22 @@ struct t_upgrade_file *upgrade_file_new (const char *filename, Arguments: -* 'filename': name of file (extension ".upgrade" is added to this name by +* _filename_: name of file (extension ".upgrade" is added to this name by WeeChat) -* 'callback_read': function called for each object read in upgrade file +* _callback_read_: function called for each object read in upgrade file (if NULL, the upgrade file is opened in write mode), arguments and return value: -** 'const void *pointer': pointer -** '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 +** _const void *pointer_: pointer +** _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_pointer': pointer given to callback when it is called by +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_read_pointer_: pointer given to callback when it is called by WeeChat -* 'callback_read_data': pointer given to callback when it is called by WeeChat; +* _callback_read_data_: pointer given to callback when it is called by WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the upgrade file is closed @@ -15630,9 +15631,9 @@ int weechat_upgrade_write_object (struct t_upgrade_file *upgrade_file, Arguments: -* 'upgrade_file': upgrade file pointer -* 'object_id': id for object -* 'infolist': infolist to write in file +* _upgrade_file_: upgrade file pointer +* _object_id_: id for object +* _infolist_: infolist to write in file Return value: @@ -15678,7 +15679,7 @@ int weechat_upgrade_read (struct t_upgrade_file *upgrade_file); Arguments: -* 'upgrade_file': upgrade file pointer +* _upgrade_file_: upgrade file pointer Return value: @@ -15715,7 +15716,7 @@ void weechat_upgrade_close (struct t_upgrade_file *upgrade_file); Arguments: -* 'upgrade_file': upgrade file pointer +* _upgrade_file_: upgrade file pointer C example: diff --git a/doc/fr/weechat_plugin_api.fr.asciidoc b/doc/fr/weechat_plugin_api.fr.asciidoc index dfce7b0ac..14b57f255 100644 --- a/doc/fr/weechat_plugin_api.fr.asciidoc +++ b/doc/fr/weechat_plugin_api.fr.asciidoc @@ -6,7 +6,7 @@ :toclevels: 4 :toc-title: Table des matières :sectnums: -:sectnumlevels: 2 +:sectnumlevels: 3 :docinfo1: @@ -86,23 +86,23 @@ int weechat_plugin_init (struct t_weechat_plugin *plugin, Paramètres : -* 'plugin' : pointeur vers la structure d'extension WeeChat -* 'argc' : nombre de paramètres pour l'extension (donnés sur la ligne de +* _plugin_ : pointeur vers la structure d'extension WeeChat +* _argc_ : nombre de paramètres pour l'extension (donnés sur la ligne de commande par l'utilisateur) -* 'argv' : paramètres pour l'extension +* _argv_ : paramètres pour l'extension Valeur de retour : -* 'WEECHAT_RC_OK' si ok (l'extension sera chargée) -* 'WEECHAT_RC_ERROR' si erreur (l'extension ne sera PAS chargée) +* _WEECHAT_RC_OK_ si ok (l'extension sera chargée) +* _WEECHAT_RC_ERROR_ si erreur (l'extension ne sera PAS chargée) [[plugin_priority]] ===== Priorité de l'extension Lorsque les extensions sont automatiquement chargées (par exemple au démarrage), WeeChat charge d'abord toutes les extensions, puis appelle les -fonctions 'init', en utilisant la priorité définie dans chaque extension. -Une grande priorité signifie que la fonction 'init' est appelée en premier. +fonctions _init_, en utilisant la priorité définie dans chaque extension. +Une grande priorité signifie que la fonction _init_ est appelée en premier. La priorité par défaut est 1000 (avec une telle priorité, l'extension est chargée après toutes les extensions par défaut). @@ -124,18 +124,18 @@ int weechat_plugin_end (struct t_weechat_plugin *plugin); Paramètres : -* 'plugin' : pointeur vers la structure d'extension WeeChat +* _plugin_ : pointeur vers la structure d'extension WeeChat Valeur de retour : -* 'WEECHAT_RC_OK' si ok -* 'WEECHAT_RC_ERROR' si erreur +* _WEECHAT_RC_OK_ si ok +* _WEECHAT_RC_ERROR_ si erreur [[compile_plugin]] === Compilation de l'extension La compilation ne nécessite pas les sources de WeeChat, seul le fichier - 'weechat-plugin.h' est requis. +_weechat-plugin.h_ est requis. Pour compiler l'extension qui n'a qu'un fichier "toto.c" (sous GNU/Linux) : @@ -147,9 +147,9 @@ $ gcc -shared -fPIC -o libtoto.so toto.o [[load_plugin]] === Chargement de l'extension -Copiez le fichier 'libtoto.so' dans le répertoire système des extensions (par -exemple '/usr/local/lib/weechat/plugins') ou dans le répertoire utilisateur des -extensions (par exemple '/home/xxx/.weechat/plugins'). +Copiez le fichier _libtoto.so_ dans le répertoire système des extensions (par +exemple _/usr/local/lib/weechat/plugins_) ou dans le répertoire utilisateur des +extensions (par exemple _/home/xxx/.weechat/plugins_). Sous WeeChat : @@ -160,7 +160,7 @@ Sous WeeChat : [[plugin_example]] === Exemple d'extension -Exemple complet d'extension, qui ajoute une commande '/double' : affiche deux +Exemple complet d'extension, qui ajoute une commande _/double_ : affiche deux fois les paramètres sur le tampon courant, ou exécute deux fois une commande (ok ce n'est pas très utile, mais c'est juste un exemple !) : @@ -262,7 +262,7 @@ const char *weechat_plugin_get_name (struct t_weechat_plugin *plugin); Paramètres : -* 'plugin' : pointeur vers la structure d'extension WeeChat (peut être NULL) +* _plugin_ : pointeur vers la structure d'extension WeeChat (peut être NULL) Valeur de retour : @@ -298,7 +298,7 @@ car elles sont ok avec UTF-8 et la locale. ==== charset_set Définir le nouveau jeu de caractères (le jeu de caractères par défaut est -'UTF-8', donc si votre extension utilise 'UTF-8', vous n'avez pas besoin +_UTF-8_, donc si votre extension utilise _UTF-8_, vous n'avez pas besoin d'appeler cette fonction). Prototype : @@ -310,7 +310,7 @@ void weechat_charset_set (const char *charset); Paramètres : -* 'charset' : nouveau jeu de caractères à utiliser +* _charset_ : nouveau jeu de caractères à utiliser Exemple en C : @@ -343,8 +343,8 @@ char *weechat_iconv_to_internal (const char *charset, const char *string); Paramètres : -* 'charset' : jeu de caractères à convertir -* 'string' : chaîne à convertir +* _charset_ : jeu de caractères à convertir +* _string_ : chaîne à convertir Valeur de retour : @@ -383,8 +383,8 @@ char *weechat_iconv_from_internal (const char *charset, const char *string); Paramètres : -* 'charset' : jeu de caractères cible -* 'string' : chaîne à convertir +* _charset_ : jeu de caractères cible +* _string_ : chaîne à convertir Valeur de retour : @@ -423,7 +423,7 @@ const char *weechat_gettext (const char *string); Paramètres : -* 'string' : chaîne à traduire +* _string_ : chaîne à traduire Valeur de retour : @@ -450,7 +450,7 @@ str = weechat.gettext("hello") ==== ngettext Retourner la chaîne traduite, en utilisant le singulier ou le pluriel, selon -le paramètre 'count'. +le paramètre _count_. Prototype : @@ -462,9 +462,9 @@ const char *weechat_ngettext (const char *string, const char *plural, Paramètres : -* 'string' : chaîne à traduire, au singulier -* 'plural' : chaîne à traduire, au pluriel -* 'count' : utilisé pour choisir entre le singulier et le pluriel (le choix est +* _string_ : chaîne à traduire, au singulier +* _plural_ : chaîne à traduire, au pluriel +* _count_ : utilisé pour choisir entre le singulier et le pluriel (le choix est fonction de la langue utilisée) Valeur de retour : @@ -492,7 +492,7 @@ str = weechat.ngettext("file", "files", num_files) ==== strndup -Retourner la chaîne dupliquée, avec au plus 'length' caractères. +Retourner la chaîne dupliquée, avec au plus _length_ caractères. Prototype : @@ -503,8 +503,8 @@ char *weechat_strndup (const char *string, int length); Paramètres : -* 'string' : chaîne à dupliquer -* 'length' : nombre maximum de caractères à dupliquer +* _string_ : chaîne à dupliquer +* _length_ : nombre maximum de caractères à dupliquer Valeur de retour : @@ -535,7 +535,7 @@ void weechat_string_tolower (char *string); Paramètres : -* 'string' : chaîne à convertir +* _string_ : chaîne à convertir Exemple en C : @@ -561,7 +561,7 @@ void weechat_string_toupper (char *string); Paramètres : -* 'string' : chaîne à convertir +* _string_ : chaîne à convertir Exemple en C : @@ -589,8 +589,8 @@ int weechat_strcasecmp (const char *string1, const char *string2); Paramètres : -* 'string1' : première chaîne à comparer -* 'string2' : seconde chaîne à comparer +* _string1_ : première chaîne à comparer +* _string2_ : seconde chaîne à comparer Valeur de retour : @@ -624,12 +624,12 @@ int weechat_strcasecmp_range (const char *string1, const char *string2, int rang Paramètres : -* 'string1' : première chaîne à comparer -* 'string2' : seconde chaîne à comparer -* 'range' : nombre de caractères pour la comparaison de casse, par exemple : -** 26 : "A-Z" deviennent en minuscules "a-z" -** 29 : "A-Z [ \ ]" deviennent minuscules "a-z { | }" -** 30 : "A-Z [ \ ] ^" deviennent minuscules "a-z { | } ~" +* _string1_ : première chaîne à comparer +* _string2_ : seconde chaîne à comparer +* _range_ : nombre de caractères pour la comparaison de casse, par exemple : +** 26 : `A-Z` deviennent en minuscules `a-z` +** 29 : `A-Z [ \ ]` deviennent minuscules `a-z { | }` +** 30 : `A-Z [ \ ] ^` deviennent minuscules `a-z { | } ~` [NOTE] Les valeurs 29 et 30 sont utilisés par quelques protocoles comme IRC. @@ -654,7 +654,7 @@ Cette fonction n'est pas disponible dans l'API script. _Mis à jour dans la 1.0._ -Comparer deux chaînes indépendemment de la locale et de la casse, pour 'max' +Comparer deux chaînes indépendemment de la locale et de la casse, pour _max_ caractères. Prototype : @@ -666,9 +666,9 @@ int weechat_strncasecmp (const char *string1, const char *string2, int max); Paramètres : -* 'string1' : première chaîne à comparer -* 'string2' : seconde chaîne à comparer -* 'max' : nombre maximum de caractères à comparer +* _string1_ : première chaîne à comparer +* _string2_ : seconde chaîne à comparer +* _max_ : nombre maximum de caractères à comparer Valeur de retour : @@ -690,7 +690,7 @@ Cette fonction n'est pas disponible dans l'API script. _WeeChat ≥ 0.3.7, mis à jour dans la 1.0._ -Comparer deux chaînes indépendemment de la locale et de la casse, pour 'max' +Comparer deux chaînes indépendemment de la locale et de la casse, pour _max_ caractères, avec un intervalle pour comparer la casse. Prototype : @@ -702,13 +702,13 @@ int weechat_strncasecmp_range (const char *string1, const char *string2, int max Paramètres : -* 'string1' : première chaîne à comparer -* 'string2' : seconde chaîne à comparer -* 'max' : nombre maximum de caractères à comparer -* 'range' : nombre de caractères pour la comparaison de casse, par exemple : -** 26 : "A-Z" deviennent en minuscules "a-z" -** 29 : "A-Z [ \ ]" deviennent minuscules "a-z { | }" -** 30 : "A-Z [ \ ] ^" deviennent minuscules "a-z { | } ~" +* _string1_ : première chaîne à comparer +* _string2_ : seconde chaîne à comparer +* _max_ : nombre maximum de caractères à comparer +* _range_ : nombre de caractères pour la comparaison de casse, par exemple : +** 26 : `A-Z` deviennent en minuscules `a-z` +** 29 : `A-Z [ \ ]` deviennent minuscules `a-z { | }` +** 30 : `A-Z [ \ ] ^` deviennent minuscules `a-z { | } ~` [NOTE] Les valeurs 29 et 30 sont utilisés par quelques protocoles comme IRC. @@ -747,10 +747,10 @@ int weechat_strcmp_ignore_chars (const char *string1, const char *string2, Paramètres : -* 'string1' : première chaîne à comparer -* 'string2' : seconde chaîne à comparer -* 'chars_ignored' : chaîne avec les caractères à ignorer -* 'case_sensitive' : 1 pour une comparaison tenant compte de la casse, sinon 0 +* _string1_ : première chaîne à comparer +* _string2_ : seconde chaîne à comparer +* _chars_ignored_ : chaîne avec les caractères à ignorer +* _case_sensitive_ : 1 pour une comparaison tenant compte de la casse, sinon 0 Valeur de retour : @@ -783,14 +783,14 @@ const char *weechat_strcasestr (const char *string, const char *search); Paramètres : -* 'string' : chaîne -* 'search' : chaîne à rechercher dans 'string' +* _string_ : chaîne +* _search_ : chaîne à rechercher dans _string_ Valeur de retour : * pointeur vers la chaîne trouvée, ou NULL si non trouvée - (_WeeChat ≥ 1.3_ : le pointeur retourné est un 'const char *' au lieu d'un - 'char *') + (_WeeChat ≥ 1.3_ : le pointeur retourné est un _const char *_ au lieu d'un + _char *_) Exemple en C : @@ -820,7 +820,7 @@ int weechat_strlen_screen (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -860,10 +860,10 @@ int weechat_string_match (const char *string, const char *mask, Paramètres : -* 'string' : chaîne -* 'mask' : masque avec des caractères joker ("*"), chaque joker correspond à 0 +* _string_ : chaîne +* _mask_ : masque avec des caractères joker (`+*+`), chaque joker correspond à 0 ou plusieurs caractères dans la chaîne -* 'case_sensitive' : 1 pour une comparaison tenant compte de la casse, sinon 0 +* _case_sensitive_ : 1 pour une comparaison tenant compte de la casse, sinon 0 [NOTE] Depuis la version 1.0, les caractères joker sont autorisés à l'intérieur du @@ -903,8 +903,8 @@ match5 = weechat.string_match("abcdef", "*b*d*", 0) # 1 _WeeChat ≥ 0.3.3._ -Remplacer le `~` en début de chaîne par le répertoire "home". Si la chaîne ne -débute pas par `~`, alors une chaîne identique est retournée. +Remplacer le `+~+` en début de chaîne par le répertoire "home". Si la chaîne ne +débute pas par `+~+`, alors une chaîne identique est retournée. Prototype : @@ -915,11 +915,11 @@ char *weechat_string_expand_home (const char *path); Paramètres : -* 'path' : chemin +* _path_ : chemin Valeur de retour : -* chemin avec le `~` en début remplacé par le répertoire "home" (doit être +* chemin avec le `+~+` en début remplacé par le répertoire "home" (doit être supprimé par un appel à "free" après utilisation) Exemple en C : @@ -942,7 +942,7 @@ _WeeChat ≥ 1.3._ Évaluer un chemin en 3 étapes : . remplacer le `%h` du début par le répertoire maison de WeeChat, -. remplacer le `~` du début par le répertoire maison de l'utilisateur (appel à +. remplacer le `+~+` du début par le répertoire maison de l'utilisateur (appel à <<_string_expand_home,weechat_string_expand_home>>), . évaluer les variables (voir <<_string_eval_expression,weechat_string_eval_expression>>). @@ -959,12 +959,12 @@ char *weechat_string_eval_path_home (const char *path, Paramètres : -* 'path' : chemin -* 'pointers' : table de hachage pour l'appel à la fonction +* _path_ : chemin +* _pointers_ : table de hachage pour l'appel à la fonction <<_string_eval_expression,weechat_string_eval_expression>> -* 'extra_vars' : table de hachage pour l'appel à la fonction +* _extra_vars_ : table de hachage pour l'appel à la fonction <<_string_eval_expression,weechat_string_eval_expression>> -* 'options' : table de hachage pour l'appel à la fonction +* _options_ : table de hachage pour l'appel à la fonction <<_string_eval_expression,weechat_string_eval_expression>> Valeur de retour : @@ -1007,8 +1007,8 @@ char *weechat_string_remove_quotes (const char *string, const char *quotes); Paramètres : -* 'string' : chaîne -* 'quotes' : chaîne avec la liste des apostrophes/guillemets à supprimer +* _string_ : chaîne +* _quotes_ : chaîne avec la liste des apostrophes/guillemets à supprimer Valeur de retour : @@ -1042,10 +1042,10 @@ char *weechat_string_strip (const char *string, int left, int right, Paramètres : -* 'string' : chaîne -* 'left' : supprime les caractères en début de chaîne si différent de 0 -* 'right' : supprime les caractères en fin de chaîne si différent de 0 -* 'chars' : chaîne avec les caractères à supprimer +* _string_ : chaîne +* _left_ : supprime les caractères en début de chaîne si différent de 0 +* _right_ : supprime les caractères en fin de chaîne si différent de 0 +* _chars_ : chaîne avec les caractères à supprimer Valeur de retour : @@ -1070,22 +1070,22 @@ _WeeChat ≥ 1.0._ Convertir les caractères échappés par leur valeur : -* `\"` : double guillemet droit -* `\\` : barre oblique inversée -* `\a` : alerte (BEL) -* `\b` : retour arrière -* `\e` : échappement -* `\f` : saut de page -* `\n` : nouvelle ligne -* `\r` : retour chariot -* `\t` : tabulation horizontale -* `\v` : tabulation verticale -* `\0ooo` : caractère sous forme de valeur octale (ooo a 0 à 3 chiffres) -* `\xhh` : caractère sous forme de valeur hexadécimale (hh a 1 à 2 chiffres) -* `\uhhhh` : caractère unicode sous forme de valeur hexadécimale (hhhh a 1 à 4 - chiffres) -* `\Uhhhhhhhh` : caractère unicode sous forme de valeur hexadécimale (hhhhhhhh - a 1 à 8 chiffres) +* `+\"+` : double guillemet droit +* `+\\+` : barre oblique inversée +* `+\a+` : alerte (BEL) +* `+\b+` : retour arrière +* `+\e+` : échappement +* `+\f+` : saut de page +* `+\n+` : nouvelle ligne +* `+\r+` : retour chariot +* `+\t+` : tabulation horizontale +* `+\v+` : tabulation verticale +* `+\0ooo+` : caractère sous forme de valeur octale (`ooo` a 0 à 3 chiffres) +* `+\xhh+` : caractère sous forme de valeur hexadécimale (`hh` a 1 à 2 chiffres) +* `+\uhhhh+` : caractère unicode sous forme de valeur hexadécimale + (`hhhh` a 1 à 4 chiffres) +* `+\Uhhhhhhhh+` : caractère unicode sous forme de valeur hexadécimale + (`hhhhhhhh` a 1 à 8 chiffres) Prototype : @@ -1096,7 +1096,7 @@ char *weechat_string_convert_escaped_chars (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -1119,7 +1119,7 @@ Cette fonction n'est pas disponible dans l'API script. ==== string_mask_to_regex Retourner une expression régulière ("regex"), construite avec un masque où le -seul caractère spécial est "`*`". Tous les autres caractères spéciaux +seul caractère spécial est `+*+`. Tous les autres caractères spéciaux d'expression régulière sont échappés. Prototype : @@ -1131,7 +1131,7 @@ char *weechat_string_mask_to_regex (const char *mask); Paramètres : -* 'mask' : masque +* _mask_ : masque Valeur de retour : @@ -1175,13 +1175,13 @@ const char *weechat_string_regex_flags (const char *regex, int default_flags, in Paramètres : -* 'regex' : expression régulière POSIX étendue -* 'default_flags' : combinaison des valeurs suivantes (voir `man regcomp`) : +* _regex_ : expression régulière POSIX étendue +* _default_flags_ : combinaison des valeurs suivantes (voir `man regcomp`) : ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE ** REG_NOSUB -* 'flags' : la valeur du pointer est alimentée avec les "flags" utilisés dans +* _flags_ : la valeur du pointer est alimentée avec les "flags" utilisés dans l'expression régulière ("flags" par défaut + "flags" définis dans l'expression régulière) @@ -1190,16 +1190,16 @@ Les "flags" doivent être au début de l'expression régulière. Le format est : Les "flags" autorisés sont : -* 'e' : expression régulière POSIX étendue ('REG_EXTENDED') -* 'i' : insensible à la casse ('REG_ICASE') -* 'n' : les opérateurs qui cherchent n'importe quel caractère ne trouvent pas - les nouvelles lignes ('REG_NEWLINE') -* 's' : le support d'adressage des sous-chaînes de correspondance n'est pas - requis ('REG_NOSUB') +* _e_ : expression régulière POSIX étendue (_REG_EXTENDED_) +* _i_ : insensible à la casse (_REG_ICASE_) +* _n_ : les opérateurs qui cherchent n'importe quel caractère ne trouvent pas + les nouvelles lignes (_REG_NEWLINE_) +* _s_ : le support d'adressage des sous-chaînes de correspondance n'est pas + requis (_REG_NOSUB_) Valeur de retour : -* pointeur dans la 'regex', après les "flags" +* pointeur dans la _regex_, après les "flags" Exemple en C : @@ -1231,9 +1231,9 @@ int weechat_string_regcomp (void *preg, const char *regex, int default_flags) Paramètres : -* 'preg' : pointeur vers la structure 'regex_t' -* 'regex' : expression régulière POSIX étendue -* 'default_flags' : combinaison des valeurs suivantes (voir `man regcomp`) : +* _preg_ : pointeur vers la structure _regex_t_ +* _regex_ : expression régulière POSIX étendue +* _default_flags_ : combinaison des valeurs suivantes (voir `man regcomp`) : ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE @@ -1273,8 +1273,8 @@ int weechat_string_has_highlight (const char *string, Paramètres : -* 'string' : chaîne -* 'highlight_words' : liste de mots "highlight", séparés par des virgules +* _string_ : chaîne +* _highlight_words_ : liste de mots "highlight", séparés par des virgules Valeur de retour : @@ -1305,7 +1305,7 @@ _WeeChat ≥ 0.3.4._ Vérifier si une chaîne a un ou plusieurs "highlights", en utilisant une expression régulière POSIX étendue. + Pour au moins une correspondance dans la chaîne, elle doit être entourée de -délimiteurs (caractères différents de : alphanumérique, "-", "_" et "|"). +délimiteurs (caractères différents de : alphanumérique, `+-+`, `+_+` et `+|+`). Prototype : @@ -1316,8 +1316,8 @@ int weechat_string_has_highlight_regex (const char *string, const char *regex); Paramètres : -* 'string' : chaîne -* 'regex' : expression régulière POSIX étendue +* _string_ : chaîne +* _regex_ : expression régulière POSIX étendue Valeur de retour : @@ -1355,13 +1355,13 @@ char *weechat_string_replace (const char *string, const char *search, Paramètres : -* 'string' : chaîne -* 'search' : chaîne à remplacer -* 'replace' : remplacement pour la chaîne 'search' +* _string_ : chaîne +* _search_ : chaîne à remplacer +* _replace_ : remplacement pour la chaîne _search_ Valeur de retour : -* chaîne avec 'search' remplacée par 'replace' (doit être supprimée par un appel +* chaîne avec _search_ remplacée par _replace_ (doit être supprimée par un appel à "free" après utilisation) Exemple en C : @@ -1395,29 +1395,29 @@ char *weechat_string_replace_regex (const char *string, void *regex, Paramètres : -* 'string' : chaîne -* 'regex' : pointeur vers une expression régulière (structure 'regex_t') +* _string_ : chaîne +* _regex_ : pointeur vers une expression régulière (structure _regex_t_) compilée avec la fonction WeeChat <<_string_regcomp,weechat_string_regcomp>> ou regcomp (voir `man regcomp`) -* 'replace' : texte de remplacement, où les références suivantes sont +* _replace_ : texte de remplacement, où les références suivantes sont autorisées : -** `$0` à `$99` : correspondance 0 à 99 dans l'expression régulière (0 est la +** `+$0+` à `+$99+` : correspondance 0 à 99 dans l'expression régulière (0 est la correspondance entière, 1 à 99 sont les groupes capturés entre parenthèses) -** `$+` : la dernière correspondance (avec le numéro le plus élevé) -** `$.*N` : correspondance `N` (peut être `+` ou de `0` à `99`), avec tous les - caractères remplacés par `*` (le caractère `*` peut être n'importe quel - caractère entre l'espace (32) et `~` (126)) -* 'reference_char' : le caractère utilisé pour les références aux - correspondances (en général '$') -* 'callback' : un "callback" optionnel appelé pour chaque référence dans - 'replace' (sauf pour les correspondances remplacées par un caractère); le +** `+$++` : la dernière correspondance (avec le numéro le plus élevé) +** `+$.*N+` : correspondance `+N+` (peut être `+++` ou de `+0+` à `+99+`), avec + tous les caractères remplacés par `+*+` (le caractère `+*+` peut être n'importe quel + caractère entre l'espace (32) et `+~+` (126)) +* _reference_char_ : le caractère utilisé pour les références aux + correspondances (en général `+$+`) +* _callback_ : un "callback" optionnel appelé pour chaque référence dans + _replace_ (sauf pour les correspondances remplacées par un caractère); le "callback" doit retourner : ** une chaîne nouvellement allouée : elle est utilisée en texte de remplacement (elle est libérée après utilisation) ** NULL : le texte reçu dans le "callback" est utilisé comme texte de remplacement (sans changement) -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé Valeur de retour : @@ -1460,17 +1460,17 @@ char **weechat_string_split (const char *string, const char *separators, Paramètres : -* 'string' : chaîne à découper -* 'separators' : délimiteurs utilisés pour le découpage -* 'keep_eol' : si différent de 0, alors chaque paramètre contiendra toutes les +* _string_ : chaîne à découper +* _separators_ : délimiteurs utilisés pour le découpage +* _keep_eol_ : si différent de 0, alors chaque paramètre contiendra toutes les chaînes jusqu'à la fin de la ligne (voir exemple ci-dessous) ** 0 : chaque chaîne contiendra un mot ** 1 : chaque chaîne contiendra toute la chaîne jusqu'à la fin de la ligne (voir exemple ci-dessous) ** 2 : comme 1, mais ne supprime pas les séparateurs en fin de chaîne avant le découpage _(WeeChat ≥ 0.3.6)_ -* 'num_items_max' : nombre maximum de chaînes à créer (0 = pas de limite) -* 'num_items' : pointeur vers un entier qui contiendra le nombre de chaînes +* _num_items_max_ : nombre maximum de chaînes à créer (0 = pas de limite) +* _num_items_ : pointeur vers un entier qui contiendra le nombre de chaînes créées Valeur de retour : @@ -1535,8 +1535,8 @@ char **weechat_string_split_shell (const char *string, int *num_items); Paramètres : -* 'string' : chaîne à découper -* 'num_items' : pointeur vers un entier qui contiendra le nombre de chaînes +* _string_ : chaîne à découper +* _num_items_ : pointeur vers un entier qui contiendra le nombre de chaînes créées Valeur de retour : @@ -1576,7 +1576,7 @@ void weechat_string_free_split (char **split_string); Paramètres : -* 'split_string' : chaîne découpée par +* _split_string_ : chaîne découpée par <<_string_split,weechat_string_split>> Exemple en C : @@ -1607,9 +1607,9 @@ char *weechat_string_build_with_split_string (char **split_string Paramètres : -* 'split_string' : chaîne découpée par la fonction +* _split_string_ : chaîne découpée par la fonction <<_string_split,weechat_string_split>> -* 'separator' : chaîne utilisée pour séparer les différentes chaînes +* _separator_ : chaîne utilisée pour séparer les différentes chaînes Valeur de retour : @@ -1634,8 +1634,8 @@ Cette fonction n'est pas disponible dans l'API script. ==== string_split_command -Découper une liste de commandes séparées par 'separator' (qui peut être échappé -par "\" dans la chaîne). +Découper une liste de commandes séparées par _separator_ (qui peut être échappé +par `+\+` dans la chaîne). Prototype : @@ -1646,8 +1646,8 @@ char **weechat_string_split_command (const char *command, char separator); Paramètres : -* 'command' : commande à découper -* 'separator' : séparateur +* _command_ : commande à découper +* _separator_ : séparateur Valeur de retour : @@ -1682,7 +1682,7 @@ void weechat_string_free_split_command (char **split_command); Paramètres : -* 'split_command' : commande découpée par +* _split_command_ : commande découpée par <<_string_split_command,weechat_string_split_command>> Exemple en C : @@ -1711,7 +1711,7 @@ char *weechat_string_format_size (unsigned long long size); Paramètres : -* 'size' : taille (en octets) +* _size_ : taille (en octets) Valeur de retour : @@ -1761,8 +1761,8 @@ char *weechat_string_remove_color (const char *string, Paramètres : -* 'string' : chaîne -* 'replacement' : si non NULL et non vide, les couleurs WeeChat sont remplacées +* _string_ : chaîne +* _replacement_ : si non NULL et non vide, les couleurs WeeChat sont remplacées par le premier caractère de cette chaîne, sinon les codes couleurs WeeChat et les caractères suivants (rattachés à la couleur) sont supprimés de la chaîne @@ -1812,9 +1812,9 @@ void weechat_string_encode_base64 (const char *from, int length, char *to); Paramètres : -* 'from' : chaîne à encoder -* 'length' : longueur de chaîne à encoder (par exemple `strlen(from)`) -* 'to' : pointeur vers la chaîne pour stocker le résultat (doit être +* _from_ : chaîne à encoder +* _length_ : longueur de chaîne à encoder (par exemple `strlen(from)`) +* _to_ : pointeur vers la chaîne pour stocker le résultat (doit être suffisamment long, le résultat est plus long que la chaîne initiale) Exemple en C : @@ -1844,13 +1844,13 @@ int weechat_string_decode_base64 (const char *from, char *to); Paramètres : -* 'from' : chaîne à décoder -* 'to' : pointeur vers la chaîne pour stocker le résultat (doit être +* _from_ : chaîne à décoder +* _to_ : pointeur vers la chaîne pour stocker le résultat (doit être suffisamment long, le résultat est plus court que la chaîne initiale) Valeur de retour : -* longueur de la chaîne stockée dans *to (ne compte pas le '\0' final) +* longueur de la chaîne stockée dans _*to_ (ne compte pas le _\0_ final) Exemple en C : @@ -1881,12 +1881,12 @@ char *string_hex_dump (const char *data, int data_size, int bytes_per_line, Paramètres : -* 'data' : les données à afficher -* 'data_size' : nombre d'octets à afficher dans 'data' -* 'bytes_per_line' : nombre d'octets à afficher sur chaque ligne -* 'prefix' : le préfixe à afficher au début de chaque ligne +* _data_ : les données à afficher +* _data_size_ : nombre d'octets à afficher dans _data_ +* _bytes_per_line_ : nombre d'octets à afficher sur chaque ligne +* _prefix_ : le préfixe à afficher au début de chaque ligne (optionnel, peut être NULL) -* 'suffix' : le suffixe à afficher à la fin de chaque ligne +* _suffix_ : le suffixe à afficher à la fin de chaque ligne (optionnel, peut être NULL) Valeur de retour : @@ -1912,7 +1912,7 @@ Cette fonction n'est pas disponible dans l'API script. _WeeChat ≥ 0.3.2._ Vérifier si le premier caractère de la chaîne est un caractère de commande (le -caractère par défaut de commande est '/'). +caractère par défaut de commande est `+/+`). Prototype : @@ -1923,7 +1923,7 @@ int weechat_string_is_command_char (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -1965,7 +1965,7 @@ const char *weechat_string_input_for_buffer (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2017,31 +2017,31 @@ char *weechat_string_eval_expression (const char *expr, Paramètres : -* 'expr' : l'expression à évaluer (voir le tableau ci-dessous) -* 'pointers' : table de hachage avec les pointeurs (les clés doivent être des +* _expr_ : l'expression à évaluer (voir le tableau ci-dessous) +* _pointers_ : table de hachage avec les pointeurs (les clés doivent être des chaînes, les valeurs doivent être des pointeurs); les pointeurs "window" et "buffer" sont automatiquement ajoutés s'ils ne sont pas dans la table de hachage (avec le pointer vers fenêtre/tampon courants) (peut être NULL) : -** 'regex' : pointeur vers une expression régulière (structure 'regex_t') +** _regex_ : pointeur vers une expression régulière (structure _regex_t_) compilée avec la fonction WeeChat <<_string_regcomp,weechat_string_regcomp>> ou regcomp (voir - `man regcomp`) ; cette option est similaire à 'regex' dans la table de - hachage 'options' (ci-dessous), mais est utilisée pour de meilleures + `man regcomp`) ; cette option est similaire à _regex_ dans la table de + hachage _options_ (ci-dessous), mais est utilisée pour de meilleures performances -* 'extra_vars' : variables additionnelles qui seront étendues (peut être NULL) -* 'options' : table de hachage avec des options (les clés et valeurs doivent +* _extra_vars_ : variables additionnelles qui seront étendues (peut être NULL) +* _options_ : table de hachage avec des options (les clés et valeurs doivent être des chaînes) (peut être NULL) : -** 'type' : le comportement par défaut est de juste remplacer les valeurs dans +** _type_ : le comportement par défaut est de juste remplacer les valeurs dans l'expression, d'autres types peuvent être choisis : -*** 'condition' : l'expression est évaluée comme une condition : les opérateurs +*** _condition_ : l'expression est évaluée comme une condition : les opérateurs et parenthèses sont utilisés, le résultat est un booléen ("0" ou "1") -** 'prefix' : préfixe avant les variables à remplacer (par défaut : "${") -** 'suffix' : suffixe après les variables à remplacer (par défaut : "}") -** 'regex' : une expression regulière pour remplacer du texte dans 'expr' (qui +** _prefix_ : préfixe avant les variables à remplacer (par défaut : `+${+`) +** _suffix_ : suffixe après les variables à remplacer (par défaut : `+}+`) +** _regex_ : une expression regulière pour remplacer du texte dans _expr_ (qui n'est alors pas évalué) -** 'regex_replace' : le texte de remplacement à utiliser avec 'regex', pour - remplacer du texte dans 'expr' ('regex_replace' est évalué sur chaque - correspondance de 'regex' sur 'expr', jusqu'à ce que plus aucune +** _regex_replace_ : le texte de remplacement à utiliser avec _regex_, pour + remplacer du texte dans _expr_ (_regex_replace_ est évalué sur chaque + correspondance de _regex_ sur _expr_, jusqu'à ce que plus aucune correspondance ne soit trouvée) Valeur de retour : @@ -2057,7 +2057,7 @@ première étendue à la dernière) : |=== | Format | Description | Exemples | Résultats -| `${nom}` | Variable `nom` de la table de hachage 'extra_vars' | +| `${nom}` | Variable `nom` de la table de hachage _extra_vars_ | `${nom}` | `valeur` | `${eval:xxx}` + @@ -2081,8 +2081,8 @@ première étendue à la dernière) : `************` | `${re:N}` | - Groupe regex capturé : 0 = toute la chaîne correspondante, 1 à 99 = groupe - capturé, `+` = dernier groupe capturé | + Groupe regex capturé : `0` = toute la chaîne correspondante, + `1` à `99` = groupe capturé, `+++` = dernier groupe capturé | `${re:1}` | `test` @@ -2227,7 +2227,7 @@ int weechat_utf8_has_8bits (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2262,10 +2262,10 @@ int weechat_utf8_is_valid (const char *string, int length, char **error); Paramètres : -* 'string' : chaîne -* 'length' : nombre maximum de caractères UTF-8 à vérifier ; si ≤ 0, la chaîne +* _string_ : chaîne +* _length_ : nombre maximum de caractères UTF-8 à vérifier ; si ≤ 0, la chaîne complète est vérifiée _(WeeChat ≥ 1.4)_ -* 'error' : si non NULL, '*error' est alimenté avec le pointeur vers le premier +* _error_ : si non NULL, _*error_ est alimenté avec le pointeur vers le premier caractère non valide dans la chaîne, s'il y en a Valeur de retour : @@ -2304,8 +2304,8 @@ void weechat_utf8_normalize (char *string, char replacement); Paramètres : -* 'string' : chaîne -* 'replacement' : caractère de remplacement pour les caractères non valides +* _string_ : chaîne +* _replacement_ : caractère de remplacement pour les caractères non valides Exemple en C : @@ -2333,16 +2333,16 @@ const char *weechat_utf8_prev_char (const char *string_start, Paramètres : -* 'string_start' : début de la chaîne (la fonction ne retournera pas un +* _string_start_ : début de la chaîne (la fonction ne retournera pas un caractère situé avant ce pointeur) -* 'string' : pointeur vers la chaîne (doit être ≥ 'string_start') +* _string_ : pointeur vers la chaîne (doit être ≥ _string_start_) Valeur de retour : * pointeur vers le caractère UTF-8 précédent, NULL si non trouvé (début de chaîne atteint) - (_WeeChat ≥ 1.3_ : le pointeur retourné est un 'const char *' au lieu d'un - 'char *') + (_WeeChat ≥ 1.3_ : le pointeur retourné est un _const char *_ au lieu d'un + _char *_) Exemple en C : @@ -2369,14 +2369,14 @@ const char *weechat_utf8_next_char (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : * pointeur vers le caractère UTF-8 suivant, NULL si non trouvé (fin de la chaîne atteinte) - (_WeeChat ≥ 1.3_ : le pointeur retourné est un 'const char *' au lieu d'un - 'char *') + (_WeeChat ≥ 1.3_ : le pointeur retourné est un _const char *_ au lieu d'un + _char *_) Exemple en C : @@ -2401,7 +2401,7 @@ int weechat_utf8_char_int (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2430,7 +2430,7 @@ int weechat_utf8_char_size (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2459,7 +2459,7 @@ int weechat_utf8_strlen (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2478,7 +2478,7 @@ Cette fonction n'est pas disponible dans l'API script. ==== utf8_strnlen Retourner la taille d'une chaîne UTF-8 (en nombre de caractères UTF-8), pour au -maximum 'bytes' octets dans la chaîne. +maximum _bytes_ octets dans la chaîne. Prototype : @@ -2489,8 +2489,8 @@ int weechat_utf8_strnlen (const char *string, int bytes); Paramètres : -* 'string' : chaîne -* 'bytes' : nombre maximum d'octets +* _string_ : chaîne +* _bytes_ : nombre maximum d'octets Valeur de retour : @@ -2520,7 +2520,7 @@ int weechat_utf8_strlen_screen (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2551,8 +2551,8 @@ int weechat_utf8_charcmp (const char *string1, const char *string2); Paramètres : -* 'string1' : première chaîne pour la comparaison -* 'string2' : seconde chaîne pour la comparaison +* _string1_ : première chaîne pour la comparaison +* _string2_ : seconde chaîne pour la comparaison Valeur de retour : @@ -2585,8 +2585,8 @@ int weechat_utf8_charcasecmp (const char *string1, const char *string2); Paramètres : -* 'string1' : première chaîne pour la comparaison -* 'string2' : seconde chaîne pour la comparaison +* _string1_ : première chaîne pour la comparaison +* _string2_ : seconde chaîne pour la comparaison Valeur de retour : @@ -2618,7 +2618,7 @@ int weechat_utf8_char_size_screen (const char *string); Paramètres : -* 'string' : chaîne +* _string_ : chaîne Valeur de retour : @@ -2649,15 +2649,15 @@ const char *weechat_utf8_add_offset (const char *string, int offset); Paramètres : -* 'string' : chaîne -* 'offset' : nombre de caractères +* _string_ : chaîne +* _offset_ : nombre de caractères Valeur de retour : * pointeur vers la chaîne, N caractères après (NULL s'il est impossible d'atteindre cette position dans la chaîne) - (_WeeChat ≥ 1.3_ : le pointeur retourné est un 'const char *' au lieu d'un - 'char *') + (_WeeChat ≥ 1.3_ : le pointeur retourné est un _const char *_ au lieu d'un + _char *_) Exemple en C : @@ -2683,8 +2683,8 @@ int weechat_utf8_real_pos (const char *string, int pos); Paramètres : -* 'string' : chaîne -* 'pos' : position (en nombre de caractères) +* _string_ : chaîne +* _pos_ : position (en nombre de caractères) Valeur de retour : @@ -2713,8 +2713,8 @@ int weechat_utf8_pos (const char *string, int real_pos); Paramètres : -* 'string' : chaîne -* 'real_pos' : position (en octets) +* _string_ : chaîne +* _real_pos_ : position (en octets) Valeur de retour : @@ -2732,7 +2732,7 @@ Cette fonction n'est pas disponible dans l'API script. ==== utf8_strndup -Retourner une chaîne dupliquée, avec au plus 'length' caractères. +Retourner une chaîne dupliquée, avec au plus _length_ caractères. Prototype : @@ -2743,8 +2743,8 @@ char *weechat_utf8_strndup (const char *string, int length); Paramètres : -* 'string' : chaîne -* 'length' : nombre maximum de caractères à dupliquer +* _string_ : chaîne +* _length_ : nombre maximum de caractères à dupliquer Valeur de retour : @@ -2781,8 +2781,8 @@ int weechat_mkdir_home (char *directory, int mode); Paramètres : -* 'directory' : nom du répertoire à créer -* 'mode' : mode pour le répertoire +* _directory_ : nom du répertoire à créer +* _mode_ : mode pour le répertoire Valeur de retour : @@ -2822,8 +2822,8 @@ int weechat_mkdir (char *directory, int mode); Paramètres : -* 'directory' : nom du répertoire à créer -* 'mode' : mode pour le répertoire +* _directory_ : nom du répertoire à créer +* _mode_ : mode pour le répertoire Valeur de retour : @@ -2863,8 +2863,8 @@ int weechat_mkdir_parents (char *directory, int mode); Paramètres : -* 'directory' : nom du répertoire à créer -* 'mode' : mode pour le répertoire +* _directory_ : nom du répertoire à créer +* _mode_ : mode pour le répertoire Valeur de retour : @@ -2911,12 +2911,12 @@ void weechat_exec_on_files (const char *directory, Paramètres : -* 'directory' : répertoire où chercher les fichiers -* 'hidden_files' : 1 pour inclure les fichiers cachés, sinon 0 -* 'callback' : fonction appelée pour chaque fichier trouvé, paramètres : -** 'void *data' : pointeur -** 'const char *filename' : nom de fichier trouvé -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _directory_ : répertoire où chercher les fichiers +* _hidden_files_ : 1 pour inclure les fichiers cachés, sinon 0 +* _callback_ : fonction appelée pour chaque fichier trouvé, paramètres : +** _void *data_ : pointeur +** _const char *filename_ : nom de fichier trouvé +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat Exemple en C : @@ -2949,7 +2949,7 @@ char *weechat_file_get_content (const char *filename); Paramètres : -* 'filename' : chemin et nom du fichier +* _filename_ : chemin et nom du fichier Valeur de retour : @@ -2988,8 +2988,8 @@ int weechat_util_timeval_cmp (struct timeval *tv1, struct timeval *tv2); Paramètres : -* 'tv1' : première structure "timeval" -* 'tv2' : seconde structure "timeval" +* _tv1_ : première structure "timeval" +* _tv2_ : seconde structure "timeval" Valeur de retour : @@ -3025,8 +3025,8 @@ long long weechat_util_timeval_diff (struct timeval *tv1, struct timeval *tv2); Paramètres : -* 'tv1' : première structure "timeval" -* 'tv2' : seconde structure "timeval" +* _tv1_ : première structure "timeval" +* _tv2_ : seconde structure "timeval" Valeur de retour : @@ -3060,8 +3060,8 @@ void weechat_util_timeval_add (struct timeval *tv, long long interval); Paramètres : -* 'tv' : structure "timeval" -* 'interval' : intervalle (en microsecondes) +* _tv_ : structure "timeval" +* _interval_ : intervalle (en microsecondes) [NOTE] Avec WeeChat ≤ 1.0, l'intervalle était exprimé en millisecondes. @@ -3081,7 +3081,7 @@ Cette fonction n'est pas disponible dans l'API script. _WeeChat ≥ 0.3.2, mise à jour dans la 1.3._ Retourner la date/heure sous forme de chaîne construite avec "strftime" et le -format défini dans l'option 'weechat.look.time_format'. +format défini dans l'option _weechat.look.time_format_. Prototype : @@ -3092,7 +3092,7 @@ const char *weechat_util_get_time_string (const time_t *date); Paramètres : -* 'date' : pointeur vers la date +* _date_ : pointeur vers la date Valeur de retour : @@ -3125,7 +3125,7 @@ int weechat_util_version_number (const char *version); Paramètres : -* 'version' : version WeeChat sous forme de chaîne (exemple : "0.3.9" ou +* _version_ : version WeeChat sous forme de chaîne (exemple : "0.3.9" ou "0.3.9-dev") Exemple en C : @@ -3195,13 +3195,13 @@ struct t_weelist_item *weechat_list_add (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'data' : donnée à insérer dans la liste -* 'where' : position dans la liste : -** 'WEECHAT_LIST_POS_SORT' : ajout dans la liste, en gardant la liste triée -** 'WEECHAT_LIST_POS_BEGINNING' : ajout en début de liste -** 'WEECHAT_LIST_POS_END' : ajout en fin de liste -* 'user_data' : un pointeur quelconque +* _weelist_ : pointeur vers la liste +* _data_ : donnée à insérer dans la liste +* _where_ : position dans la liste : +** _WEECHAT_LIST_POS_SORT_ : ajout dans la liste, en gardant la liste triée +** _WEECHAT_LIST_POS_BEGINNING_ : ajout en début de liste +** _WEECHAT_LIST_POS_END_ : ajout en fin de liste +* _user_data_ : un pointeur quelconque Valeur de retour : @@ -3240,8 +3240,8 @@ struct t_weelist_item *weechat_list_search (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'data' : donnée à chercher dans la liste +* _weelist_ : pointeur vers la liste +* _data_ : donnée à chercher dans la liste Valeur de retour : @@ -3281,8 +3281,8 @@ int weechat_list_search_pos (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'data' : donnée à chercher dans la liste +* _weelist_ : pointeur vers la liste +* _data_ : donnée à chercher dans la liste Valeur de retour : @@ -3320,8 +3320,8 @@ struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'data' : données à chercher dans la liste +* _weelist_ : pointeur vers la liste +* _data_ : données à chercher dans la liste Valeur de retour : @@ -3362,8 +3362,8 @@ int weechat_list_casesearch_pos (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'data' : données à chercher dans la liste +* _weelist_ : pointeur vers la liste +* _data_ : données à chercher dans la liste Valeur de retour : @@ -3401,8 +3401,8 @@ struct t_weelist_item *weechat_list_get (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'position' : position dans la liste (le premier élément est 0) +* _weelist_ : pointeur vers la liste +* _position_ : position dans la liste (le premier élément est 0) Valeur de retour : @@ -3439,8 +3439,8 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); Paramètres : -* 'item' : pointeur vers l'élément -* 'value' : nouvelle valeur pour l'élément +* _item_ : pointeur vers l'élément +* _value_ : nouvelle valeur pour l'élément Exemple en C : @@ -3473,7 +3473,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); Paramètres : -* 'item' : pointeur vers l'élément +* _item_ : pointeur vers l'élément Valeur de retour : @@ -3511,7 +3511,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); Paramètres : -* 'item' : pointeur vers l'élément +* _item_ : pointeur vers l'élément Valeur de retour : @@ -3549,7 +3549,7 @@ const char *weechat_list_string (struct t_weelist_item *item); Paramètres : -* 'item' : pointeur vers l'élément +* _item_ : pointeur vers l'élément Valeur de retour : @@ -3586,7 +3586,7 @@ char *weechat_list_size (struct t_weelist *weelist); Paramètres : -* 'weelist' : pointeur vers la liste +* _weelist_ : pointeur vers la liste Valeur de retour : @@ -3624,8 +3624,8 @@ void weechat_list_remove (struct t_weelist *weelist, Paramètres : -* 'weelist' : pointeur vers la liste -* 'item' : pointeur vers l'élément +* _weelist_ : pointeur vers la liste +* _item_ : pointeur vers l'élément Exemple en C : @@ -3658,7 +3658,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); Paramètres : -* 'weelist' : pointeur vers la liste +* _weelist_ : pointeur vers la liste Exemple en C : @@ -3691,7 +3691,7 @@ void weechat_list_free (struct t_weelist *weelist); Paramètres : -* 'weelist' : pointeur vers la liste +* _weelist_ : pointeur vers la liste Exemple en C : @@ -3738,39 +3738,39 @@ struct t_hashtable *weechat_hashtable_new (int size, Paramètres : -* 'size' : taille du tableau interne pour stocker les clés sous forme de +* _size_ : taille du tableau interne pour stocker les clés sous forme de hachage, une grande valeur utilise plus de mémoire mais présente une meilleure performance (cela n'est *pas* une limite sur le nombre d'entrées de la table de hachage) -* 'type_keys' : type pour les clés dans la table de hachage : -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'type_values' : type pour les valeurs dans la table de hachage : -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'callback_hash_key' : fonction appelée pour rendre le hachage d'une clé (la +* _type_keys_ : type pour les clés dans la table de hachage : +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _type_values_ : type pour les valeurs dans la table de hachage : +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _callback_hash_key_ : fonction appelée pour rendre le hachage d'une clé (la clé sous forme de nombre entier), peut être NULL si le type de clé n'est pas "buffer" (une fonction de hachage par défaut est utilisée), paramètres et valeur de retour : -** 'struct t_hashtable *hashtable' : pointeur vers la table de hachage -** 'const void *key' : clé +** _struct t_hashtable *hashtable_ : pointeur vers la table de hachage +** _const void *key_ : clé ** valeur de retour : hachage de la clé -* 'callback_keycmp' : fonction appelée pour comparer deux clés, peut être NULL +* _callback_keycmp_ : fonction appelée pour comparer deux clés, peut être NULL si le type de clé n'est pas "buffer" (une fonction de comparaison par défaut est utilisée), paramètres et valeur de retour : -** 'struct t_hashtable *hashtable' : pointeur vers la table de hachage -** 'const void *key1' : première clé -** 'const void *key2' : seconde clé +** _struct t_hashtable *hashtable_ : pointeur vers la table de hachage +** _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' +*** 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 : @@ -3808,12 +3808,12 @@ struct t_hashtable_item *weechat_hashtable_set_with_size (struct t_hashtable *ha Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'key' : pointeur vers la clé -* 'key_size' : taille de la clé (en octets), utilisée seulement si le type de +* _hashtable_ : pointeur vers la table de hachage +* _key_ : pointeur vers la clé +* _key_size_ : taille de la clé (en octets), utilisée seulement si le type de clés dans la table de hachage est "buffer" -* 'value' : pointeur vers la valeur -* 'value_size' : taille de la valeur (en octets), utilisée seulement si le type +* _value_ : pointeur vers la valeur +* _value_size_ : taille de la valeur (en octets), utilisée seulement si le type de valeurs dans la table de hachage est "buffer" Valeur de retour : @@ -3847,9 +3847,9 @@ struct t_hashtable_item *weechat_hashtable_set (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'key' : pointeur vers la clé -* 'value' : pointeur vers la valeur +* _hashtable_ : pointeur vers la table de hachage +* _key_ : pointeur vers la clé +* _value_ : pointeur vers la valeur Valeur de retour : @@ -3880,8 +3880,8 @@ void *weechat_hashtable_get (struct t_hashtable *hashtable, void *key); Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'key' : pointeur vers la clé +* _hashtable_ : pointeur vers la table de hachage +* _key_ : pointeur vers la clé Valeur de retour : @@ -3912,8 +3912,8 @@ int weechat_hashtable_has_key (struct t_hashtable *hashtable, void *key); Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'key' : pointeur vers la clé +* _hashtable_ : pointeur vers la table de hachage +* _key_ : pointeur vers la clé Valeur de retour : @@ -3954,9 +3954,9 @@ void weechat_hashtable_map (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'callback_map' : fonction appelée pour chaque entrée de la table de hachage -* 'callback_map_data' : pointeur donné au "callback" lorsqu'il est appelé +* _hashtable_ : pointeur vers la table de hachage +* _callback_map_ : fonction appelée pour chaque entrée de la table de hachage +* _callback_map_data_ : pointeur donné au "callback" lorsqu'il est appelé Exemple en C : @@ -3999,12 +3999,12 @@ void weechat_hashtable_map_string (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'callback_map' : fonction appelée pour chaque entrée de la table de hachage -* 'callback_map_data' : pointeur donné au "callback" lorsqu'il est appelé +* _hashtable_ : pointeur vers la table de hachage +* _callback_map_ : fonction appelée pour chaque entrée de la table de hachage +* _callback_map_data_ : pointeur donné au "callback" lorsqu'il est appelé [NOTE] -Les chaînes 'key' et 'value' envoyées au "callback" sont des chaînes +Les chaînes _key_ et _value_ envoyées au "callback" sont des chaînes temporaires, elles sont supprimées après l'appel au "callback". Exemple en C : @@ -4041,7 +4041,7 @@ struct t_hashtable *weechat_hashtable_dup (struct t_hashtable *hashtable); Paramètres : -* 'hashtable' : pointeur vers la table de hachage +* _hashtable_ : pointeur vers la table de hachage Valeur de retour : @@ -4073,10 +4073,10 @@ int weechat_hashtable_get_integer (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'property' : nom de propriété : -** 'size' : taille du tableau interne "htable" dans la table de hachage -** 'items_count' : nombre d'éléments dans la table de hachage +* _hashtable_ : pointeur vers la table de hachage +* _property_ : nom de propriété : +** _size_ : taille du tableau interne "htable" dans la table de hachage +** _items_count_ : nombre d'éléments dans la table de hachage Valeur de retour : @@ -4109,28 +4109,28 @@ const char *weechat_hashtable_get_string (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'property' : nom de la propriété : -** 'type_keys' : type pour les clés : -*** 'integer' : entier -*** 'string' : chaîne -*** 'pointer' : pointeur -*** 'buffer' : buffer -*** 'time' : heure -** 'type_values' : type pour les valeurs : -*** 'integer' : entier -*** 'string' : chaîne -*** 'pointer' : pointeur -*** 'buffer' : buffer -*** 'time' : heure -** 'keys' : chaîne avec la liste des clés (format : "clé1,clé2,clé3") -** 'keys_sorted' : chaîne avec la liste triée des clés (format : +* _hashtable_ : pointeur vers la table de hachage +* _property_ : nom de la propriété : +** _type_keys_ : type pour les clés : +*** _integer_ : entier +*** _string_ : chaîne +*** _pointer_ : pointeur +*** _buffer_ : buffer +*** _time_ : heure +** _type_values_ : type pour les valeurs : +*** _integer_ : entier +*** _string_ : chaîne +*** _pointer_ : pointeur +*** _buffer_ : buffer +*** _time_ : heure +** _keys_ : chaîne avec la liste des clés (format : "clé1,clé2,clé3") +** _keys_sorted_ : chaîne avec la liste triée des clés (format : "clé1,clé2,clé3") -** 'values' : chaîne avec la liste des valeurs (format : +** _values_ : chaîne avec la liste des valeurs (format : "valeur1,valeur2,valeur3") -** 'keys_values' : chaîne avec la liste des clés et valeurs +** _keys_values_ : chaîne avec la liste des clés et valeurs (format : "clé1:valeur1,clé2:valeur2,clé3:valeur3") -** 'keys_values_sorted' : chaîne avec la liste des clés et valeurs (triée sur +** _keys_values_sorted_ : chaîne avec la liste des clés et valeurs (triée sur les clés) (format : "clé1:valeur1,clé2:valeur2,clé3:valeur3") Valeur de retour : @@ -4166,13 +4166,13 @@ void weechat_hashtable_set_pointer (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'property' : nom de la propriété : -** 'callback_free_key' : définit la fonction "callback" pour supprimer les clés +* _hashtable_ : pointeur vers la table de hachage +* _property_ : nom de la propriété : +** _callback_free_key_ : définit la fonction "callback" pour supprimer les clés de la table de hachage _(WeeChat ≥ 0.4.2)_ -** 'callback_free_value' : définit la fonction "callback" pour supprimer les +** _callback_free_value_ : définit la fonction "callback" pour supprimer les valeurs de la table de hachage -* 'pointer' : nouvelle valeur de pointeur pour la propriété +* _pointer_ : nouvelle valeur de pointeur pour la propriété Exemple en C : @@ -4214,9 +4214,9 @@ int weechat_hashtable_add_to_infolist (struct t_hashtable *hashtable, Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'infolist_item' : pointeur vers l'objet de l'infolist -* 'prefix' : chaîne utilisée comme préfixe pour les noms dans l'infolist +* _hashtable_ : pointeur vers la table de hachage +* _infolist_item_ : pointeur vers l'objet de l'infolist +* _prefix_ : chaîne utilisée comme préfixe pour les noms dans l'infolist Valeur de retour : @@ -4257,8 +4257,8 @@ void weechat_hashtable_remove (struct t_hashtable *hashtable, const void *key); Paramètres : -* 'hashtable' : pointeur vers la table de hachage -* 'key' : pointeur vers la clé +* _hashtable_ : pointeur vers la table de hachage +* _key_ : pointeur vers la clé Exemple en C : @@ -4285,7 +4285,7 @@ void weechat_hashtable_remove_all (struct t_hashtable *hashtable); Paramètres : -* 'hashtable' : pointeur vers la table de hachage +* _hashtable_ : pointeur vers la table de hachage Exemple en C : @@ -4312,7 +4312,7 @@ void weechat_hashtable_free (struct t_hashtable *hashtable); Paramètres : -* 'hashtable' : pointeur vers la table de hachage +* _hashtable_ : pointeur vers la table de hachage Exemple en C : @@ -4349,21 +4349,21 @@ struct t_config_file *weechat_config_new (const char *name, Paramètres : -* 'name' : nom du nouveau fichier de configuration (sans chemin ou extension) -* 'callback_reload' : fonction appelée quand le fichier de configuration est +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_file *config_file' : pointeur vers le fichier de +** _const void *pointer_ : pointeur +** _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_pointer' : pointeur donné au "callback" de rechargement +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_reload_pointer_ : pointeur donné au "callback" de rechargement lorsqu'il est appelé par WeeChat -* 'callback_reload_data' : pointeur donné au "callback" lorsqu'il est appelé +* _callback_reload_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le fichier de configuration est libéré @@ -4466,102 +4466,102 @@ struct t_config_section *weechat_config_new_section ( Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'name' : nom de la section -* 'user_can_add_options' : 1 si l'utilisateur peut créer de nouvelles options +* _config_file_ : pointeur vers le fichier de configuration +* _name_ : nom de la section +* _user_can_add_options_ : 1 si l'utilisateur peut créer de nouvelles options dans la section, ou 0 si c'est interdit -* 'user_can_delete_options' : 1 si l'utilisateur peut supprimer des options +* _user_can_delete_options_ : 1 si l'utilisateur peut supprimer des options dans la section, ou 0 si c'est interdit -* 'callback_read' : fonction appelée quand une option de la section est lue +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_file *config_file' : pointeur vers le fichier de +** _const void *pointer_ : pointeur +** _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 +** _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_pointer' : pointeur donné au "callback" quand il est appelé +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_read_pointer_ : pointeur donné au "callback" quand il est appelé par WeeChat -* 'callback_read_data' : pointeur donné au "callback" lorsqu'il est appelé +* _callback_read_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque la section est libérée -* 'callback_write' : fonction appelée lorsque la section est écrite dans le +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_file *config_file' : pointeur vers le fichier de +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_config_file *config_file_ : pointeur vers le fichier de configuration -** 'const char *section_name' : nom de la section +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_write_data' : pointeur donné au "callback" lorsqu'il est appelé +* _callback_write_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque la section est libérée -* 'callback_write_default' : fonction appelée lorsque les valeurs par défaut +* _callback_write_default_ : fonction appelée lorsque les valeurs par défaut doivent être écrites dans le fichier, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_file *config_file' : pointeur vers le fichier de +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_config_file *config_file_ : pointeur vers le fichier de configuration -** 'const char *section_name' : nom de la section +** _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_pointer' : pointeur donné au "callback" lorsqu'il est +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_default_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_write_default_data' : pointeur donné au "callback" lorsqu'il est +* _callback_write_default_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque la section est libérée -* 'callback_create_option' : fonction appelée lorsqu'une nouvelle option est +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_file *config_file' : pointeur vers le fichier de +** _const void *pointer_ : pointeur +** _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 -* 'callback_create_option_pointer' : pointeur donné au "callback" lorsqu'il est +** _struct t_config_section *section_ : pointeur vers la section +** _const char *option_name_ : nom de l'option +** _const char *value_ : valeur +* _callback_create_option_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_create_option_data' : pointeur donné au "callback" lorsqu'il est +* _callback_create_option_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque la section est libérée -* 'callback_delete_option' : fonction appelée lorsqu'une option est supprimée +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_file *config_file' : pointeur vers le fichier de +** _const void *pointer_ : pointeur +** _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 +** _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_pointer' : pointeur donné au "callback" lorsqu'il est +*** _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_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_delete_option_data' : pointeur donné au "callback" lorsqu'il est +* _callback_delete_option_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque la section est libérée @@ -4721,8 +4721,8 @@ struct t_config_section *weechat_config_search_section ( Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'section_name' : nom de la section à chercher +* _config_file_ : pointeur vers le fichier de configuration +* _section_name_ : nom de la section à chercher Valeur de retour : @@ -4789,61 +4789,61 @@ struct t_config_option *weechat_config_new_option ( Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'section' : pointeur vers la section -* 'name' : nom de l'option ; avec WeeChat ≥ 1.4, le nom peut inclure le nom +* _config_file_ : pointeur vers le fichier de configuration +* _section_ : pointeur vers la section +* _name_ : nom de l'option ; avec WeeChat ≥ 1.4, le nom peut inclure le nom d'une option parente (la valeur de l'option parente sera affichée dans la sortie de `/set` si cette option est "null"), la syntaxe est alors : "name << file.section.option" -* 'type' : type de l'option : -** 'boolean' : valeur booléenne (on/off) -** 'integer' : valeur entière (avec en option une chaîne pour chaque valeur) -** 'string' : une chaîne de caractères -** 'color' : une couleur -* 'description' : description de l'option -* 'string_values' : valeurs sous forme de chaîne (séparées par "|"), utilisées - pour le type 'integer' (optionnel) -* 'min' : valeur minimum (pour le type 'integer') -* 'max' : valeur maximum (pour le type 'integer') -* 'default_value' : valeur par défaut de l'option (utilisée quand l'option est +* _type_ : type de l'option : +** _boolean_ : valeur booléenne (on/off) +** _integer_ : valeur entière (avec en option une chaîne pour chaque valeur) +** _string_ : une chaîne de caractères +** _color_ : une couleur +* _description_ : description de l'option +* _string_values_ : valeurs sous forme de chaîne (séparées par `+|+`), utilisées + pour le type _integer_ (optionnel) +* _min_ : valeur minimum (pour le type _integer_) +* _max_ : valeur maximum (pour le type _integer_) +* _default_value_ : valeur par défaut de l'option (utilisée quand l'option est réinitialisée) -* 'value' : valeur de l'option -* 'null_value_allowed' : 1 si 'null' (valeur non définie) est autorisé pour +* _value_ : valeur de l'option +* _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 +* _callback_check_value_ : fonction appelée pour vérifier la nouvelle valeur de l'option (optionnel), paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_option *option' : pointeur vers l'option -** 'const char *value' : nouvelle valeur pour l'option +** _const void *pointer_ : pointeur +** _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_pointer' : pointeur donné au "callback" lorsqu'il est +* _callback_check_value_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_check_value_data' : pointeur donné au "callback" lorsqu'il est +* _callback_check_value_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque l'option est libérée -* 'callback_change' : fonction appelée lorsque la valeur de l'option a changé +* _callback_change_ : fonction appelée lorsque la valeur de l'option a changé (optionnel), paramètres : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_option *option' : pointeur vers l'option -* 'callback_change_pointer' : pointeur donné au "callback" lorsqu'il est appelé +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_config_option *option_ : pointeur vers l'option +* _callback_change_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_change_data' : pointeur donné au "callback" lorsqu'il est appelé +* _callback_change_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque l'option est libérée -* 'callback_delete' : fonction appelée lorsque l'option est supprimée +* _callback_delete_ : fonction appelée lorsque l'option est supprimée (optionnel), paramètres : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_config_option *option' : pointeur vers l'option -* 'callback_delete_pointer' : pointeur donné au "callback" lorsqu'il est appelé +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_config_option *option_ : pointeur vers l'option +* _callback_delete_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_delete_data' : pointeur donné au "callback" lorsqu'il est appelé +* _callback_delete_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque l'option est libérée @@ -4986,7 +4986,7 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color", [NOTE] En Ruby, les 3 "callbacks" + "data" (6 chaînes) doivent être données dans un tableau de 6 chaînes de caractères (en raison d'une limitation de Ruby à 15 -paramètres par fonction), voir le 'Guide pour Scripts WeeChat' pour plus d'infos +paramètres par fonction), voir le _Guide pour Scripts WeeChat_ pour plus d'infos _(corrigé dans la version 0.4.1)_. ==== config_search_option @@ -5005,9 +5005,9 @@ struct t_config_option *weechat_config_search_option ( Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'section' : pointeur vers la section -* 'name' : nom de l'option à rechercher +* _config_file_ : pointeur vers le fichier de configuration +* _section_ : pointeur vers la section +* _name_ : nom de l'option à rechercher Valeur de retour : @@ -5050,12 +5050,12 @@ void weechat_config_search_section_option (struct t_config_file *config_file, Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'section' : pointeur vers la section -* 'option_name' : nom de l'option -* 'section' : pointeur vers un pointeur sur une section, sera alimenté avec le +* _config_file_ : pointeur vers le fichier de configuration +* _section_ : pointeur vers la section +* _option_name_ : nom de l'option +* _section_ : pointeur vers un pointeur sur une section, sera alimenté avec le pointeur vers la section de l'option trouvée -* 'option' : pointeur vers un pointeur sur une option, sera alimenté avec le +* _option_ : pointeur vers un pointeur sur une option, sera alimenté avec le pointeur vers l'option trouvée Exemple en C : @@ -5101,15 +5101,15 @@ void weechat_config_search_with_string (const char *option_name, Paramètres : -* 'option_name' : nom complet de l'option (format : "fichier.section.option") -* 'config_file' : pointeur vers un pointeur sur un fichier de configuration, +* _option_name_ : nom complet de l'option (format : "fichier.section.option") +* _config_file_ : pointeur vers un pointeur sur un fichier de configuration, sera alimenté avec le pointeur vers le fichier de configuration de l'option trouvée -* 'section' : pointeur vers un pointeur sur une section, sera alimenté avec le +* _section_ : pointeur vers un pointeur sur une section, sera alimenté avec le pointeur vers la section de l'option trouvée -* 'option' : pointeur vers un pointeur sur une option, sera alimenté avec le +* _option_ : pointeur vers un pointeur sur une option, sera alimenté avec le pointeur vers l'option trouvée -* 'pos_option_name' : pointeur vers un pointeur sur une chaîne, sera alimenté +* _pos_option_name_ : pointeur vers un pointeur sur une chaîne, sera alimenté avec le pointeur vers le nom de l'option trouvée Exemple en C : @@ -5152,7 +5152,7 @@ int weechat_config_string_to_boolean (const char *text); Paramètres : -* 'text' : texte à analyser +* _text_ : texte à analyser Valeur de retour : @@ -5199,16 +5199,16 @@ int weechat_config_option_reset (struct t_config_option *option, Paramètres : -* 'option' : pointeur vers l'option -* 'run_callback' : 1 pour appeler le "callback" si la valeur de l'option est +* _option_ : pointeur vers l'option +* _run_callback_ : 1 pour appeler le "callback" si la valeur de l'option est changée, sinon 0 Valeur de retour : -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' si la valeur de l'option a été +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ si la valeur de l'option a été réinitialisée -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' si la valeur n'a pas changé -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' en cas d'erreur +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ si la valeur n'a pas changé +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ en cas d'erreur Exemple en C : @@ -5259,16 +5259,16 @@ int weechat_config_option_set (struct t_config_option *option, Paramètres : -* 'option' : pointeur vers l'option -* 'value' : nouvelle valeur pour l'option -* 'run_callback' : 1 pour appeler le "callback" si la valeur de l'option est +* _option_ : pointeur vers l'option +* _value_ : nouvelle valeur pour l'option +* _run_callback_ : 1 pour appeler le "callback" si la valeur de l'option est changée, sinon 0 Valeur de retour : -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' si la valeur de l'option a été changée -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' si la valeur n'a pas changé -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' en cas d'erreur +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ si la valeur de l'option a été changée +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ si la valeur n'a pas changé +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ en cas d'erreur Exemple en C : @@ -5319,8 +5319,8 @@ int weechat_config_option_set_null (struct t_config_option *option, Paramètres : -* 'option' : pointeur vers l'option -* 'run_callback' : 1 pour appeler le "callback" si la valeur de l'option est +* _option_ : pointeur vers l'option +* _run_callback_ : 1 pour appeler le "callback" si la valeur de l'option est changée (elle n'était pas "null"), sinon 0 [NOTE] @@ -5329,9 +5329,9 @@ l'option (voir <<_config_new_option,weechat_config_new_option>>). Valeur de retour : -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' si la valeur de l'option a été changée -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' si la valeur n'a pas changé -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' en cas d'erreur +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ si la valeur de l'option a été changée +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ si la valeur n'a pas changé +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ en cas d'erreur Exemple en C : @@ -5381,16 +5381,16 @@ int weechat_config_option_unset (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour : -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' si la valeur de l'option n'a pas +* _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ si la valeur de l'option n'a pas été réinitialisée -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' si la valeur de l'option a été +* _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ si la valeur de l'option a été réinitialisée -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' si l'option a été supprimée -* 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' en cas d'erreur +* _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ si l'option a été supprimée +* _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ en cas d'erreur Exemple en C : @@ -5446,8 +5446,8 @@ void weechat_config_option_rename (struct t_config_option *option, Paramètres : -* 'option' : pointeur vers l'option -* 'new_name' : nouveau nom pour l'option +* _option_ : pointeur vers l'option +* _new_name_ : nouveau nom pour l'option Exemple en C : @@ -5481,24 +5481,24 @@ void *weechat_config_option_get_pointer (struct t_config_option *option, Paramètres : -* 'option' : pointeur vers l'option -* 'property' : nom de la propriété : -** 'config_file' : pointeur vers le fichier de configuration - ('struct t_config_file *') -** 'section' : pointeur vers la section ('struct t_config_section *') -** 'name' : nom de l'option ('char *') -** 'parent_name' : nom de l'option parente ('char *') _(WeeChat ≥ 1.4)_ -** 'type' : type de l'option ('int *') -** 'description' : description de l'option ('char *') -** 'string_values' : valeurs sous forme de chaîne ('char *') -** 'min' : valeur minimum ('int *') -** 'max' : valeur maximum ('int *') -** 'default_value' : valeur par défaut (dépend du type) -** 'value' : valeur courante (dépend du type) -** 'prev_option' : pointeur vers l'option précédente - ('struct t_config_option *') -** 'next_option' : pointeur vers l'option suivante - ('struct t_config_option *') +* _option_ : pointeur vers l'option +* _property_ : nom de la propriété : +** _config_file_ : pointeur vers le fichier de configuration + (_struct t_config_file *_) +** _section_ : pointeur vers la section (_struct t_config_section *_) +** _name_ : nom de l'option (_char *_) +** _parent_name_ : nom de l'option parente (_char *_) _(WeeChat ≥ 1.4)_ +** _type_ : type de l'option (_int *_) +** _description_ : description de l'option (_char *_) +** _string_values_ : valeurs sous forme de chaîne (_char *_) +** _min_ : valeur minimum (_int *_) +** _max_ : valeur maximum (_int *_) +** _default_value_ : valeur par défaut (dépend du type) +** _value_ : valeur courante (dépend du type) +** _prev_option_ : pointeur vers l'option précédente + (_struct t_config_option *_) +** _next_option_ : pointeur vers l'option suivante + (_struct t_config_option *_) Valeur de retour : @@ -5527,7 +5527,7 @@ int weechat_config_option_is_null (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour : @@ -5573,7 +5573,7 @@ int weechat_config_option_default_is_null (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour : @@ -5619,14 +5619,14 @@ int weechat_config_boolean (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : valeur booléenne de l'option (0 ou 1) -* 'integer' : 0 -* 'string' : 0 -* 'color' : 0 +* _boolean_ : valeur booléenne de l'option (0 ou 1) +* _integer_ : 0 +* _string_ : 0 +* _color_ : 0 Exemple en C : @@ -5669,14 +5669,14 @@ int weechat_config_boolean_default (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : valeur booléenne par défaut de l'option (0 ou 1) -* 'integer' : 0 -* 'string' : 0 -* 'color' : 0 +* _boolean_ : valeur booléenne par défaut de l'option (0 ou 1) +* _integer_ : 0 +* _string_ : 0 +* _color_ : 0 Exemple en C : @@ -5719,14 +5719,14 @@ int weechat_config_integer (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : valeur booléenne de l'option (0 ou 1) -* 'integer' : valeur entière de l'option -* 'string' : 0 -* 'color' : index de la couleur +* _boolean_ : valeur booléenne de l'option (0 ou 1) +* _integer_ : valeur entière de l'option +* _string_ : 0 +* _color_ : index de la couleur Exemple en C : @@ -5761,14 +5761,14 @@ int weechat_config_integer_default (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : valeur booléenne par défaut de l'option (0 ou 1) -* 'integer' : valeur entière par défaut de l'option -* 'string' : 0 -* 'color' : index de la couleur par défaut +* _boolean_ : valeur booléenne par défaut de l'option (0 ou 1) +* _integer_ : valeur entière par défaut de l'option +* _string_ : 0 +* _color_ : index de la couleur par défaut Exemple en C : @@ -5803,15 +5803,15 @@ const char *weechat_config_string (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : "on" si la valeur est vraie, sinon "off" -* 'integer' : valeur de l'option sous forme de chaîne si l'option est un entier +* _boolean_ : "on" si la valeur est vraie, sinon "off" +* _integer_ : valeur de l'option sous forme de chaîne si l'option est un entier avec des valeurs sous forme de chaînes, sinon NULL -* 'string' : valeur de l'option sous forme de chaîne -* 'color' : nom de la couleur +* _string_ : valeur de l'option sous forme de chaîne +* _color_ : nom de la couleur Exemple en C : @@ -5846,15 +5846,15 @@ const char *weechat_config_string_default (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : "on" si la valeur par défaut est vraie, sinon "off" -* 'integer' : valeur par défaut de l'option sous forme de chaîne si l'option +* _boolean_ : "on" si la valeur par défaut est vraie, sinon "off" +* _integer_ : valeur par défaut de l'option sous forme de chaîne si l'option est un entier avec des valeurs sous forme de chaînes, sinon NULL -* 'string' : valeur par défaut de l'option sous forme de chaîne -* 'color' : nom de la couleur par défaut +* _string_ : valeur par défaut de l'option sous forme de chaîne +* _color_ : nom de la couleur par défaut Exemple en C : @@ -5889,14 +5889,14 @@ const char *weechat_config_color (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : NULL -* 'integer' : NULL -* 'string' : NULL -* 'color' : nom de la couleur +* _boolean_ : NULL +* _integer_ : NULL +* _string_ : NULL +* _color_ : nom de la couleur Exemple en C : @@ -5931,14 +5931,14 @@ const char *weechat_config_color_default (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Valeur de retour, selon le type de l'option : -* 'boolean' : NULL -* 'integer' : NULL -* 'string' : NULL -* 'color' : nom de la couleur par défaut +* _boolean_ : NULL +* _integer_ : NULL +* _string_ : NULL +* _color_ : nom de la couleur par défaut Exemple en C : @@ -5976,8 +5976,8 @@ void weechat_config_write_option (struct t_config_file *config_file, Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'option' : pointeur vers l'option +* _config_file_ : pointeur vers le fichier de configuration +* _option_ : pointeur vers l'option Exemple en C : @@ -6027,9 +6027,9 @@ void weechat_config_write_line (struct t_config_file *config_file, Paramètres : -* 'config_file' : pointeur vers le fichier de configuration -* 'option_name' : nom de l'option -* 'value' : valeur (si NULL, alors la ligne est écrite avec le nom de la +* _config_file_ : pointeur vers le fichier de configuration +* _option_name_ : nom de l'option +* _value_ : valeur (si NULL, alors la ligne est écrite avec le nom de la section, par exemple : "[section]") Exemple en C : @@ -6077,13 +6077,13 @@ int weechat_config_write (struct t_config_file *config_file); Paramètres : -* 'config_file' : pointeur vers le fichier de configuration. +* _config_file_ : pointeur vers le fichier de configuration. Valeur de retour : -* 'WEECHAT_CONFIG_WRITE_OK' si la configuration a été écrite -* 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' s'il n'y a pas eu suffisamment de mémoire -* 'WEECHAT_CONFIG_WRITE_ERROR' si une autre erreur s'est produite +* _WEECHAT_CONFIG_WRITE_OK_ si la configuration a été écrite +* _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ s'il n'y a pas eu suffisamment de mémoire +* _WEECHAT_CONFIG_WRITE_ERROR_ si une autre erreur s'est produite Exemple en C : @@ -6133,13 +6133,13 @@ int weechat_config_read (struct t_config_file *config_file); Paramètres : -* 'config_file' : pointeur vers le fichier de configuration +* _config_file_ : pointeur vers le fichier de configuration Valeur de retour : -* 'WEECHAT_CONFIG_READ_OK' si la configuration a été chargée -* 'WEECHAT_CONFIG_READ_MEMORY_ERROR' s'il n'y a pas eu suffisamment de mémoire -* 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' si le fichier n'a pas été trouvé +* _WEECHAT_CONFIG_READ_OK_ si la configuration a été chargée +* _WEECHAT_CONFIG_READ_MEMORY_ERROR_ s'il n'y a pas eu suffisamment de mémoire +* _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ si le fichier n'a pas été trouvé Exemple en C : @@ -6189,13 +6189,13 @@ int weechat_config_reload (struct t_config_file *config_file); Paramètres : -* 'config_file' : pointeur vers le fichier de configuration +* _config_file_ : pointeur vers le fichier de configuration Valeur de retour : -* 'WEECHAT_CONFIG_READ_OK' si la configuration a été rechargée -* 'WEECHAT_CONFIG_READ_MEMORY_ERROR' s'il n'y a pas eu suffisamment de mémoire -* 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' si le fichier n'a pas été trouvé +* _WEECHAT_CONFIG_READ_OK_ si la configuration a été rechargée +* _WEECHAT_CONFIG_READ_MEMORY_ERROR_ s'il n'y a pas eu suffisamment de mémoire +* _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ si le fichier n'a pas été trouvé Exemple en C : @@ -6245,7 +6245,7 @@ void weechat_config_option_free (struct t_config_option *option); Paramètres : -* 'option' : pointeur vers l'option +* _option_ : pointeur vers l'option Exemple en C : @@ -6278,7 +6278,7 @@ void weechat_config_section_free_options (struct t_config_section *section); Paramètres : -* 'section' : pointeur vers la section +* _section_ : pointeur vers la section Exemple en C : @@ -6311,7 +6311,7 @@ void weechat_config_section_free (struct t_config_section *section); Paramètres : -* 'section' : pointeur vers la section +* _section_ : pointeur vers la section Exemple en C : @@ -6344,7 +6344,7 @@ void weechat_config_free (struct t_config_file *config_file); Paramètres : -* 'config_file' : pointeur vers le fichier de configuration +* _config_file_ : pointeur vers le fichier de configuration Exemple en C : @@ -6377,7 +6377,7 @@ struct t_config_option *weechat_config_get (const char *option_name); Paramètres : -* 'option_name' : nom complet de l'option (format : "fichier.section.option") +* _option_name_ : nom complet de l'option (format : "fichier.section.option") Valeur de retour : @@ -6415,7 +6415,7 @@ const char *weechat_config_get_plugin (const char *option_name); Paramètres : -* 'option_name' : nom de l'option, WeeChat ajoutera le préfixe +* _option_name_ : nom de l'option, WeeChat ajoutera le préfixe "plugins.var.xxx." (où "xxx" est le nom de l'extension courante) Valeur de retour : @@ -6456,7 +6456,7 @@ int weechat_config_is_set_plugin (const char *option_name); Paramètres : -* 'option_name' : nom de l'option, WeeChat ajoutera le préfixe +* _option_name_ : nom de l'option, WeeChat ajoutera le préfixe "plugins.var.xxx." (où "xxx" est le nom de l'extension courante) Valeur de retour : @@ -6507,16 +6507,16 @@ int weechat_config_set_plugin (const char *option_name, const char *value); Paramètres : -* 'option_name' : nom de l'option, WeeChat ajoutera le préfixe +* _option_name_ : nom de l'option, WeeChat ajoutera le préfixe "plugins.var.xxx." (où "xxx" est le nom de l'extension courante) -* 'value' : nouvelle valeur pour l'option +* _value_ : nouvelle valeur pour l'option Valeur de retour : -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' si la valeur de l'option a été changée -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' si la valeur n'a pas changé -* 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' si l'option n'a pas été trouvée -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' en cas d'erreur +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ si la valeur de l'option a été changée +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ si la valeur n'a pas changé +* _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ si l'option n'a pas été trouvée +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ en cas d'erreur Exemple en C : @@ -6575,9 +6575,9 @@ void weechat_config_set_desc_plugin (const char *option_name, Paramètres : -* 'option_name' : nom de l'option, WeeChat ajoutera le préfixe +* _option_name_ : nom de l'option, WeeChat ajoutera le préfixe "plugins.desc.xxx." (où "xxx" est le nom de l'extension courante) -* 'description' : description pour l'option +* _description_ : description pour l'option [NOTE] Ce n'est pas un problème si l'option (plugins.var.xxx.option_name) n'existe pas. @@ -6616,17 +6616,17 @@ int weechat_config_unset_plugin (const char *option_name); Paramètres : -* 'option_name' : nom de l'option, WeeChat ajoutera le préfixe +* _option_name_ : nom de l'option, WeeChat ajoutera le préfixe "plugins.var.xxx." (où "xxx" est le nom de l'extension courante) Valeur de retour : -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' si la valeur de l'option n'a pas +* _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ si la valeur de l'option n'a pas été réinitialisée -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' si la valeur de l'option a été +* _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ si la valeur de l'option a été réinitialisée -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' si l'option a été supprimée -* 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' en cas d'erreur +* _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ si l'option a été supprimée +* _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ en cas d'erreur Exemple en C : @@ -6694,13 +6694,13 @@ int weechat_key_bind (const char *context, struct t_hashtable *keys); Paramètres : -* 'context' : contexte pour les touches : -** 'default' : contexte par défaut (actions courantes) -** 'search' : contexte de recherche (lors de la recherche de texte dans le +* _context_ : contexte pour les touches : +** _default_ : contexte par défaut (actions courantes) +** _search_ : contexte de recherche (lors de la recherche de texte dans le tampon) -** 'cursor' : mouvement libre du curseur à l'écran -** 'mouse' : touches pour les évènements de souris -* 'keys' : table de hachage avec les associations de touches +** _cursor_ : mouvement libre du curseur à l'écran +** _mouse_ : touches pour les évènements de souris +* _keys_ : table de hachage avec les associations de touches Valeur de retour : @@ -6758,10 +6758,10 @@ int weechat_key_unbind (const char *context, const char *key); Paramètres : -* 'context' : contexte pour les touches (voir +* _context_ : contexte pour les touches (voir <<_key_bind,weechat_key_bind>>) -* 'key' : touche à supprimer ou la valeur spéciale "area:XXX" pour supprimer - toutes les touches ayant 'XXX' comme première ou deuxième zone +* _key_ : touche à supprimer ou la valeur spéciale "area:XXX" pour supprimer + toutes les touches ayant _XXX_ comme première ou deuxième zone Valeur de retour : @@ -6812,7 +6812,7 @@ const char *weechat_prefix (const char *prefix); Paramètres : -* 'prefix' : nom du préfixe (voir le tableau ci-dessous) +* _prefix_ : nom du préfixe (voir le tableau ci-dessous) Valeur de retour : @@ -6821,14 +6821,14 @@ Valeur de retour : Liste des préfixes : -[width="70%",cols="^2e,^1,^3,5",options="header"] +[width="70%",cols="^2m,^1,^3,5",options="header"] |=== -| Préfixe | Valeur | Couleur | Description -| error | `=!=` | jaune ("yellow") | Message d'erreur -| network | `--` | violet ("magenta") | Message du réseau -| action | `*` | blanc ("white") | Action personnelle -| join | `-->` | vert clair ("lightgreen") | Quelqu'un a rejoint la discussion -| quit | `<--` | rouge clair ("lightred") | Quelqu'un a quitté la discussion +| Préfixe | Valeur | Couleur | Description +| error | `+=!=+` | jaune ("yellow") | Message d'erreur +| network | `+--+` | violet ("magenta") | Message du réseau +| action | `+*+` | blanc ("white") | Action personnelle +| join | `+-->+` | vert clair ("lightgreen") | Quelqu'un a rejoint la discussion +| quit | `+<--+` | rouge clair ("lightred") | Quelqu'un a quitté la discussion |=== [NOTE] @@ -6865,52 +6865,52 @@ const char *weechat_color (const char *color_name); Paramètres : -* 'color_name' : nom de la couleur, parmi : +* _color_name_ : nom de la couleur, parmi : ** le nom d'une option de couleur WeeChat (de weechat.color.xxx), par exemple - 'chat_delimiters' + _chat_delimiters_ ** le nom d'une option (format : fichier.section.option), par exemple - 'irc.color.message_quit' (_WeeChat ≥ 1.2_) + _irc.color.message_quit_ (_WeeChat ≥ 1.2_) ** une couleur avec des attributs/fond optionnels (voir ci-dessous) ** un attribut : -*** 'bold' : activer le gras -*** '-bold' : désactiver le gras -*** 'reverse' : activer la vidéo inverse -*** '-reverse' : désactiver la vidéo inverse -*** 'italic' : activer l'italique -*** '-italic' : désactiver l'italique -*** 'underline' : activer le souligné -*** '-underline' : désactiver le souligné -*** 'emphasis' : activer/désactiver la mise en valeur du texte (note : cela ne +*** _bold_ : activer le gras +*** _-bold_ : désactiver le gras +*** _reverse_ : activer la vidéo inverse +*** _-reverse_ : désactiver la vidéo inverse +*** _italic_ : activer l'italique +*** _-italic_ : désactiver l'italique +*** _underline_ : activer le souligné +*** _-underline_ : désactiver le souligné +*** _emphasis_ : activer/désactiver la mise en valeur du texte (note : cela ne devrait être utilisé que dans les barres, car WeeChat utilise la mise en valeur du texte lors de la recherche de texte dans le tampon) _(WeeChat ≥ 0.4.2)_ ** nom d'une couleur de barre : -*** 'bar_fg' : couleur de texte pour la barre -*** 'bar_delim' : couleur des délimiteurs pour la barre -*** 'bar_bg' : couleur de fond pour la barre +*** _bar_fg_ : couleur de texte pour la barre +*** _bar_delim_ : couleur des délimiteurs pour la barre +*** _bar_bg_ : couleur de fond pour la barre ** réinitialisation : -*** 'reset' : réinitialiser la couleur et les attributs -*** 'resetcolor' : réinitialiser la couleur (garder les attributs) +*** _reset_ : réinitialiser la couleur et les attributs +*** _resetcolor_ : réinitialiser la couleur (garder les attributs) _(WeeChat ≥ 0.3.6)_ Le format de la couleur est : attributs (optionnel) + nom de couleur + ",fond" (optionnel). Les attributs possibles sont : -* `*` : texte gras -* `!` : mode vidéo inverse -* `/` : italique -* `_` : texte souligné -* `|` : garder les attributs : ne pas réinitialiser +* `+*+` : texte gras +* `+!+` : mode vidéo inverse +* `+/+` : italique +* `+_+` : texte souligné +* `+|+` : garder les attributs : ne pas réinitialiser gras/inverse/italique/souligné lors du changement de couleur _(WeeChat ≥ 0.3.6)_ Exemples : -* `yellow` : jaune -* `_green` : vert souligné -* `*214` : orange gras -* `yellow,red` : jaune sur rouge -* `|cyan` : cyan (et garder tout attribut définit précédemment) +* `+yellow+` : jaune +* `+_green+` : vert souligné +* `+*214+` : orange gras +* `+yellow,red+` : jaune sur rouge +* `+|cyan+` : cyan (et garder tout attribut définit précédemment) Valeur de retour : @@ -6952,9 +6952,9 @@ void weechat_printf (struct t_gui_buffer *buffer, const char *message, ...); Paramètres : -* 'buffer' : pointeur vers le tampon, si NULL, le message est affiché sur le +* _buffer_ : pointeur vers le tampon, si NULL, le message est affiché sur le tampon WeeChat -* 'message' : message à afficher +* _message_ : message à afficher [NOTE] La première tabulation dans le message ("\t") est utilisée pour séparer le @@ -7013,10 +7013,10 @@ void weechat_printf_date (struct t_gui_buffer *buffer, time_t date, Paramètres : -* 'buffer' : pointeur vers le tampon, si NULL, le message est affiché sur le +* _buffer_ : pointeur vers le tampon, si NULL, le message est affiché sur le tampon Weechat -* 'date' : date pour le message (0 signifie la date/heure courante) -* 'message' : message à afficher +* _date_ : date pour le message (0 signifie la date/heure courante) +* _message_ : message à afficher Exemple en C : @@ -7042,10 +7042,10 @@ void weechat_printf_tags (struct t_gui_buffer *buffer, const char *tags, Paramètres : -* 'buffer' : pointeur vers le tampon, si NULL, le message est affiché sur le +* _buffer_ : pointeur vers le tampon, si NULL, le message est affiché sur le tampon Weechat -* 'tags' : liste d'étiquettes séparées par des virgules -* 'message' : message à afficher +* _tags_ : liste d'étiquettes séparées par des virgules +* _message_ : message à afficher Exemple en C : @@ -7073,11 +7073,11 @@ void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date, Paramètres : -* 'buffer' : pointeur vers le tampon, si NULL, le message est affiché sur le +* _buffer_ : pointeur vers le tampon, si NULL, le message est affiché sur le tampon Weechat -* 'date' : date pour le message (0 signifie la date/heure courante) -* 'tags' : liste d'étiquettes séparées par des virgules -* 'message' : message à afficher +* _date_ : date pour le message (0 signifie la date/heure courante) +* _tags_ : liste d'étiquettes séparées par des virgules +* _message_ : message à afficher Tags couramment utilisés (liste non exhaustive) : @@ -7144,13 +7144,13 @@ void weechat_printf_y (struct t_gui_buffer *buffer, int y, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'y' : numéro de ligne (la première ligne est 0); une valeur négative affiche - une ligne après la dernière ligne affichée : la valeur absolue de 'y' est le +* _buffer_ : pointeur vers le tampon +* _y_ : numéro de ligne (la première ligne est 0); une valeur négative affiche + une ligne après la dernière ligne affichée : la valeur absolue de _y_ est le nombre de lignes après la dernière ligne (par exemple -1 est immédiatement après la dernière ligne, -2 est 2 lignes après la dernière ligne) _(WeeChat ≥ 1.0)_ -* 'message' : message à afficher +* _message_ : message à afficher Exemple en C : @@ -7186,7 +7186,7 @@ void weechat_log_printf (const char *message, ...); Paramètres : -* 'message' : message à écrire +* _message_ : message à écrire Exemple en C : @@ -7269,32 +7269,32 @@ struct t_hook *weechat_hook_command (const char *command, Paramètres : -* 'command' : nom de la commande +* _command_ : nom de la commande (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'description' : description de la commande (affiché avec `/help command`) -* 'args' : paramètres pour la commande (affichés avec `/help command`) -* 'args_description' : description des paramètres (affichée avec +* _description_ : description de la commande (affiché avec `/help command`) +* _args_ : paramètres pour la commande (affichés avec `/help command`) +* _args_description_ : description des paramètres (affichée avec `/help command`) -* 'completion' : modèle pour la complétion de la commande : liste des +* _completion_ : modèle pour la complétion de la commande : liste des complétions pour chaque paramètre, séparés par des espaces. Plusieurs - complétions sont possibles pour un paramètre, séparées par "|". Plusieurs + 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 et + `+||+`. +* _callback_ : fonction appelée lorsque la commande est utilisée, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** '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 +** _const void *pointer_ : pointeur +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -7305,9 +7305,9 @@ include::autogen/plugin_api/completions.asciidoc[] Codes spéciaux : -* '%%command' : réutiliser le modèle de complétion de la commande 'command' -* '%-' : arrêter la complétion -* '%*' : répéter la dernière complétion +* `+%%command+` : réutiliser le modèle de complétion de la commande _command_ +* `+%-+` : arrêter la complétion +* `+%*+` : répéter la dernière complétion Valeur de retour : @@ -7342,21 +7342,21 @@ struct t_hook *my_command_hook = &my_command_cb, NULL, NULL); ---- -Par exemple, si la commande appelée est `/command abc def ghi`, alors 'argv' et -'argv_eol' ont les valeurs suivantes : +Par exemple, si la commande appelée est `/command abc def ghi`, alors _argv_ et +_argv_eol_ ont les valeurs suivantes : -* 'argv' : -** 'argv[0]' == "/command" -** 'argv[1]' == "abc" -** 'argv[2]' == "def" -** 'argv[3]' == "ghi" -* 'argv_eol' : -** 'argv_eol[0]' == "/command abc def ghi" -** 'argv_eol[1]' == "abc def ghi" -** 'argv_eol[2]' == "def ghi" -** 'argv_eol[3]' == "ghi" +* _argv_ : +** _argv[0]_ == "/command" +** _argv[1]_ == "abc" +** _argv[2]_ == "def" +** _argv[3]_ == "ghi" +* _argv_eol_ : +** _argv_eol[0]_ == "/command abc def ghi" +** _argv_eol[1]_ == "abc def ghi" +** _argv_eol[2]_ == "def ghi" +** _argv_eol[3]_ == "ghi" -Pour les scripts, 'args' a la valeur "abc def ghi". +Pour les scripts, _args_ a la valeur "abc def ghi". Script (Python) : @@ -7404,27 +7404,27 @@ struct t_hook *weechat_hook_command_run (const char *command, Paramètres : -* 'command' : commande à intercepter (le caractère joker "*" est autorisé) +* _command_ : commande à intercepter (le caractère joker `+*+` est autorisé) (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'callback' : fonction appelée lorsque la commande est exécutée, paramètres et +* _callback_ : fonction appelée lorsque la commande est exécutée, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_gui_buffer *buffer' : tampon où la commande est exécutée -** 'const char *command' : la commande exécutée, avec ses paramètres +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_gui_buffer *buffer_ : tampon où la commande 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_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé [NOTE] -Le "callback" peut retourner 'WEECHAT_RC_OK' ou 'WEECHAT_RC_OK_EAT' (la +Le "callback" peut retourner _WEECHAT_RC_OK_ ou _WEECHAT_RC_OK_EAT_ (la commande ne sera pas exécutée par WeeChat après le "callback"). Valeur de retour : @@ -7485,25 +7485,25 @@ struct t_hook *weechat_hook_timer (long interval, Paramètres : -* 'interval' : intervalle entre deux appels (en millisecondes, donc 1000 = 1 +* _interval_ : intervalle entre deux appels (en millisecondes, donc 1000 = 1 seconde) -* 'align_second' : alignement sur la seconde. Par exemple, si la date courante +* _align_second_ : alignement sur la seconde. Par exemple, si la date courante est 09:00, si l'intervalle est 60000 (60 secondes), et que align_second = 60, alors le minuteur sera appelé chaque minute quand la seconde sera 0 -* 'max_calls' : nombre maximum d'appels au minuteur (si 0, le minuteur n'a pas +* _max_calls_ : nombre maximum d'appels au minuteur (si 0, le minuteur n'a pas de fin) -* 'callback' : fonction appelée quand le délai est atteint, paramètres et valeur +* _callback_ : fonction appelée quand le délai est atteint, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'int remaining_calls' : nombre d'appels restants (-1 si le minuteur n'a pas +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _int remaining_calls_ : nombre d'appels restants (-1 si le minuteur n'a pas de fin) ** valeur de retour : -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -7567,22 +7567,22 @@ struct t_hook *weechat_hook_fd (int fd, Paramètres : -* 'fd' : descripteur de fichier -* 'flag_read' : 1 = intercepter un évènement de lecture, 0 = ignorer -* 'flag_write' : 1 = intercepter un évènement d'écriture, 0 = ignorer -* 'flag_exception' : 1 = intercepter un évènement d'exception, 0 = ignorer +* _fd_ : descripteur de fichier +* _flag_read_ : 1 = intercepter un évènement de lecture, 0 = ignorer +* _flag_write_ : 1 = intercepter un évènement d'écriture, 0 = ignorer +* _flag_exception_ : 1 = intercepter un évènement d'exception, 0 = ignorer (_WeeChat ≥ 1.3_ : ce paramètre est ignoré et n'est plus utilisé) -* 'callback' : fonction appelée lorsqu'un des évènements sélectionnés se +* _callback_ : fonction appelée lorsqu'un des évènements sélectionnés se produit pour le fichier (ou le socket), paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'int fd' : descripteur de fichier +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _int fd_ : descripteur de fichier ** valeur de retour : -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -7637,7 +7637,7 @@ paramètres (comme le fait le shell). + Si le découpage n'est pas correct (selon les guillemets utilisés dans votre commande), ou si vous souhaitez utiliser le shell, vous pouvez utiliser la fonction <<_hook_process_hashtable,weechat_hook_process_hashtable>> avec -les paramètres dans la table de hachage 'options' _(WeeChat ≥ 0.4.0)_. +les paramètres dans la table de hachage _options_ _(WeeChat ≥ 0.4.0)_. Prototype : @@ -7658,39 +7658,39 @@ struct t_hook *weechat_hook_process (const char *command, Paramètres : -* 'command' : commande à lancer dans le processus fils, URL _(WeeChat ≥ 0.3.7)_ +* _command_ : commande à lancer dans le processus fils, URL _(WeeChat ≥ 0.3.7)_ ou fonction _(WeeChat ≥ 1.5)_ (voir ci-dessous) -* 'timeout' : timeout pour la commande (en millisecondes) : après ce délai, le +* _timeout_ : timeout pour la commande (en millisecondes) : après ce délai, le processus fils est tué (0 signifie pas de limite) -* 'callback' : fonction appelée quand des données du fils sont disponibles, or +* _callback_ : fonction appelée quand des données du fils sont disponibles, or ou quand le fils s'est terminé, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *command' : commande exécutée par le fils -** 'int return_code' : code retour : -*** '>= 0' : code retour du fils pour une commande, et pour l'URL, les valeurs +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _const char *command_ : commande exécutée par le fils +** _int return_code_ : code retour : +*** _>= 0_ : code retour du fils pour une commande, et pour l'URL, les valeurs possibles sont : -**** '0' : transfert ok -**** '1' : URL invalide -**** '2' : erreur de transfert -**** '3' : pas assez de mémoire -**** '4' : erreur avec un fichier -*** '< 0' : -**** 'WEECHAT_HOOK_PROCESS_RUNNING' : données disponibles, mais le fils tourne +**** _0_ : transfert ok +**** _1_ : URL invalide +**** _2_ : erreur de transfert +**** _3_ : pas assez de mémoire +**** _4_ : erreur avec un fichier +*** _< 0_ : +**** _WEECHAT_HOOK_PROCESS_RUNNING_ : données disponibles, mais le fils tourne toujours -**** 'WEECHAT_HOOK_PROCESS_ERROR' : erreur en lançant la commande -**** 'WEECHAT_HOOK_PROCESS_CHILD': le "callback" est appelé dans le processus +**** _WEECHAT_HOOK_PROCESS_ERROR_ : erreur en lançant la commande +**** _WEECHAT_HOOK_PROCESS_CHILD_: le "callback" est appelé dans le processus fils -** 'out' : sortie standard de la commande (stdout) -** 'err' : erreurs de la commande (stderr) +** _out_ : sortie standard de la commande (stdout) +** _err_ : erreurs de la commande (stderr) ** valeur de retour : -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ *** code retour du processus fils (dans le cas d'une fonction avec "func:" dans la commande) -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -7710,12 +7710,12 @@ Des options pour l'URL sont possibles avec la fonction La commande peut aussi être le nom d'une fonction avec le format : "func:nom", pour exécuter la fonction "nom" _(WeeChat ≥ 1.5)_. Cette fonction reçoit un -paramètre ('data') et doit retourner une chaîne de caractères, qui sera envoyée +paramètre (_data_) et doit retourner une chaîne de caractères, qui sera envoyée au "callback". + Dans l'API C, le "callback" est appelé avec le code retour qui vaut -'WEECHAT_HOOK_PROCESS_CHILD', cela signifie que le "callback" tourne dans le +_WEECHAT_HOOK_PROCESS_CHILD_, cela signifie que le "callback" tourne dans le processus fils (après le fork). + -Dans l'API script, la fonction 'nom' est appelée directement et le résultat +Dans l'API script, la fonction _nom_ est appelée directement et le résultat (chaîne de caractères) est envoyé au "callback" (comme la sortie d'une commande externe). @@ -7890,7 +7890,7 @@ Les paramètres sont les mêmes que ceux de la fonction <<_hook_process,weechat_hook_process>>, avec un paramètre supplémentaire : -* 'options' : options pour la commande exécutée; la table de hachage est +* _options_ : options pour la commande exécutée; la table de hachage est dupliquée dans la fonction, donc il est possible de la supprimer après cet appel @@ -7906,7 +7906,7 @@ sont disponibles : toute chaîne | Paramètres pour la commande ; si aucun paramètre n'est donné avec ces options, la commande sera automatiquement découpée comme le fait le shell (et donc les - paramètres de la commande sont lus dans le paramètre 'command') + paramètres de la commande sont lus dans le paramètre _command_) | stdin + _(WeeChat ≥ 0.4.3)_ | @@ -7925,7 +7925,7 @@ sont disponibles : _(WeeChat ≥ 1.0)_ | (non utilisée) | Lancer le process dans un mode détaché : stdout et stderr sont redirigés vers - '/dev/null' + _/dev/null_ |=== Pour la commande "url:...", les options suivantes sont disponibles (voir @@ -7941,8 +7941,8 @@ est : "valeur1+valeur2+valeur3". Pour l'URL, deux options supplémentaires (chaînes) sont autorisées, pour le fichier en entrée/sortie : -* 'file_in' : fichier à lire pour envoyer avec l'URL (envoi de fichier "post") -* 'file_out' : écrire l'URL/fichier dans ce fichier (au lieu de la sortie +* _file_in_ : fichier à lire pour envoyer avec l'URL (envoi de fichier "post") +* _file_out_ : écrire l'URL/fichier dans ce fichier (au lieu de la sortie standard) Valeur de retour : @@ -8107,56 +8107,56 @@ struct t_hook *weechat_hook_connect (const char *proxy, Paramètres : -* 'proxy' : nom du proxy à utiliser pour la connexion (optionnel, NULL signifie +* _proxy_ : nom du proxy à utiliser pour la connexion (optionnel, NULL signifie une connexion sans proxy) -* 'address' : nom ou adresse IP de la machine à laquelle se connecter -* 'port' : numéro de port -* 'ipv6' : 1 pour utiliser IPv6 (avec repli sur IPv4), 0 pour utiliser seulement +* _address_ : nom ou adresse IP de la machine à laquelle se connecter +* _port_ : numéro de port +* _ipv6_ : 1 pour utiliser IPv6 (avec repli sur IPv4), 0 pour utiliser seulement IPv4 -* 'retry' : numéro de nouvelle tentative, utilisé pour se rabattre sur les +* _retry_ : numéro de nouvelle tentative, utilisé pour se rabattre sur les adresses IPv4 si la connexion IPv6 échoue -* 'gnutls_sess' : session GnuTLS (optionnel) -* 'gnutls_cb' : callback pour GnuTLS (optionnel) -* 'gnutls_dhkey_size' : taille de clé utilisée pour l'échange de clé +* _gnutls_sess_ : session GnuTLS (optionnel) +* _gnutls_cb_ : callback pour GnuTLS (optionnel) +* _gnutls_dhkey_size_ : taille de clé utilisée pour l'échange de clé Diffie-Hellman (GnuTLS) -* 'gnutls_priorities' : priorités pour gnutls (pour la syntaxe, voir la - documentation de la fonction 'gnutls_priority_init' dans le manuel gnutls), +* _gnutls_priorities_ : priorités pour gnutls (pour la syntaxe, voir la + documentation de la fonction _gnutls_priority_init_ dans le manuel gnutls), les valeurs de base sont : -** 'PERFORMANCE' -** 'NORMAL' (défaut) -** 'SECURE128' -** 'SECURE256' -** 'EXPORT' -** 'NONE' -* 'local_hostname' : nom de machine local à utiliser pour la connexion +** _PERFORMANCE_ +** _NORMAL_ (défaut) +** _SECURE128_ +** _SECURE256_ +** _EXPORT_ +** _NONE_ +* _local_hostname_ : nom de machine local à utiliser pour la connexion (optionnel) -* 'callback' : fonction appelée lorsque la connexion est ok ou a échoué, +* _callback_ : fonction appelée lorsque la connexion est ok ou a échoué, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'int status' : statut de connexion : -*** 'WEECHAT_HOOK_CONNECT_OK' : connexion ok -*** 'WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND' : adresse non trouvée -*** 'WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND' : adresse IP non trouvée -*** 'WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED' : connexion refusée -*** 'WEECHAT_HOOK_CONNECT_PROXY_ERROR' : erreur avec le proxy -*** 'WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR' : erreur avec le nom local -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR' : erreur d'initialisation GnuTLS -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR' : erreur avec la +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _int status_ : statut de connexion : +*** _WEECHAT_HOOK_CONNECT_OK_ : connexion ok +*** _WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND_ : adresse non trouvée +*** _WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND_ : adresse IP non trouvée +*** _WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED_ : connexion refusée +*** _WEECHAT_HOOK_CONNECT_PROXY_ERROR_ : erreur avec le proxy +*** _WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR_ : erreur avec le nom local +*** _WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR_ : erreur d'initialisation GnuTLS +*** _WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR_ : erreur avec la "poignée de main" GnuTLS -*** 'WEECHAT_HOOK_CONNECT_MEMORY_ERROR' : mémoire insuffisante -*** 'WEECHAT_HOOK_CONNECT_TIMEOUT' : temps maximum dépassé -*** 'WEECHAT_HOOK_CONNECT_SOCKET_ERROR' : erreur de création socket -** 'gnutls_rc' : valeur retour de 'gnutls_handshake()' -** 'sock' : socket utilisé pour la connexion -** 'const char *error' : valeur retour de 'gnutls_strerror(gnutls_rc)' -** 'const char *ip_address' : adresse IP trouvée +*** _WEECHAT_HOOK_CONNECT_MEMORY_ERROR_ : mémoire insuffisante +*** _WEECHAT_HOOK_CONNECT_TIMEOUT_ : temps maximum dépassé +*** _WEECHAT_HOOK_CONNECT_SOCKET_ERROR_ : erreur de création socket +** _gnutls_rc_ : valeur retour de _gnutls_handshake()_ +** _sock_ : socket utilisé pour la connexion +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -8288,37 +8288,37 @@ struct t_hook *weechat_hook_print (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon, si NULL, les messages de tous les tampons +* _buffer_ : pointeur vers le tampon, si NULL, les messages de tous les tampons sont interceptés -* 'tags' : intercepter seulement les messages avec ces étiquettes (optionnel) : +* _tags_ : intercepter seulement les messages avec ces étiquettes (optionnel) : ** avec WeeChat ≥ 0.4.3 : liste d'étiquettes (séparées par des virgules) qui doivent être dans le message ("ou" logique); il est possible de combiner - plusieurs étiquettes sous forme d'un "et" logique avec le séparateur "+"; - le caractère joker "*" est autorisé dans les étiquettes + plusieurs étiquettes sous forme d'un "et" logique avec le séparateur `+++`; + le caractère joker `+*+` est autorisé dans les étiquettes ** avec WeeChat ≤ 0.4.2 : liste d'étiquettes (séparées par des virgules) qui doivent toutes être dans le message ("et" logique) -* 'message' : seulement les messages contenant cette chaîne seront interceptés +* _message_ : seulement les messages contenant cette chaîne seront interceptés (optionnel, insensible à la casse) -* 'strip_colors' : si 1, les couleurs seront supprimées du message affiché, +* _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 et +* _callback_ : fonction appelée lorsqu'un message est affiché, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_gui_buffer *buffer' : pointeur vers le tampon -** 'time_t date' : date -** 'int tags_count' : nombre d'étiquettes de la ligne -** 'const char **tags' : tableau avec les étiquettes de la ligne -** 'int displayed' : 1 si la ligne est affichée, 0 si elle est filtrée (cachée) -** 'int highlight' : 1 si la ligne contient un highlight, sinon 0 -** 'const char *prefix' : préfixe -** 'const char *message' : message +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_gui_buffer *buffer_ : pointeur vers le tampon +** _time_t date_ : date +** _int tags_count_ : nombre d'étiquettes de la ligne +** _const char **tags_ : tableau avec les étiquettes de la ligne +** _int displayed_ : 1 si la ligne est affichée, 0 si elle est filtrée (cachée) +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -8328,11 +8328,11 @@ Valeur de retour : * pointeur vers le nouveau "hook", NULL en cas d'erreur [IMPORTANT] -Dans les scripts, avec WeeChat ≥ 1.0, les paramètres du callback 'displayed' et -'highlight' sont des entiers (avec WeeChat ≤ 0.4.3, ils étaient des chaînes). + +Dans les scripts, avec WeeChat ≥ 1.0, les paramètres du callback _displayed_ et +_highlight_ sont des entiers (avec WeeChat ≤ 0.4.3, ils étaient des chaînes). + Pour être compatible avec toutes les versions, il est recommandé de convertir le paramètre en entier avant de le tester, par exemple en Python : -"`if int(highlight):`". +`if int(highlight):`. Exemple en C : @@ -8392,27 +8392,27 @@ struct t_hook *weechat_hook_signal (const char *signal, Paramètres : -* 'signal' : signal à intercepter, le caractère joker "*" est autorisé +* _signal_ : signal à intercepter, le caractère joker `+*+` est autorisé (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 +* _callback_ : fonction appelée quand le signal est reçu, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** '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 +** _const void *pointer_ : pointeur +** _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_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ (arrêter l'envoi du signal immédiatement) _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -8875,17 +8875,17 @@ Liste des signaux envoyés par WeeChat et les extensions : | weechat | key_combo_default + _(WeeChat ≥ 1.0)_ | Chaîne : combinaison de touches | - Combinaison de touches dans le contexte 'default' + Combinaison de touches dans le contexte _default_ | weechat | key_combo_search + _(WeeChat ≥ 1.0)_ | Chaîne : combinaison de touches | - Combinaison de touches dans le contexte 'search' + Combinaison de touches dans le contexte _search_ | weechat | key_combo_cursor + _(WeeChat ≥ 1.0)_ | Chaîne : combinaison de touches | - Combinaison de touches dans le contexte 'cursor' + Combinaison de touches dans le contexte _cursor_ | weechat | mouse_enabled + _(WeeChat ≥ 1.1)_ | @@ -9063,7 +9063,7 @@ Liste des signaux envoyés par WeeChat et les extensions : |=== [NOTE] -^(1)^ 'xxx' est le nom du serveur IRC, 'yyy' est le nom d'une commande IRC. +^(1)^ _xxx_ est le nom du serveur IRC, _yyy_ est le nom d'une commande IRC. Exemple en C : @@ -9114,18 +9114,18 @@ int weechat_hook_signal_send (const char *signal, const char *type_data, Paramètres : -* 'signal' : signal à envoyer -* 'type_data' : type de données à envoyer avec le signal (voir +* _signal_ : signal à envoyer +* _type_data_ : type de données à envoyer avec le signal (voir <<_hook_signal,weechat_hook_signal>>) -* 'signal_data' : données envoyées avec le signal +* _signal_data_ : données envoyées avec le signal Valeur de retour _(WeeChat ≥ 1.0)_ : -* code retour du dernier "callback" exécuté ('WEECHAT_RC_OK' si aucun "callback" +* code retour du dernier "callback" exécuté (_WEECHAT_RC_OK_ si aucun "callback" n'a été exécuté) : -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ Exemple en C : @@ -9173,24 +9173,24 @@ weechat.hook_signal_send("logger_backlog", weechat.WEECHAT_HOOK_SIGNAL_POINTER, Cinq signaux peuvent être envoyés pour installer un script, selon le langage : -* 'perl_script_install' -* 'python_script_install' -* 'ruby_script_install' -* 'lua_script_install' -* 'tcl_script_install' -* 'guile_script_install' -* 'javascript_script_install' +* _perl_script_install_ +* _python_script_install_ +* _ruby_script_install_ +* _lua_script_install_ +* _tcl_script_install_ +* _guile_script_install_ +* _javascript_script_install_ Le "callback" effectuera les actions suivantes lorsqu'il recevra le signal : . déchargement et suppression du script installé -. déplacement du nouveau script vers le répertoire '~/.weechat/xxx/' (où 'xxx' +. déplacement du nouveau script vers le répertoire _~/.weechat/xxx/_ (où _xxx_ est le langage) . création d'un lien vers le nouveau script dans le répertoire - '~/.weechat/xxx/autoload/' + _~/.weechat/xxx/autoload/_ . chargement du nouveau script -Ces signaux sont utilisés par l'extension 'script' pour installer des scripts. +Ces signaux sont utilisés par l'extension _script_ pour installer des scripts. Le paramètre est une chaîne avec le chemin vers le script à installer. @@ -9216,21 +9216,21 @@ weechat.hook_signal_send("python_script_install", WEECHAT_HOOK_SIGNAL_STRING, Cinq signaux peuvent être envoyés pour supprimer une liste de scripts, selon le langage : -* 'perl_script_remove' -* 'python_script_remove' -* 'ruby_script_remove' -* 'lua_script_remove' -* 'tcl_script_remove' -* 'guile_script_remove' -* 'javascript_script_remove' +* _perl_script_remove_ +* _python_script_remove_ +* _ruby_script_remove_ +* _lua_script_remove_ +* _tcl_script_remove_ +* _guile_script_remove_ +* _javascript_script_remove_ Pour chaque script dans la liste, le "callback" déchargera et supprimera le script. -Ces signaux sont utilisés par l'extension 'script' pour supprimer des scripts. +Ces signaux sont utilisés par l'extension _script_ pour supprimer des scripts. Le paramètre est une chaîne avec une liste de scripts à supprimer (séparés par -des virgules, nom du script sans le chemin, par exemple 'script.py'). +des virgules, nom du script sans le chemin, par exemple _script.py_). Exemple en C : @@ -9265,11 +9265,11 @@ Le paramètre est une chaîne avec le format suivant : * nom de canal (optionnel) * point-virgule * liste d'options séparées par des virgules (optionnel) : -** 'priority_high' : file d'attente avec haute priorité (comme les messages +** _priority_high_ : file d'attente avec haute priorité (comme les messages utilisateur) ; c'est la priorité par défaut -** 'priority_low' : file d'attente avec basse priorité (comme les messages +** _priority_low_ : file d'attente avec basse priorité (comme les messages envoyés automatiquement par WeeChat) -** 'user_message' : forcer un message utilisateur (ne pas exécuter de commande) +** _user_message_ : forcer un message utilisateur (ne pas exécuter de commande) * point-virgule * liste d'étiquettes (séparées par des virgules) utilisées lors de l'envoi du message (optionnel) @@ -9323,23 +9323,23 @@ struct t_hook *weechat_hook_hsignal (const char *signal, Paramètres : -* 'signal' : signal à intercepter, le caractère joker "*" est autorisé +* _signal_ : signal à intercepter, le caractère joker `+*+` est autorisé (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 +* _callback_ : fonction appelée quand le signal est reçu, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *signal' : signal reçu -** 'struct t_hashtable *hashtable' : table de hachage +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _const char *signal_ : signal reçu +** _struct t_hashtable *hashtable_ : table de hachage ** valeur de retour : -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_OK_EAT' (arrêter l'envoi du signal immédiatement) +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ (arrêter l'envoi du signal immédiatement) _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -9361,49 +9361,49 @@ Liste des hsignaux envoyés par WeeChat et les extensions : | weechat | nicklist_group_added + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *') : tampon + - 'parent_group' ('struct t_gui_nick_group *') : groupe parent + - 'group' ('struct t_gui_nick_group *') : groupe | + _buffer_ (_struct t_gui_buffer *_) : tampon + + _parent_group_ (_struct t_gui_nick_group *_) : groupe parent + + _group_ (_struct t_gui_nick_group *_) : groupe | Groupe ajouté dans la liste de pseudos | weechat | nicklist_nick_added + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *') : tampon + - 'parent_group' ('struct t_gui_nick_group *') : groupe parent + - 'nick' ('struct t_gui_nick *') : pseudo | + _buffer_ (_struct t_gui_buffer *_) : tampon + + _parent_group_ (_struct t_gui_nick_group *_) : groupe parent + + _nick_ (_struct t_gui_nick *_) : pseudo | Pseudo ajouté dans la liste de pseudos | weechat | nicklist_group_removing + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *') : tampon + - 'parent_group' ('struct t_gui_nick_group *') : groupe parent + - 'group' ('struct t_gui_nick_group *') : groupe | + _buffer_ (_struct t_gui_buffer *_) : tampon + + _parent_group_ (_struct t_gui_nick_group *_) : groupe parent + + _group_ (_struct t_gui_nick_group *_) : groupe | Suppression d'un groupe de la liste de pseudos | weechat | nicklist_nick_removing + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *') : tampon + - 'parent_group' ('struct t_gui_nick_group *') : groupe parent + - 'nick' ('struct t_gui_nick *') : pseudo | + _buffer_ (_struct t_gui_buffer *_) : tampon + + _parent_group_ (_struct t_gui_nick_group *_) : groupe parent + + _nick_ (_struct t_gui_nick *_) : pseudo | Suppression d'un pseudo de la liste de pseudos | weechat | nicklist_group_changed + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *') : tampon + - 'parent_group' ('struct t_gui_nick_group *') : groupe parent + - 'group' ('struct t_gui_nick_group *') : groupe | + _buffer_ (_struct t_gui_buffer *_) : tampon + + _parent_group_ (_struct t_gui_nick_group *_) : groupe parent + + _group_ (_struct t_gui_nick_group *_) : groupe | Groupe changé dans la liste de pseudos | weechat | nicklist_nick_changed + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *') : tampon + - 'parent_group' ('struct t_gui_nick_group *') : parent + - 'nick' ('struct t_gui_nick *') : pseudo | + _buffer_ (_struct t_gui_buffer *_) : tampon + + _parent_group_ (_struct t_gui_nick_group *_) : parent + + _nick_ (_struct t_gui_nick *_) : pseudo | Pseudo changé dans la liste de pseudos |=== [NOTE] -^(1)^ 'xxx' est l'argument "signal" utilisé dans la redirection, 'yyy' est le +^(1)^ _xxx_ est l'argument "signal" utilisé dans la redirection, _yyy_ est le modèle de redirection ("pattern"). Exemple en C : @@ -9452,16 +9452,16 @@ int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable Paramètres : -* 'signal' : signal à envoyer -* 'hashtable' : table de hachage +* _signal_ : signal à envoyer +* _hashtable_ : table de hachage Valeur de retour _(WeeChat ≥ 1.0)_ : -* code retour du dernier "callback" exécuté ('WEECHAT_RC_OK' si aucun "callback" +* code retour du dernier "callback" exécuté (_WEECHAT_RC_OK_ si aucun "callback" n'a été exécuté) : -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ Exemple en C : @@ -9503,34 +9503,34 @@ d'une commande irc vers un "callback". Le paramètre est une table de hachage avec les entrées suivantes (les clés et valeurs sont des chaînes) : -* 'server' : nom interne du serveur (requis) -* 'pattern' : modèle de redirection à utiliser (requis), soit un par défaut +* _server_ : nom interne du serveur (requis) +* _pattern_ : modèle de redirection à utiliser (requis), soit un par défaut (défini par l'extension irc), ou un modèle utilisateur (voir <<hsignal_irc_redirect_pattern>>), les modèles par défaut sont : -** 'ison' -** 'list' -** 'mode_channel' -** 'mode_channel_ban' ("mode #channel b") -** 'mode_channel_ban_exception' ("mode #channel e") -** 'mode_channel_invite' ("mode #channel I") -** 'mode_user' -** 'monitor' -** 'names' -** 'ping' -** 'time' -** 'topic' -** 'userhost' -** 'who' -** 'whois' -** 'whowas' -* 'signal' : nom du signal (requis) -* 'count' : nombre de fois que la redirection sera exécutée (optionnel, 1 par +** _ison_ +** _list_ +** _mode_channel_ +** _mode_channel_ban_ ("mode #channel b") +** _mode_channel_ban_exception_ ("mode #channel e") +** _mode_channel_invite_ ("mode #channel I") +** _mode_user_ +** _monitor_ +** _names_ +** _ping_ +** _time_ +** _topic_ +** _userhost_ +** _who_ +** _whois_ +** _whowas_ +* _signal_ : nom du signal (requis) +* _count_ : nombre de fois que la redirection sera exécutée (optionnel, 1 par défaut) -* 'string' : chaîne qui doit être dans les messages irc reçus (optionnel, mais +* _string_ : chaîne qui doit être dans les messages irc reçus (optionnel, mais recommandé, si une chaîne peut être utilisée pour identifier les messages) -* 'timeout' : temps d'attente maximum pour la redirection, en secondes +* _timeout_ : temps d'attente maximum pour la redirection, en secondes (optionnel, 60 par défaut) -* 'cmd_filter' : liste de commandes irc (séparées par des virgules) à filtrer +* _cmd_filter_ : liste de commandes irc (séparées par des virgules) à filtrer (seules ces commandes seront transmises au "callback", les autres seront ignorées) (optionnel) @@ -9538,20 +9538,20 @@ Immédiatement après l'envoi de ce hsignal, vous devez envoyer la commande au serveur irc, et la redirection sera utilisée pour cette commande. Lorsque la réponse complète à votre commande a été reçue, un hsignal est envoyé. -Ce hsignal a le nom 'irc_redirection_xxx_yyy' où 'xxx' est le 'signal' et 'yyy' -le 'pattern' utilisé. +Ce hsignal a le nom _irc_redirection_xxx_yyy_ où _xxx_ est le _signal_ et _yyy_ +le _pattern_ utilisé. La table de hachage envoyée dans le hsignal a le contenu suivant (les clés et valeurs sont des chaînes) : -* 'output' : sortie de la commande (les messages sont séparés par "\n") -* 'output_size' : nombre d'octets dans 'output' (sous forme de chaîne) -* 'error' : chaîne d'erreur (si une erreur s'est produite) : -** 'timeout' : redirection stoppée après le délai maximum dépassé -* 'server' : nom interne du serveur -* 'pattern' : modèle de redirection -* 'signal' : nom du signal -* 'command' : commande redirigée +* _output_ : sortie de la commande (les messages sont séparés par "\n") +* _output_size_ : nombre d'octets dans _output_ (sous forme de chaîne) +* _error_ : chaîne d'erreur (si une erreur s'est produite) : +** _timeout_ : redirection stoppée après le délai maximum dépassé +* _server_ : nom interne du serveur +* _pattern_ : modèle de redirection +* _signal_ : nom du signal +* _command_ : commande redirigée Exemple en C : @@ -9613,17 +9613,17 @@ redirection irc (voir <<hsignal_irc_redirect_command>>). Le paramètre est une table de hachage avec les entrées suivantes (les clés et valeurs sont des chaînes) : -* 'pattern' : nom du modèle (requis) -* 'timeout' : temps d'attente maximum pour le modèle, en secondes (optionnel, 60 +* _pattern_ : nom du modèle (requis) +* _timeout_ : temps d'attente maximum pour le modèle, en secondes (optionnel, 60 par défaut) -* 'cmd_start' : liste de commandes (séparées par des virgules) démarrant la +* _cmd_start_ : liste de commandes (séparées par des virgules) démarrant la redirection (optionnel) -* 'cmd_stop' : liste de commandes (séparées par des virgules) stoppant la +* _cmd_stop_ : liste de commandes (séparées par des virgules) stoppant la redirection (requis) -* 'cmd_extra' : liste de commandes (séparées par des virgules) pouvant être +* _cmd_extra_ : liste de commandes (séparées par des virgules) pouvant être reçues après les commandes de stop (optionnel) -Pour chaque commande dans 'cmd_start', 'cmd_stop' et 'cmd_extra', il est +Pour chaque commande dans _cmd_start_, _cmd_stop_ et _cmd_extra_, il est possible de donner un entier avec la position de la chaîne "string" qui doit être trouvée dans le message reçu, par exemple : @@ -9700,22 +9700,22 @@ struct t_hook *weechat_hook_config (const char *option, Paramètres : -* 'option' : option, le format est le nom complet, celui utilisé avec la +* _option_ : option, le format est le nom complet, celui utilisé avec la commande `/set` (par exemple : `weechat.look.item_time_format`), le caractère - joker "*" est autorisé (priorité autorisée, voir la note sur la + joker `+*+` est autorisé (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'callback' : fonction appelée lorsque l'option de configuration est modifiée, +* _callback_ : fonction appelée lorsque l'option de configuration est modifiée, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *option' : nom de l'option -** 'const char *value' : nouvelle valeur pour l'option +** _const void *pointer_ : pointeur +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -9780,26 +9780,26 @@ struct t_hook *weechat_hook_completion (const char *completion_item, Paramètres : -* 'completion_item' : nom de l'objet de complétion, après vous pouvez utiliser - '%(nom)' dans une commande (paramètre 'completion') +* _completion_item_ : nom de l'objet de complétion, après vous pouvez utiliser + _%(nom)_ dans une commande (paramètre _completion_) (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'description' : description de la complétion -* 'callback' : fonction appelée lorsque la complétion est utilisée +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** '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 +** _const void *pointer_ : pointeur +** _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 <<_hook_completion_list_add,weechat_hook_completion_list_add>>) ** valeur de retour : -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -9816,7 +9816,7 @@ et ne doit *PAS* mettre à jour la ligne de commande. + Pour mettre à jour la ligne de commande quand key[Tab] est pressé, vous pouvez utiliser la fonction <<_hook_command_run,weechat_hook_command_run>> avec la commande : "/input complete_next" (et vous devez retourner -'WEECHAT_RC_OK_EAT' si votre "callback" a mis à jour la ligne de commande, de +_WEECHAT_RC_OK_EAT_ si votre "callback" a mis à jour la ligne de commande, de sorte que WeeChat n'exécute pas la complétion). Valeur de retour : @@ -9877,11 +9877,11 @@ const char *weechat_hook_completion_get_string (struct t_gui_completion *complet Paramètres : -* 'completion' : pointeur vers la complétion -* 'property' : nom de la propriété : -** 'base_command' : commande utilisée pour la complétion -** 'base_word' : le mot qui va être complété -** 'args' : paramètres de la commande (incluant le mot de base "base_word") +* _completion_ : pointeur vers la complétion +* _property_ : nom de la propriété : +** _base_command_ : commande utilisée pour la complétion +** _base_word_ : le mot qui va être complété +** _args_ : paramètres de la commande (incluant le mot de base "base_word") Exemple en C : @@ -9934,13 +9934,13 @@ void weechat_hook_completion_list_add (struct t_gui_completion *completion, Paramètres : -* 'completion' : pointeur vers la complétion -* 'word' : mot à ajouter -* 'nick_completion' : 1 si le mot est un pseudo, sinon 0 -* 'where' : position où sera inséré le mot dans la liste : -** 'WEECHAT_LIST_POS_SORT' : n'importe où, pour maintenir la liste triée -** 'WEECHAT_LIST_POS_BEGINNING' : au début de la liste -** 'WEECHAT_LIST_POS_END' : à la fin de la liste +* _completion_ : pointeur vers la complétion +* _word_ : mot à ajouter +* _nick_completion_ : 1 si le mot est un pseudo, sinon 0 +* _where_ : position où sera inséré le mot dans la liste : +** _WEECHAT_LIST_POS_SORT_ : n'importe où, pour maintenir la liste triée +** _WEECHAT_LIST_POS_BEGINNING_ : au début de la liste +** _WEECHAT_LIST_POS_END_ : à la fin de la liste Exemple en C : voir <<_hook_completion,weechat_hook_completion>>. @@ -9976,21 +9976,21 @@ struct t_hook *weechat_hook_modifier (const char *modifier, Paramètres : -* 'modifier' : nom du modificateur, liste des modificateurs utilisés par WeeChat +* _modifier_ : nom du modificateur, liste des modificateurs utilisés par WeeChat ou des extensions (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) (voir le tableau ci-dessous) -* 'callback' : fonction appelée lorsque le modificateur est utilisé, paramètres +* _callback_ : fonction appelée lorsque le modificateur est utilisé, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *modifier' : nom du modificateur -** 'const char *modifier_data' : données pour le modificateur -** 'const char *string' : chaîne à modifier +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _const char *modifier_ : nom du modificateur +** _const char *modifier_data_ : données pour le modificateur +** _const char *string_ : chaîne à modifier ** valeur de retour : nouvelle chaîne -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -10120,8 +10120,8 @@ Liste des modificateurs utilisés par WeeChat et les extensions : |=== [NOTE] -^(1)^ 'xxx' est un nom de commande IRC. + -^(2)^ 'yyy' est le nom de la barre. +^(1)^ _xxx_ est un nom de commande IRC. + +^(2)^ _yyy_ est le nom de la barre. Exemple en C : @@ -10182,9 +10182,9 @@ char *weechat_hook_modifier_exec (const char *modifier, Paramètres : -* 'modifier' : nom du modificateur -* 'modifier_data' : données du modificateur -* 'string' : chaîne à modifier +* _modifier_ : nom du modificateur +* _modifier_data_ : données du modificateur +* _string_ : chaîne à modifier Valeur de retour : @@ -10232,21 +10232,21 @@ struct t_hook *weechat_hook_info (const char *info_name, Paramètres : -* 'info_name' : nom de l'information +* _info_name_ : nom de l'information (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 et +* _description_ : description +* _args_description_ : description des paramètres (optionnel, peut être NULL) +* _callback_ : fonction appelée quand l'information est demandée, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *info_name' : nom de l'information -** 'const char *arguments' : paramètres additionnels, dépendant de +** _const void *pointer_ : pointeur +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -10315,24 +10315,24 @@ struct t_hook *weechat_hook_info_hashtable (const char *info_name, Paramètres : -* 'info_name' : nom de l'information +* _info_name_ : nom de l'information (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'description' : description -* 'args_description' : description de la table de hachage attendue +* _description_ : description +* _args_description_ : description de la table de hachage attendue (optionnel, peut être NULL) -* 'output_description' : description de la table de hachage retournée par le +* _output_description_ : description de la table de hachage retournée par le "callback" (optionnel, peut être NULL) -* 'callback' : fonction appelée quand l'information est demandée, paramètres et +* _callback_ : fonction appelée quand l'information est demandée, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *info_name' : nom de l'information -** 'struct t_hashtable *hashtable' : table de hachage, dépendant de +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _const char *info_name_ : nom de l'information +** _struct t_hashtable *hashtable_ : table de hachage, dépendant de l'information ** valeur de retour : table de hachage demandée -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -10405,23 +10405,23 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, Paramètres : -* 'infolist_name' : nom de l'infolist +* _infolist_name_ : nom de l'infolist (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* '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 et +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *infolist_name' : nom de l'infolist -** 'void *pointer' : pointeur vers un objet que l'infolist doit retourner (pour +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _const char *infolist_name_ : nom de l'infolist +** _void *pointer_ : pointeur vers un objet que l'infolist doit retourner (pour obtenir uniquement cet objet dans l'infolist) -** 'const char *arguments' : paramètres additionnels, dépendant de l'infolist +** _const char *arguments_ : paramètres additionnels, dépendant de l'infolist ** valeur de retour : infolist demandée -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -10494,18 +10494,18 @@ struct t_hook *weechat_hook_hdata (const char *hdata_name, Paramètres : -* 'hdata_name' : nom du hdata +* _hdata_name_ : nom du hdata (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'description' : description -* 'callback' : fonction appelée quand le hdata est demandé, paramètres et valeur +* _description_ : description +* _callback_ : fonction appelée quand le hdata est demandé, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'const char *hdata_name' : nom du hdata +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _const char *hdata_name_ : nom du hdata ** valeur de retour : hdata demandé -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -10559,23 +10559,23 @@ struct t_hook *weechat_hook_focus (const char *area, Paramètres : -* 'area' : "chat" pour la zone de discussion, ou un nom d'objet de barre +* _area_ : "chat" pour la zone de discussion, ou un nom d'objet de barre (priorité autorisée, voir la note sur la <<hook_priority,priorité>>) -* 'callback' : fonction appelée quand le focus est fait, paramètres et valeur de +* _callback_ : fonction appelée quand le focus est fait, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_hashtable *info' : table de hachage avec les informations sur le +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_hashtable *info_ : table de hachage avec les informations sur le focus et les chaînes retournées par les autres appels aux "callbacks" de focus (avec plus haute priorité) (voir le tableau ci-dessous) ** valeur de retour : soit le pointeur vers la table de hachage "info" (avec la table de hachage complétée), ou un pointeur vers une nouvelle table de hachage (créée par le "callback", avec clés et valeurs de type "string"), le - contenu de cette nouvelle table de hachage sera ajouté à 'info' pour les + contenu de cette nouvelle table de hachage sera ajouté à _info_ pour les autres appels aux "callbacks" focus -* 'callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le "hook" est supprimé @@ -10766,9 +10766,9 @@ void weechat_hook_set (struct t_hook *hook, const char *property, Paramètres : -* 'hook' : quelque chose d'accroché avec "weechat_hook_xxx()" -* 'property' : nom de la propriété (voir le tableau ci-dessous) -* 'value' : nouvelle valeur pour la propriété +* _hook_ : quelque chose d'accroché avec "weechat_hook_xxx()" +* _property_ : nom de la propriété (voir le tableau ci-dessous) +* _value_ : nouvelle valeur pour la propriété Propriétés : @@ -10778,22 +10778,22 @@ Propriétés : | subplugin | tout type | toute chaîne | Nom de la sous-extension (couramment un nom de script, qui est affiché dans - `/help commande` pour un hook de type 'command') + `/help commande` pour un hook de type _command_) | stdin + _(WeeChat ≥ 0.4.3)_ | - 'process', 'process_hashtable' | toute chaîne | - Envoyer les données sur l'entrée standard ('stdin') du processus fils + _process_, _process_hashtable_ | toute chaîne | + Envoyer les données sur l'entrée standard (_stdin_) du processus fils | stdin_close + _(WeeChat ≥ 0.4.3)_ | - 'process', 'process_hashtable' | (non utilisée) | + _process_, _process_hashtable_ | (non utilisée) | Fermer le tuyau utilisé pour envoyer les données sur l'entrée standard - ('stdin') du processus fils + (_stdin_) du processus fils | signal + _(WeeChat ≥ 1.0)_ | - 'process', 'process_hashtable' | + _process_, _process_hashtable_ | numéro de signal ou un de ces noms : `hup`, `int`, `quit`, `kill`, `term`, `usr1`, `usr2` | Envoyer un signal au processus fils @@ -10841,7 +10841,7 @@ void weechat_unhook (struct t_hook *hook); Paramètres : -* 'hook' : quelque chose accroché avec "weechat_hook_xxx()" +* _hook_ : quelque chose accroché avec "weechat_hook_xxx()" Exemple en C : @@ -10878,7 +10878,7 @@ void weechat_unhook_all (const char *subplugin); Paramètres : -* 'subplugin' : si non NULL, décrocher uniquement les "hooks" qui ont ce +* _subplugin_ : si non NULL, décrocher uniquement les "hooks" qui ont ce "subplugin" défini (ce paramètre n'est pas disponible dans l'API script) Exemple en C : @@ -10930,33 +10930,33 @@ struct t_gui_buffer *weechat_buffer_new (const char *name, Paramètres : -* 'name' : nom du tampon (doit être unique pour l'extension) -* 'input_callback' : fonction appelée lorsque du texte saisi est envoyé au +* _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 et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_gui_buffer *buffer' : pointeur vers le tampon -** 'const char *input_data' : données en entrée +** _const void *pointer_ : pointeur +** _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' -* 'input_callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _input_callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'input_callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _input_callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le tampon est fermé -* 'close_callback' : fonction appelée lorsque le tampon est fermé, paramètres et +* _close_callback_ : fonction appelée lorsque le tampon est fermé, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_gui_buffer *buffer' : pointeur vers le tampon +** _const void *pointer_ : pointeur +** _void *data_ : pointeur +** _struct t_gui_buffer *buffer_ : pointeur vers le tampon ** valeur de retour : -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'close_callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _close_callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'close_callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _close_callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le tampon est fermé @@ -11060,11 +11060,11 @@ struct t_gui_buffer *weechat_buffer_search (const char *plugin, Paramètres : -* 'plugin' : nom de l'extension, la valeur spéciale suivante est autorisée : -** `==` : le nom utilisé est le nom complet du tampon (par exemple : +* _plugin_ : nom de l'extension, la valeur spéciale suivante est autorisée : +** `+==+` : le nom utilisé est le nom complet du tampon (par exemple : `irc.freenode.#weechat` au lieu de `freenode.#weechat`) _(WeeChat ≥ 1.0)_ -* 'name' : nom du tampon, si c'est NULL ou une chaîne vide, le tampon courant +* _name_ : nom du tampon, si c'est NULL ou une chaîne vide, le tampon courant est retourné (tampon affiché par la fenêtre courante); si le nom commence par `(?i)`, la recherche est insensible à la casse _(WeeChat ≥ 1.0)_ @@ -11093,7 +11093,7 @@ buffer = weechat.buffer_search("mon_extension", "mon_tampon") ==== buffer_search_main -Rechercher le tampon principal de WeeChat (tampon 'core', premier tampon +Rechercher le tampon principal de WeeChat (tampon _core_, premier tampon affiché lorsque WeeChat démarre). Prototype : @@ -11105,7 +11105,7 @@ struct t_gui_buffer *weechat_buffer_search_main (); Valeur de retour : -* pointeur vers le tampon principal WeeChat (tampon 'core') +* pointeur vers le tampon principal WeeChat (tampon _core_) Exemple en C : @@ -11138,7 +11138,7 @@ void weechat_buffer_clear (struct t_gui_buffer *buffer); Paramètres : -* 'buffer' : pointeur vers le tampon +* _buffer_ : pointeur vers le tampon Exemple en C : @@ -11178,7 +11178,7 @@ void weechat_buffer_close (struct t_gui_buffer *buffer); Paramètres : -* 'buffer' : pointeur vers le tampon +* _buffer_ : pointeur vers le tampon Exemple en C : @@ -11220,8 +11220,8 @@ void weechat_buffer_merge (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'target_buffer' : tampon cible avec lequel on doit mélanger +* _buffer_ : pointeur vers le tampon +* _target_buffer_ : tampon cible avec lequel on doit mélanger Exemple en C : @@ -11258,8 +11258,8 @@ void weechat_buffer_unmerge (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'number' : numéro cible pour le tampon détaché, s'il est < 1, alors le tampon +* _buffer_ : pointeur vers le tampon +* _number_ : numéro cible pour le tampon détaché, s'il est < 1, alors le tampon sera déplacé vers le numéro du tampon + 1 Exemple en C : @@ -11294,56 +11294,56 @@ int weechat_buffer_get_integer (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'property' : nom de la propriété : -** 'number' : numéro du tampon (commence à 1) -** 'layout_number' : numéro du tampon sauvegardé dans le "layout" -** 'layout_number_merge_order' : ordre du tampon mélangé pour le "layout" -** 'short_name_is_set' : 1 si le nom court est défini, 0 si non défini -** 'type' : type de tampon (0 : formaté, 1 : contenu libre) -** 'notify' : niveau de notification du tampon -** 'num_displayed' : nombre de fenêtres affichant ce tampon -** 'active' : 2 si le tampon est le seul actif (mélangé), 1 si le tampon est +* _buffer_ : pointeur vers le tampon +* _property_ : nom de la propriété : +** _number_ : numéro du tampon (commence à 1) +** _layout_number_ : numéro du tampon sauvegardé dans le "layout" +** _layout_number_merge_order_ : ordre du tampon mélangé pour le "layout" +** _short_name_is_set_ : 1 si le nom court est défini, 0 si non défini +** _type_ : type de tampon (0 : formaté, 1 : contenu libre) +** _notify_ : niveau de notification du tampon +** _num_displayed_ : nombre de fenêtres affichant ce tampon +** _active_ : 2 si le tampon est le seul actif (mélangé), 1 si le tampon est actif, 0 si le tampon est mélangé et n'est pas sélectionné -** 'hidden' : 1 si le tampon est caché, sinon 0 +** _hidden_ : 1 si le tampon est caché, sinon 0 _(WeeChat ≥ 1.0)_ -** 'zoomed' : 1 si le tampon est mélangé et zoomé, sinon 0 +** _zoomed_ : 1 si le tampon est mélangé et zoomé, sinon 0 _(WeeChat ≥ 1.0)_ -** 'print_hooks_enabled' : 1 si les hooks "print" sont activés, sinon 0 -** 'day_change' : 1 si les messages de changement de jour sont affichés, sinon 0 +** _print_hooks_enabled_ : 1 si les hooks "print" sont activés, sinon 0 +** _day_change_ : 1 si les messages de changement de jour sont affichés, sinon 0 _(WeeChat ≥ 0.4.3)_ -** 'clear' : 1 si le tampon peut être effacé avec la commande `/buffer clear`, +** _clear_ : 1 si le tampon peut être effacé avec la commande `/buffer clear`, sinon 0 _(WeeChat ≥ 1.0)_ -** 'filter' : 1 si les filtres sont activés sur le tampon, sinon 0 +** _filter_ : 1 si les filtres sont activés sur le tampon, sinon 0 _(WeeChat ≥ 1.0)_ -** 'lines_hidden' : 1 si au moins une ligne est cachée dans le tampon +** _lines_hidden_ : 1 si au moins une ligne est cachée dans le tampon (filtrée), ou 0 si toutes les lignes sont affichées -** 'prefix_max_length' : longueur maximale du préfixe dans ce tampon -** 'time_for_each_line' : 1 si l'heure est affichée pour chaque ligne du tampon +** _prefix_max_length_ : longueur maximale du préfixe dans ce tampon +** _time_for_each_line_ : 1 si l'heure est affichée pour chaque ligne du tampon (par défaut), sinon 0 -** 'nicklist' : 1 si la liste de pseudos est activée, sinon 0 -** 'nicklist_case_sensitive' : 1 si les pseudos sont sensibles à la casse, +** _nicklist_ : 1 si la liste de pseudos est activée, sinon 0 +** _nicklist_case_sensitive_ : 1 si les pseudos sont sensibles à la casse, sinon 0 -** 'nicklist_max_length' : longueur maximale d'un pseudo -** 'nicklist_display_groups' : 1 si les groupes sont affichés, sinon 0 -** 'nicklist_count' : nombre de pseudos et groupes dans la liste de pseudos -** 'nicklist_groups_count' : nombre de groupes dans la liste de pseudos -** 'nicklist_nicks_count' : nombre de pseudos dans la liste de pseudos -** 'nicklist_visible_count' : nombre de pseudos/groupes affichés -** 'input' : 1 si la zone de saisie est activée, sinon 0 -** 'input_get_unknown_commands' : 1 si les commandes inconnues sont envoyées +** _nicklist_max_length_ : longueur maximale d'un pseudo +** _nicklist_display_groups_ : 1 si les groupes sont affichés, sinon 0 +** _nicklist_count_ : nombre de pseudos et groupes dans la liste de pseudos +** _nicklist_groups_count_ : nombre de groupes dans la liste de pseudos +** _nicklist_nicks_count_ : nombre de pseudos dans la liste de pseudos +** _nicklist_visible_count_ : nombre de pseudos/groupes affichés +** _input_ : 1 si la zone de saisie est activée, sinon 0 +** _input_get_unknown_commands_ : 1 si les commandes inconnues sont envoyées au "callback input", sinon 0 -** 'input_size' : taille de la zone de saisie (en octets) -** 'input_length' : longueur de la zone de saisie (nombre de caractères) -** 'input_pos' : position du curseur dans la zone de saisie -** 'input_1st_display' : premier caractère affiché à l'écran -** 'num_history' : nombre de commandes dans l'historique -** 'text_search' : type de recherche de texte : +** _input_size_ : taille de la zone de saisie (en octets) +** _input_length_ : longueur de la zone de saisie (nombre de caractères) +** _input_pos_ : position du curseur dans la zone de saisie +** _input_1st_display_ : premier caractère affiché à l'écran +** _num_history_ : nombre de commandes dans l'historique +** _text_search_ : type de recherche de texte : *** 0 : pas de recherche en cours *** 1 : recherche arrière (vers les messages les plus anciens) *** 2 : recherche avant (vers les messages les plus récents) -** 'text_search_exact' : 1 si la recherche de texte est sensible à la casse -** 'text_search_found' : 1 si du texte a été trouvé, sinon 0 +** _text_search_exact_ : 1 si la recherche de texte est sensible à la casse +** _text_search_found_ : 1 si du texte a été trouvé, sinon 0 Valeur de retour : @@ -11382,27 +11382,27 @@ const char *weechat_buffer_get_string (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'property' : nom de la propriété : -** 'plugin' : nom de l'extension qui a créé ce tampon ("core" pour le tampon +* _buffer_ : pointeur vers le tampon +* _property_ : nom de la propriété : +** _plugin_ : nom de l'extension qui a créé ce tampon ("core" pour le tampon principal WeeChat) -** 'name' : nom du tampon -** 'full_name' : nom complet du tampon ("extension.nom") _(WeeChat ≥ 0.3.7)_ -** 'short_name' : nom court du tampon (note : utilisé pour l'affichage +** _name_ : nom du tampon +** _full_name_ : nom complet du tampon ("extension.nom") _(WeeChat ≥ 0.3.7)_ +** _short_name_ : nom court du tampon (note : utilisé pour l'affichage seulement et peut être changé par l'utilisateur, il ne doit pas être utilisé - pour trouver le nom du tampon, utilisez à la place 'name', 'full_name' ou - bien la variable locale 'channel') -** 'title' : titre du tampon -** 'input' : texte saisi -** 'text_search_input' : texte saisi sauvegardé avant la recherche de texte -** 'highlight_words' : liste des mots pour le highlight -** 'highlight_regex' : expression régulière POSIX étendue pour le highlight -** 'highlight_tags_restrict' : restreindre les highlights aux messages + pour trouver le nom du tampon, utilisez à la place _name_, _full_name_ ou + bien la variable locale _channel_) +** _title_ : titre du tampon +** _input_ : texte saisi +** _text_search_input_ : texte saisi sauvegardé avant la recherche de texte +** _highlight_words_ : liste des mots pour le highlight +** _highlight_regex_ : expression régulière POSIX étendue pour le highlight +** _highlight_tags_restrict_ : restreindre les highlights aux messages comportant ces étiquettes -** 'highlight_tags' : forcer le highlight pour les messages avec ces étiquettes -** 'hotlist_max_level_nicks' : niveau maximum pour la hotlist pour certains +** _highlight_tags_ : forcer le highlight pour les messages avec ces étiquettes +** _hotlist_max_level_nicks_ : niveau maximum pour la hotlist pour certains pseudos -** 'localvar_xxx' : contenu de la variable locale "xxx" (remplacer "xxx" par le +** _localvar_xxx_ : contenu de la variable locale "xxx" (remplacer "xxx" par le nom de la variable locale à lire) Valeur de retour : @@ -11445,11 +11445,11 @@ void *weechat_buffer_pointer (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'property' : nom de la propriété : -** 'plugin' : pointeur vers l'extension qui a créé le tampon (NULL pour le +* _buffer_ : pointeur vers le tampon +* _property_ : nom de la propriété : +** _plugin_ : pointeur vers l'extension qui a créé le tampon (NULL pour le tampon principal WeeChat) -** 'highlight_regex_compiled' : expression régulière 'highlight_regex' compilée +** _highlight_regex_compiled_ : expression régulière _highlight_regex_ compilée Valeur de retour : @@ -11488,9 +11488,9 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'property' : nom de la propriété (voir le tableau ci-dessous) -* 'value' : nouvelle valeur pour la propriété +* _buffer_ : pointeur vers le tampon +* _property_ : nom de la propriété (voir le tableau ci-dessous) +* _value_ : nouvelle valeur pour la propriété Propriétés : @@ -11538,7 +11538,7 @@ Propriétés : | type | "formatted" ou "free" | Définit le type de tampon : "formatted" (pour afficher les messages d'une discussion), ou "free" (pour du contenu libre); lorsque la valeur est "free", - la propriété 'clear' est forcée à "0" _(WeeChat ≥ 1.0)_ + la propriété _clear_ est forcée à "0" _(WeeChat ≥ 1.0)_ | notify | "0", "1", "2", "3" | Définit le niveau de notification du tampon : "0" = ne jamais ajouter à la @@ -11627,11 +11627,11 @@ Propriétés : Liste de pseudos à supprimer des niveaux max de hotlist | key_bind_xxx | toute chaîne | - Associe la nouvelle touche 'xxx', spécifique à ce tampon, la valeur est la + Associe la nouvelle touche _xxx_, spécifique à ce tampon, la valeur est la commande à exécuter pour cette touche | key_unbind_xxx | - | - Supprime la touche 'xxx' pour ce tampon + Supprime la touche _xxx_ pour ce tampon | input | toute chaîne | Change le contenu de la zone de saisie @@ -11646,11 +11646,11 @@ Propriétés : sur la commande inconnue) | localvar_set_xxx | toute chaîne | - Change la valeur de la variable locale 'xxx' (la variable est créée si elle + Change la valeur de la variable locale _xxx_ (la variable est créée si elle n'existe pas) | localvar_del_xxx | - | - Supprime la variable locale 'xxx' + Supprime la variable locale _xxx_ |=== Exemple en C : @@ -11712,21 +11712,21 @@ void weechat_buffer_set_pointer (struct t_gui_buffer *buffer, const char *proper Paramètres : -* 'buffer' : pointeur vers le tampon -* 'property' : nom de la propriété : -** 'close_callback' : définit la fonction "callback" de fermeture du tampon -** 'close_callback_data' : définit les données pour le "callback" de fermeture +* _buffer_ : pointeur vers le tampon +* _property_ : nom de la propriété : +** _close_callback_ : définit la fonction "callback" de fermeture du tampon +** _close_callback_data_ : définit les données pour le "callback" de fermeture du tampon -** 'input_callback' : définit la fonction de "callback" pour les données en +** _input_callback_ : définit la fonction de "callback" pour les données en entrée -** 'input_callback_data' : définit les données pour le "callback" des données +** _input_callback_data_ : définit les données pour le "callback" des données en entrée -** 'nickcmp_callback' : définit la fonction "callback" de comparaison de pseudos +** _nickcmp_callback_ : définit la fonction "callback" de comparaison de pseudos (ce "callback" est appelé lors de la recherche d'un pseudo dans la liste des pseudos) _(WeeChat ≥ 0.3.9)_ -** 'nickcmp_callback_data' : définit les données pour le "callback" de +** _nickcmp_callback_data_ : définit les données pour le "callback" de comparaison de pseudos _(WeeChat ≥ 0.3.9)_ -* 'pointer' : nouvelle valeur de pointeur pour la propriété +* _pointer_ : nouvelle valeur de pointeur pour la propriété Prototypes pour les "callbacks" : @@ -11775,8 +11775,8 @@ char *weechat_buffer_string_replace_local_var (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'string' : chaîne avec du texte et des variables locales, au format "$var" +* _buffer_ : pointeur vers le tampon +* _string_ : chaîne avec du texte et des variables locales, au format "$var" Valeur de retour : @@ -11821,11 +11821,11 @@ int weechat_buffer_match_list (struct t_gui_buffer *buffer, const char *string); Paramètres : -* 'buffer' : pointeur vers le tampon -* 'string' : liste de tampons, séparés par des virgules : -** "*" signifie tous les tampons -** un nom commençant par "!" est exclu -** le caractère joker "*" est autorisé dans le nom +* _buffer_ : pointeur vers le tampon +* _string_ : liste de tampons, séparés par des virgules : +** `+*+` signifie tous les tampons +** un nom commençant par `+!+` est exclu +** le caractère joker `+*+` est autorisé dans le nom Valeur de retour : @@ -11914,7 +11914,7 @@ struct t_gui_window *weechat_window_search_with_buffer (struct t_gui_buffer *buf Paramètre : -* 'buffer' : pointeur vers le tampon +* _buffer_ : pointeur vers le tampon Valeur de retour : @@ -11956,32 +11956,32 @@ int weechat_window_get_integer (struct t_gui_window *window, Paramètres : -* 'window' : pointeur vers la fenêtre -* 'property' : nom de la propriété : -** 'number' : numéro de la fenêtre (commence à 1) -** 'win_x' : position X de la fenêtre dans le terminal (la première colonne est +* _window_ : pointeur vers la fenêtre +* _property_ : nom de la propriété : +** _number_ : numéro de la fenêtre (commence à 1) +** _win_x_ : position X de la fenêtre dans le terminal (la première colonne est 0) -** 'win_y' : position Y de la fenêtre dans le terminal (la première ligne est +** _win_y_ : position Y de la fenêtre dans le terminal (la première ligne est 0) -** 'win_width' : largeur de la fenêtre, en caractères -** 'win_height' : hauteur de la fenêtre, en caractères -** 'win_width_pct' : taille en pourcentage, en comparaison avec la fenêtre +** _win_width_ : largeur de la fenêtre, en caractères +** _win_height_ : hauteur de la fenêtre, en caractères +** _win_width_pct_ : taille en pourcentage, en comparaison avec la fenêtre parente (par exemple 50 indique une largeur de moitié) -** 'win_height_pct' : taille en pourcentage, en comparaison avec la fenêtre +** _win_height_pct_ : taille en pourcentage, en comparaison avec la fenêtre parente (par exemple 50 indique une hauteur de moitié) -** 'win_chat_x' : position X de la fenêtre de discussion ("chat") dans le +** _win_chat_x_ : position X de la fenêtre de discussion ("chat") dans le terminal (la première colonne est 0) -** 'win_chat_y' : position Y de la fenêtre de discussion ("chat") dans le +** _win_chat_y_ : position Y de la fenêtre de discussion ("chat") dans le terminal (la première ligne est 0) -** 'win_chat_width' : largeur de la fenêtre de discussion ("chat"), en +** _win_chat_width_ : largeur de la fenêtre de discussion ("chat"), en caractères -** 'win_chat_height' : hauteur de la fenêtre de discussion ("chat"), en +** _win_chat_height_ : hauteur de la fenêtre de discussion ("chat"), en caractères -** 'first_line_displayed' : 1 si la première du tampon est affichée à l'écran, +** _first_line_displayed_ : 1 si la première du tampon est affichée à l'écran, sinon 0 -** 'scrolling' : 1 s'il y a un défilement en cours dans la fenêtre (la dernière +** _scrolling_ : 1 s'il y a un défilement en cours dans la fenêtre (la dernière ligne n'est pas affichée) -** 'lines_after' : nombre de lignes non affichées après la dernière ligne +** _lines_after_ : nombre de lignes non affichées après la dernière ligne affichée (lors d'un défilement) Valeur de retour : @@ -12028,8 +12028,8 @@ int weechat_window_get_string (struct t_gui_window *window, Paramètres : -* 'window' : pointeur vers la fenêtre -* 'property' : nom de la propriété +* _window_ : pointeur vers la fenêtre +* _property_ : nom de la propriété Valeur de retour : @@ -12049,10 +12049,10 @@ void *weechat_window_get_pointer (struct t_gui_window *window, Paramètres : -* 'window' : pointeur vers la fenêtre -* 'property' : nom de la propriété : -** 'current' : pointeur vers la fenêtre courante -** 'buffer' : pointeur vers le tampon affiché par la fenêtre +* _window_ : pointeur vers la fenêtre +* _property_ : nom de la propriété : +** _current_ : pointeur vers la fenêtre courante +** _buffer_ : pointeur vers le tampon affiché par la fenêtre Valeur de retour : @@ -12092,7 +12092,7 @@ void weechat_window_set_title (const char *title); Paramètres : -* 'title' : nouveau titre pour le terminal (NULL pour réinitialiser le titre) +* _title_ : nouveau titre pour le terminal (NULL pour réinitialiser le titre) Exemple en C : @@ -12134,20 +12134,20 @@ struct t_gui_nick_group *weechat_nicklist_add_group (struct t_gui_buffer *buffer Paramètres : -* 'buffer' : pointeur vers le tampon -* 'parent_group' : pointeur vers le parent du groupe, NULL si le groupe n'a pas +* _buffer_ : pointeur vers le tampon +* _parent_group_ : pointeur vers le parent du groupe, NULL si le groupe n'a pas de parent (racine de la liste des pseudos) -* 'name' : nom du groupe -* 'color' : nom de l'option contenant la couleur : -** une option WeeChat, par exemple 'weechat.color.nicklist_group' -** une couleur avec un fond optionnel, par exemple 'yellow' ou 'yellow,red' +* _name_ : nom du groupe +* _color_ : nom de l'option contenant la couleur : +** une option WeeChat, par exemple _weechat.color.nicklist_group_ +** une couleur avec un fond optionnel, par exemple _yellow_ ou _yellow,red_ ** nom d'une couleur de barre : -*** 'bar_fg' : couleur de texte pour la barre -*** 'bar_delim' : couleur des délimiteurs pour la barre -*** 'bar_bg' : couleur de fond pour la barre -* 'visible' : -** '1' : le groupe et ses sous-groupes/pseudos sont visibles -** '0' : le groupe et ses sous-groupes/pseudos sont cachés +*** _bar_fg_ : couleur de texte pour la barre +*** _bar_delim_ : couleur des délimiteurs pour la barre +*** _bar_bg_ : couleur de fond pour la barre +* _visible_ : +** _1_ : le groupe et ses sous-groupes/pseudos sont visibles +** _0_ : le groupe et ses sous-groupes/pseudos sont cachés [NOTE] Le nom du groupe peut commencer par un ou plusieurs chiffres, suivis d'un pipe @@ -12199,10 +12199,10 @@ struct t_gui_nick_group *weechat_nicklist_search_group (struct t_gui_buffer *buf Paramètres : -* 'buffer' : pointeur vers le tampon -* 'from_group' : recherche depuis ce groupe seulement, si NULL, alors recherche +* _buffer_ : pointeur vers le tampon +* _from_group_ : recherche depuis ce groupe seulement, si NULL, alors recherche dans toute la liste des pseudos -* 'name' : nom du groupes à rechercher +* _name_ : nom du groupes à rechercher Valeur de retour : @@ -12246,27 +12246,27 @@ struct t_gui_nick_group *weechat_nicklist_add_nick (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers le groupe -* 'name' : nom du pseudo -* 'color' : nom de l'option contenant la couleur pour le pseudo : -** une option WeeChat, par exemple 'weechat.color.nicklist_group' -** une couleur avec un fond optionnel, par exemple 'yellow' ou 'yellow,red' +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers le groupe +* _name_ : nom du pseudo +* _color_ : nom de l'option contenant la couleur pour le pseudo : +** une option WeeChat, par exemple _weechat.color.nicklist_group_ +** une couleur avec un fond optionnel, par exemple _yellow_ ou _yellow,red_ ** nom d'une couleur de barre : -*** 'bar_fg' : couleur de texte pour la barre -*** 'bar_delim' : couleur des délimiteurs pour la barre -*** 'bar_bg' : couleur de fond pour la barre -* 'prefix' : préfixe affiché avant le pseudo -* 'prefix_color' : nom de l'option contenant la couleur pour le préfixe : -** une option WeeChat, par exemple 'weechat.color.nicklist_group' -** une couleur avec un fond optionnel, par exemple 'yellow' ou 'yellow,red' +*** _bar_fg_ : couleur de texte pour la barre +*** _bar_delim_ : couleur des délimiteurs pour la barre +*** _bar_bg_ : couleur de fond pour la barre +* _prefix_ : préfixe affiché avant le pseudo +* _prefix_color_ : nom de l'option contenant la couleur pour le préfixe : +** une option WeeChat, par exemple _weechat.color.nicklist_group_ +** une couleur avec un fond optionnel, par exemple _yellow_ ou _yellow,red_ ** nom d'une couleur de barre : -*** 'bar_fg' : couleur de texte pour la barre -*** 'bar_delim' : couleur des délimiteurs pour la barre -*** 'bar_bg' : couleur de fond pour la barre -* 'visible' : -** '1' : le pseudo est visible -** '0' : le pseudo est caché +*** _bar_fg_ : couleur de texte pour la barre +*** _bar_delim_ : couleur des délimiteurs pour la barre +*** _bar_bg_ : couleur de fond pour la barre +* _visible_ : +** _1_ : le pseudo est visible +** _0_ : le pseudo est caché Valeur de retour : @@ -12314,10 +12314,10 @@ struct t_gui_nick *weechat_nicklist_search_nick (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'from_group' : recherche depuis ce groupe seulement, si NULL, alors recherche +* _buffer_ : pointeur vers le tampon +* _from_group_ : recherche depuis ce groupe seulement, si NULL, alors recherche dans toute la liste des pseudos -* 'name' : nom du pseudo à rechercher +* _name_ : nom du pseudo à rechercher Valeur de retour : @@ -12356,8 +12356,8 @@ void weechat_nicklist_remove_group (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers le groupe à supprimer (tous les sous-groupes/pseudos +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers le groupe à supprimer (tous les sous-groupes/pseudos seront supprimés également) Exemple en C : @@ -12392,8 +12392,8 @@ void weechat_nicklist_remove_nick (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'nick' : pointeur vers le pseudo à supprimer +* _buffer_ : pointeur vers le tampon +* _nick_ : pointeur vers le pseudo à supprimer Exemple en C : @@ -12426,7 +12426,7 @@ void weechat_nicklist_remove_all (struct t_gui_buffer *buffer); Paramètres : -* 'buffer' : pointeur vers le tampon +* _buffer_ : pointeur vers le tampon Exemple en C : @@ -12464,9 +12464,9 @@ void weechat_nicklist_get_next_item (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers un pointeur sur le groupe -* 'nick' : pointeur vers un pointeur sur le pseudo +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers un pointeur sur le groupe +* _nick_ : pointeur vers un pointeur sur le pseudo Exemple en C : @@ -12514,11 +12514,11 @@ int weechat_nicklist_group_get_integer (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers le groupe -* 'property' : nom de la propriété : -** 'visible' : 1 si le groupe est visible, sinon 0 -** 'level' : niveau du groupe (la racine est 0) +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers le groupe +* _property_ : nom de la propriété : +** _visible_ : 1 si le groupe est visible, sinon 0 +** _level_ : niveau du groupe (la racine est 0) Valeur de retour : @@ -12559,11 +12559,11 @@ const char *weechat_nicklist_group_get_string (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers le groupe -* 'property' : nom de la propriété : -** 'name' : nom du groupe -** 'color' : couleur du groupe dans la liste des pseudos +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers le groupe +* _property_ : nom de la propriété : +** _name_ : nom du groupe +** _color_ : couleur du groupe dans la liste des pseudos Valeur de retour : @@ -12604,10 +12604,10 @@ void *weechat_nicklist_group_get_pointer (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers le groupe -* 'property' : nom de la propriété : -** 'parent' : pointeur vers le groupe parent +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers le groupe +* _property_ : nom de la propriété : +** _parent_ : pointeur vers le groupe parent Valeur de retour : @@ -12649,10 +12649,10 @@ void weechat_nicklist_group_set (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'group' : pointeur vers le groupe -* 'property' : nom de la propriété (voir le tableau ci-dessous) -* 'value' : nouvelle valeur pour la propriété +* _buffer_ : pointeur vers le tampon +* _group_ : pointeur vers le groupe +* _property_ : nom de la propriété (voir le tableau ci-dessous) +* _value_ : nouvelle valeur pour la propriété Propriétés : @@ -12718,10 +12718,10 @@ int weechat_nicklist_nick_get_integer (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'nick' : pointeur vers le pseudo -* 'property' : nom de la propriété : -** 'visible' : 1 si le pseudo est visible, sinon 0 +* _buffer_ : pointeur vers le tampon +* _nick_ : pointeur vers le pseudo +* _property_ : nom de la propriété : +** _visible_ : 1 si le pseudo est visible, sinon 0 Valeur de retour : @@ -12762,13 +12762,13 @@ const char *weechat_nicklist_nick_get_string (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'nick' : pointeur vers le pseudo -* 'property' : nom de la propriété : -** 'name' : nom du pseudo -** 'color' : couleur du pseudo dans la liste des pseudos -** 'prefix' : préfixe du pseudo -** 'prefix_color' : couleur du préfixe dans la liste des pseudos +* _buffer_ : pointeur vers le tampon +* _nick_ : pointeur vers le pseudo +* _property_ : nom de la propriété : +** _name_ : nom du pseudo +** _color_ : couleur du pseudo dans la liste des pseudos +** _prefix_ : préfixe du pseudo +** _prefix_color_ : couleur du préfixe dans la liste des pseudos Valeur de retour : @@ -12809,10 +12809,10 @@ void *weechat_nicklist_nick_get_pointer (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'nick' : pointeur vers le pseudo -* 'property' : nom de la propriété : -** 'group' : pointeur vers le groupe contenant ce pseudo +* _buffer_ : pointeur vers le tampon +* _nick_ : pointeur vers le pseudo +* _property_ : nom de la propriété : +** _group_ : pointeur vers le groupe contenant ce pseudo Valeur de retour : @@ -12854,10 +12854,10 @@ void weechat_nicklist_nick_set (struct t_gui_buffer *buffer, Paramètres : -* 'buffer' : pointeur vers le tampon -* 'nick' : pointeur vers le pseudo -* 'property' : nom de la propriété (voir le tableau ci-dessous) -* 'value' : nouvelle valeur pour la propriété +* _buffer_ : pointeur vers le tampon +* _nick_ : pointeur vers le pseudo +* _property_ : nom de la propriété (voir le tableau ci-dessous) +* _value_ : nouvelle valeur pour la propriété Propriétés : @@ -12937,7 +12937,7 @@ struct t_gui_bar_item *weechat_bar_item_search (const char *name); Paramètres : -* 'name' : nom de l'objet de barre +* _name_ : nom de l'objet de barre Valeur de retour : @@ -12984,23 +12984,23 @@ 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, paramètres +* _name_ : nom de l'objet de barre +* _build_callback_ : fonction appelée lorsque l'objet est construit, paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** '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 (NULL lors d'un +** _const void *pointer_ : pointeur +** _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 (NULL lors d'un appel pour une barre "root") -** 'struct t_gui_buffer *buffer' : tampon affiché dans la fenêtre (si la fenêtre +** _struct t_gui_buffer *buffer_ : tampon affiché dans la fenêtre (si la fenêtre est NULL alors c'est le tampon courant) ou tampon passé dans l'objet de barre avec la syntaxe : "@buffer:item" _(WeeChat ≥ 0.4.2)_ -** 'struct t_hashtable *extra_info' : toujours NULL (le paramètre est réservé +** _struct t_hashtable *extra_info_ : toujours NULL (le paramètre est réservé pour une version future) _(WeeChat ≥ 0.4.2)_ ** valeur de retour : contenu de l'objet de barre -* 'build_callback_pointer' : pointeur donné au "callback" lorsqu'il est appelé +* _build_callback_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'build_callback_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _build_callback_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque l'objet de barre est supprimé @@ -13032,8 +13032,8 @@ Script (Python) : [IMPORTANT] Pour la compatibilité avec les versions ≤ 0.4.1, le "callback" par défaut a -seulement 3 paramètres : 'data', 'item' et 'window' (pas de 'buffer' et -'extra_info'). + +seulement 3 paramètres : _data_, _item_ et _window_ (pas de _buffer_ et +_extra_info_). + Pour utiliser le callback avec tous les paramètres, vous devez ajouter "(extra)" avant le nom, voir l'exemple ci-dessous (supporté seulement dans WeeChat ≥ 0.4.2). @@ -13070,7 +13070,7 @@ void weechat_bar_item_update (const char *name); Paramètres : -* 'name' : nom de l'objet de barre +* _name_ : nom de l'objet de barre Exemple en C : @@ -13103,7 +13103,7 @@ void weechat_bar_item_remove (struct t_gui_bar_item *item); Paramètres : -* 'item' : bar item pointer +* _item_ : bar item pointer Exemple en C : @@ -13136,7 +13136,7 @@ struct t_gui_bar *weechat_bar_search (const char *name); Paramètres : -* 'name' : nom de la barre +* _name_ : nom de la barre Valeur de retour : @@ -13187,50 +13187,50 @@ struct t_gui_bar *weechat_bar_new (const char *name, Paramètres : -* 'name' : nom de la barre -* 'hidden' : -** 'on' : la barre est cachée -** 'off' : la barre est visible -* 'priority' : priorité de la barre (nombre entier) -* 'type' : -** 'root' : la barre est affichée une seule fois, hors des fenêtres -** 'window' : la barre est affichée dans chaque fenêtre -* 'condition' : condition pour afficher la barre : -** 'active' : la barre est affichée dans la fenêtre active seulement -** 'inactive' : la barre est affichée dans les fenêtres inactives seulement -** 'nicklist' : la barre est affichée dans les fenêtres possédant une liste des +* _name_ : nom de la barre +* _hidden_ : +** _on_ : la barre est cachée +** _off_ : la barre est visible +* _priority_ : priorité de la barre (nombre entier) +* _type_ : +** _root_ : la barre est affichée une seule fois, hors des fenêtres +** _window_ : la barre est affichée dans chaque fenêtre +* _condition_ : condition pour afficher la barre : +** _active_ : la barre est affichée dans la fenêtre active seulement +** _inactive_ : la barre est affichée dans les fenêtres inactives seulement +** _nicklist_ : la barre est affichée dans les fenêtres possédant une liste des pseudos ** expression évaluée : voir le chapitre sur les barres dans le - 'Guide utilisateur WeeChat' -* 'position' : 'top' (en haut), 'bottom' (en bas), 'left' (à gauche) ou 'right' + _Guide utilisateur WeeChat_ +* _position_ : _top_ (en haut), _bottom_ (en bas), _left_ (à gauche) ou _right_ (à droite) -* 'filling_top_bottom' : -** 'horizontal' : les objets sont remplis horizontalement (avec un espace +* _filling_top_bottom_ : +** _horizontal_ : les objets sont remplis horizontalement (avec un espace entre chaque objet) -** 'vertical' : les objets sont remplis verticalement (avec une nouvelle ligne +** _vertical_ : les objets sont remplis verticalement (avec une nouvelle ligne entre chaque objet) -** 'columns_horizontal' : les objets sont remplis horizontalement, affichés +** _columns_horizontal_ : les objets sont remplis horizontalement, affichés sous forme de colonnes -** 'columns_vertical' : les objets sont remplis verticalement, affichés sous +** _columns_vertical_ : les objets sont remplis verticalement, affichés sous forme de colonnes -* 'filling_left_right' : -** 'horizontal' : les objets sont remplis horizontalement (avec un espace +* _filling_left_right_ : +** _horizontal_ : les objets sont remplis horizontalement (avec un espace entre chaque objet) -** 'vertical' : les objets sont remplis verticalement (avec une nouvelle ligne +** _vertical_ : les objets sont remplis verticalement (avec une nouvelle ligne entre chaque objet) -** 'columns_horizontal' : les objets sont remplis horizontalement, affichés +** _columns_horizontal_ : les objets sont remplis horizontalement, affichés sous forme de colonnes -** 'columns_vertical' : les objets sont remplis verticalement, affichés sous +** _columns_vertical_ : les objets sont remplis verticalement, affichés sous forme de colonnes -* 'size' : taille de la barre en caractères (0 indique une taille automatique) -* 'size_max' : taille maximum de la barre (0 pour pas de maximum) -* 'color_fg' : couleur du texte dans la barre -* 'color_delim' : couleur pour les délimiteurs dans la barre -* 'color_bg' : couleur de fond pour la barre -* 'separator' : -** 'on' : la barre a un séparateur avec les autres fenêtres/barres -** 'off' : pas de séparateur -* 'items' : liste des objets dans la barre, séparés par une virgule (espace +* _size_ : taille de la barre en caractères (0 indique une taille automatique) +* _size_max_ : taille maximum de la barre (0 pour pas de maximum) +* _color_fg_ : couleur du texte dans la barre +* _color_delim_ : couleur pour les délimiteurs dans la barre +* _color_bg_ : couleur de fond pour la barre +* _separator_ : +** _on_ : la barre a un séparateur avec les autres fenêtres/barres +** _off_ : pas de séparateur +* _items_ : liste des objets dans la barre, séparés par une virgule (espace entre les objets), ou "+" (objets collés) Valeur de retour : @@ -13286,11 +13286,11 @@ int weechat_bar_set (struct t_gui_bar *bar, const char *property, Paramètres : -* 'bar' : pointeur vers la barre -* 'property' : name, hidden, priority, conditions, position, filling_top_bottom, +* _bar_ : pointeur vers la barre +* _property_ : name, hidden, priority, conditions, position, filling_top_bottom, filling_left_right, size, size_max, color_fg, color_delim, color_bg, separator, items (voir <<_bar_new,weechat_bar_new>>) -* 'value' : nouvelle valeur pour la propriété +* _value_ : nouvelle valeur pour la propriété Valeur de retour : @@ -13327,7 +13327,7 @@ void weechat_bar_update (const char *name); Paramètres : -* 'name' : nom de la barre +* _name_ : nom de la barre Exemple en C : @@ -13360,7 +13360,7 @@ void weechat_bar_remove (struct t_gui_bar *bar); Paramètres : -* 'bar' : pointeur vers la barre +* _bar_ : pointeur vers la barre Exemple en C : @@ -13400,15 +13400,15 @@ int weechat_command (struct t_gui_buffer *buffer, const char *command); Paramètres : -* 'buffer' : pointeur vers le tampon (la commande est exécutée sur ce tampon, +* _buffer_ : pointeur vers le tampon (la commande est exécutée sur ce tampon, NULL pour le tampon courant) -* 'command' : commande à exécuter (si elle commence par "/"), ou texte à +* _command_ : commande à exécuter (si elle commence par "/"), ou texte à envoyer au tampon Valeur de retour : (_WeeChat ≥ 1.1_) -* 'WEECHAT_RC_OK' si ok -* 'WEECHAT_RC_ERROR' si erreur +* _WEECHAT_RC_OK_ si ok +* _WEECHAT_RC_ERROR_ si erreur Exemple en C : @@ -13455,10 +13455,10 @@ int weechat_network_pass_proxy (const char *proxy, Paramètres : -* 'proxy' : nom du proxy à utiliser -* 'sock' : socket à utiliser -* 'address' : adresse (nom de machine ou adresse IP) -* 'port' : port +* _proxy_ : nom du proxy à utiliser +* _sock_ : socket à utiliser +* _address_ : adresse (nom de machine ou adresse IP) +* _port_ : port Valeur de retour : @@ -13502,9 +13502,9 @@ int weechat_network_connect_to (const char *proxy, Paramètres : -* 'proxy' : nom du proxy à utiliser -* 'address' : adresse où se connecter (avec le port) -* 'address_length' : longueur du paramètre 'address' +* _proxy_ : nom du proxy à utiliser +* _address_ : adresse où se connecter (avec le port) +* _address_length_ : longueur du paramètre _address_ Valeur de retour : @@ -13553,8 +13553,8 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Paramètres : -* 'info_name' : nom de l'information à lire (voir le tableau ci-dessous) -* 'arguments' : paramètres pour l'information demandée (optionnels, NULL si +* _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) Valeur de retour : @@ -13606,8 +13606,8 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Paramètres : -* 'info_name' : nom de l'information à lire (voir le tableau ci-dessous) -* 'hashtable' : table de hachage avec les paramètres (dépendant de l'information +* _info_name_ : nom de l'information à lire (voir le tableau ci-dessous) +* _hashtable_ : table de hachage avec les paramètres (dépendant de l'information demandée) (optionnel, NULL si aucun paramètre n'est nécessaire) Valeur de retour : @@ -13658,7 +13658,7 @@ if (hashtable_in) ---- [NOTE] -Voir le 'Guide pour Scripts WeeChat' pour plus d'infos sur la sortie de +Voir le _Guide pour Scripts WeeChat_ pour plus d'infos sur la sortie de "irc_message_parse". Script (Python) : @@ -13686,12 +13686,12 @@ IRC définis). Pour chaque objet, il y a des variables, comme "name", "buffer", Chaque variable a un type et une valeur. Les types possibles sont : -* 'integer' : nombre entier -* 'string' : chaîne de caractères -* 'pointer' : pointeur -* 'buffer' : tampon avec une taille fixe, peut contenir n'importe quel type de +* _integer_ : nombre entier +* _string_ : chaîne de caractères +* _pointer_ : pointeur +* _buffer_ : tampon avec une taille fixe, peut contenir n'importe quel type de données -* 'time' : date/heure +* _time_ : date/heure ==== infolist_new @@ -13739,7 +13739,7 @@ struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); Paramètres : -* 'infolist' : pointeur vers l'infolist +* _infolist_ : pointeur vers l'infolist Valeur de retour : @@ -13778,9 +13778,9 @@ struct t_infolist_var *weechat_infolist_new_var_integer (struct t_infolist_item Paramètres : -* 'item' : pointeur vers l'objet de l'infolist -* 'name' : nom de la variable -* 'value' : valeur +* _item_ : pointeur vers l'objet de l'infolist +* _name_ : nom de la variable +* _value_ : valeur Valeur de retour : @@ -13821,9 +13821,9 @@ struct t_infolist_var *weechat_infolist_new_var_string (struct t_infolist_item * Paramètres : -* 'item' : pointeur vers l'objet de l'infolist -* 'name' : nom de la variable -* 'value' : valeur +* _item_ : pointeur vers l'objet de l'infolist +* _name_ : nom de la variable +* _value_ : valeur Valeur de retour : @@ -13864,9 +13864,9 @@ struct t_infolist_var *weechat_infolist_new_var_pointer (struct t_infolist_item Paramètres : -* 'item' : pointeur vers l'objet de l'infolist -* 'name' : nom de la variable -* 'pointer' : pointeur +* _item_ : pointeur vers l'objet de l'infolist +* _name_ : nom de la variable +* _pointer_ : pointeur Valeur de retour : @@ -13908,10 +13908,10 @@ struct t_infolist_var *weechat_infolist_new_var_buffer (struct t_infolist_item * Paramètres : -* 'item' : pointeur vers l'objet de l'infolist -* 'name' : nom de la variable -* 'pointer' : pointeur -* 'size' : taille du tampon +* _item_ : pointeur vers l'objet de l'infolist +* _name_ : nom de la variable +* _pointer_ : pointeur +* _size_ : taille du tampon Valeur de retour : @@ -13947,9 +13947,9 @@ struct t_infolist_var *weechat_infolist_new_var_time (struct t_infolist_item *it Paramètres : -* 'item' : pointeur vers l'objet de l'infolist -* 'name' : nom de la variable -* 'time' : valeur +* _item_ : pointeur vers l'objet de l'infolist +* _name_ : nom de la variable +* _time_ : valeur Valeur de retour : @@ -13999,10 +13999,10 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Paramètres : -* 'infolist_name' : nom de l'infolist à lire (voir le tableau ci-dessous) -* 'pointer' : pointeur vers un objet, pour n'obtenir que celui-ci dans +* _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 +* _arguments_ : paramètres pour l'infolist demandée (optionnels, NULL si aucun paramètre n'est nécessaire) Valeur de retour : @@ -14046,7 +14046,7 @@ int weechat_infolist_next (struct t_infolist *infolist); Paramètres : -* 'infolist' : pointeur vers l'infolist +* _infolist_ : pointeur vers l'infolist Valeur de retour : @@ -14097,7 +14097,7 @@ int weechat_infolist_prev (struct t_infolist *infolist); Paramètres : -* 'infolist' : pointeur vers l'infolist +* _infolist_ : pointeur vers l'infolist Valeur de retour : @@ -14146,7 +14146,7 @@ void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); Paramètres : -* 'infolist' : pointeur vers l'infolist +* _infolist_ : pointeur vers l'infolist Exemple en C : @@ -14182,8 +14182,8 @@ struct t_infolist_var *weechat_infolist_search_var (struct t_infolist *infolist, Paramètres : -* 'infolist' : pointeur vers l'infolist -* 'name' : nom de la variable +* _infolist_ : pointeur vers l'infolist +* _name_ : nom de la variable Valeur de retour : @@ -14226,7 +14226,7 @@ const char *weechat_infolist_fields (struct t_infolist *infolist); Paramètres : -* 'infolist' : pointeur vers l'infolist +* _infolist_ : pointeur vers l'infolist Valeur de retour : @@ -14271,8 +14271,8 @@ int weechat_infolist_integer (struct t_infolist *infolist, const char *var); Paramètres : -* 'infolist' : pointeur vers l'infolist -* 'var' : nom de la variable (doit être de type "integer") +* _infolist_ : pointeur vers l'infolist +* _var_ : nom de la variable (doit être de type "integer") Valeur de retour : @@ -14311,8 +14311,8 @@ const char *weechat_infolist_string (struct t_infolist *infolist, const char *va Paramètres : -* 'infolist' : pointeur vers l'infolist -* 'var' : nom de la variable (doit être de type "string") +* _infolist_ : pointeur vers l'infolist +* _var_ : nom de la variable (doit être de type "string") Valeur de retour : @@ -14351,8 +14351,8 @@ void *weechat_infolist_pointer (struct t_infolist *infolist, const char *var); Paramètres : -* 'infolist' : pointeur vers l'infolist -* 'var' : nom de la variable (doit être de type "pointer") +* _infolist_ : pointeur vers l'infolist +* _var_ : nom de la variable (doit être de type "pointer") Valeur de retour : @@ -14392,9 +14392,9 @@ void *weechat_infolist_buffer (struct t_infolist *infolist, const char *var, Paramètres : -* 'infolist' : pointeur vers l'infolist -* 'var' : nom de la variable (doit être de type "buffer") -* 'size' : pointeur vers une variable entière, qui sera alimenté avec la taille +* _infolist_ : pointeur vers l'infolist +* _var_ : nom de la variable (doit être de type "buffer") +* _size_ : pointeur vers une variable entière, qui sera alimenté avec la taille de la zone Valeur de retour : @@ -14428,8 +14428,8 @@ time_t weechat_infolist_time (struct t_infolist *infolist, const char *var); Paramètres : -* 'infolist' : pointeur vers l'infolist -* 'var' : nom de la variable (doit être de type "time") +* _infolist_ : pointeur vers l'infolist +* _var_ : nom de la variable (doit être de type "time") Valeur de retour : @@ -14467,7 +14467,7 @@ void weechat_infolist_free (struct t_infolist *infolist); Paramètres : -* 'infolist' : pointeur vers l'infolist +* _infolist_ : pointeur vers l'infolist Exemple en C : @@ -14533,26 +14533,26 @@ struct t_hdata *weechat_hdata_new (const char *hdata_name, const char *var_prev, Paramètres : -* 'hdata_name' : nom du hdata -* 'var_prev' : nom de la variable dans la structure qui est un pointeur vers +* _hdata_name_ : nom du hdata +* _var_prev_ : nom de la variable dans la structure qui est un pointeur vers l'élément précédent dans la liste (peut être NULL si une telle variable n'existe pas) -* 'var_next' : nom de la variable dans la structure qui est un pointeur vers +* _var_next_ : nom de la variable dans la structure qui est un pointeur vers l'élément suivant dans la liste (peut être NULL si une telle variable n'existe pas) -* 'create_allowed' : 1 si la création de structure est autorisée, sinon 0 +* _create_allowed_ : 1 si la création de structure est autorisée, sinon 0 _(WeeChat ≥ 0.4.0)_ -* 'delete_allowed' : 1 si la suppression de structure est autorisée, sinon 0 +* _delete_allowed_ : 1 si la suppression de structure est autorisée, sinon 0 _(WeeChat ≥ 0.3.9)_ -* 'callback_update' : fonction appelée pour mettre à jour des données dans le +* _callback_update_ : fonction appelée pour mettre à jour des données dans le hdata, peut être NULL si aucune mise à jour n'est autorisée _(WeeChat ≥ 0.3.9)_, paramètres et valeur de retour : -** 'void *data' : pointeur -** 'struct t_hdata *hdata' : pointeur vers le hdata -** 'struct t_hashtable *hashtable' : table de hachage avec les variables à +** _void *data_ : pointeur +** _struct t_hdata *hdata_ : pointeur vers le hdata +** _struct t_hashtable *hashtable_ : table de hachage avec les variables à mettre à jour (voir <<_hdata_update,weechat_hdata_update>>) ** valeur de retour : nombre de variables mises à jour -* 'callback_update_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_update_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat _(WeeChat ≥ 0.3.9)_ Valeur de retour : @@ -14585,10 +14585,10 @@ void weechat_hdata_new_var (struct t_hdata *hdata, const char *name, int offset, Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la variable -* 'offset' : position (offset) de la variable dans la structure -* 'type' : type de la variable, un parmi ceux-ci : +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la variable +* _offset_ : position (offset) de la variable dans la structure +* _type_ : type de la variable, un parmi ceux-ci : ** WEECHAT_HDATA_CHAR ** WEECHAT_HDATA_INTEGER ** WEECHAT_HDATA_LONG @@ -14598,17 +14598,17 @@ Paramètres : ** WEECHAT_HDATA_TIME ** WEECHAT_HDATA_HASHTABLE ** WEECHAT_HDATA_OTHER -* 'update_allowed' : 1 si la mise à jour de la variable est autorisée, sinon 0 +* _update_allowed_ : 1 si la mise à jour de la variable est autorisée, sinon 0 _(WeeChat ≥ 0.3.9)_ -* 'array_size' : non NULL seulement si la variable est un tableau, et peut +* _array_size_ : non NULL seulement si la variable est un tableau, et peut être : _(WeeChat ≥ 0.3.9)_ ** nom d'une variable du hdata : cette variable sera utilisée comme taille de tableau (taille dynamique pour le tableau) ** entier (sous forme de chaîne) : taille fixe pour le tableau -** '*' : taille automatique : la taille est calculée en examinant les valeurs, +** _*_ : taille automatique : la taille est calculée en examinant les valeurs, lorsque le premier NULL est trouvé (seulement pour le type string, pointer ou hashtable) -* 'hdata_name' : nom d'un hdata (si c'est un pointeur vers une structure qui a +* _hdata_name_ : nom d'un hdata (si c'est un pointeur vers une structure qui a un hdata) Exemple en C : @@ -14669,11 +14669,11 @@ void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *poin Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la variable -* 'pointer' : pointeur vers la liste -* 'flags' : combinaison des valeurs suivantes : _(WeeChat ≥ 1.0)_ -** 'WEECHAT_HDATA_LIST_CHECK_POINTERS' : liste utilisée pour vérifier les +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la variable +* _pointer_ : pointeur vers la liste +* _flags_ : combinaison des valeurs suivantes : _(WeeChat ≥ 1.0)_ +** _WEECHAT_HDATA_LIST_CHECK_POINTERS_ : liste utilisée pour vérifier les pointeurs Exemple en C : @@ -14738,7 +14738,7 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Paramètres : -* 'hdata_name' : nom du hdata (voir la liste ci-dessous) +* _hdata_name_ : nom du hdata (voir la liste ci-dessous) Valeur de retour : @@ -14781,8 +14781,8 @@ int weechat_hdata_get_var_offset (struct t_hdata *hdata, const char *name); Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la variable Valeur de retour : @@ -14821,8 +14821,8 @@ int weechat_hdata_get_var_type (struct t_hdata *hdata, const char *name); Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la variable Valeur de retour : @@ -14886,8 +14886,8 @@ const char *weechat_hdata_get_var_type_string (struct t_hdata *hdata, const char Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la variable Valeur de retour : @@ -14926,9 +14926,9 @@ int weechat_hdata_get_var_array_size (struct t_hdata *hdata, void *pointer, cons Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable Valeur de retour : @@ -14970,9 +14970,9 @@ const char *weechat_hdata_get_var_count_array_size (struct t_hdata *hdata, void Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable Valeur de retour : @@ -15012,8 +15012,8 @@ const char *weechat_hdata_get_var_hdata (struct t_hdata *hdata, const char *name Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la variable Valeur de retour : @@ -15052,9 +15052,9 @@ void *weechat_hdata_get_var (struct t_hdata *hdata, void *pointer, const char *n Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable Valeur de retour : @@ -15088,9 +15088,9 @@ void *weechat_hdata_get_var_at_offset (struct t_hdata *hdata, void *pointer, int Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'offset' : position (offset) de la variable +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _offset_ : position (offset) de la variable Valeur de retour : @@ -15124,8 +15124,8 @@ void *weechat_hdata_get_list (struct t_hdata *hdata, const char *name); Paramètres : -* 'hdata' : pointeur vers le hdata -* 'name' : nom de la liste +* _hdata_ : pointeur vers le hdata +* _name_ : nom de la liste Valeur de retour : @@ -15166,13 +15166,13 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe Paramètres : -* 'hdata' : pointeur vers le hdata -* 'list' : pointeur vers une liste; si NULL _(WeeChat ≥ 1.0)_, le pointeur est +* _hdata_ : pointeur vers le hdata +* _list_ : pointeur vers une liste; si NULL _(WeeChat ≥ 1.0)_, le pointeur est vérifié avec les listes dans le hdata qui ont le drapeau "vérifier les pointeurs" (voir <<_hdata_new_list,weechat_hdata_new_list>>), et s'il n'y a pas de telle liste, le pointeur est considéré comme valide -* 'pointer' : pointeur à vérifier +* _pointer_ : pointeur à vérifier Valeur de retour : @@ -15228,9 +15228,9 @@ void *weechat_hdata_move (struct t_hdata *hdata, void *pointer, int count); Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'count' : nombre de saut(s) à exécuter (entier négatif ou positif, différent +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _count_ : nombre de saut(s) à exécuter (entier négatif ou positif, différent de 0) Valeur de retour : @@ -15275,7 +15275,7 @@ if buffer: _WeeChat ≥ 0.4.1._ -Chercher un élément dans la liste : l'expression 'search' est évaluée pour +Chercher un élément dans la liste : l'expression _search_ est évaluée pour chaque élément dans la liste, jusqu'à trouver l'élément (ou la fin de la liste). Prototype : @@ -15287,13 +15287,13 @@ void *weechat_hdata_search (struct t_hdata *hdata, void *pointer, const char *se Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'search' : expression à évaluer, le pointeur par défaut dans l'expression est +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _search_ : expression à évaluer, le pointeur par défaut dans l'expression est le nom du hdata (et ce pointeur change pour chaque élément dans la liste); pour l'aide sur l'expression, voir la commande `/eval` dans le - 'Guide utilisateur WeeChat' -* 'move' : nombre de saut(s) à exécuter après une recherche infructueuse (entier + _Guide utilisateur WeeChat_ +* _move_ : nombre de saut(s) à exécuter après une recherche infructueuse (entier négatif ou positif, différent de 0) Valeur de retour : @@ -15348,9 +15348,9 @@ char weechat_hdata_char (struct t_hdata *hdata, void *pointer, const char *name) Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "char"); pour les tableaux, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "char"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15392,9 +15392,9 @@ int weechat_hdata_integer (struct t_hdata *hdata, void *pointer, const char *nam Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "integer"); pour les tableaux, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "integer"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15440,9 +15440,9 @@ long weechat_hdata_long (struct t_hdata *hdata, void *pointer, const char *name) Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "long"); pour les tableaux, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "long"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15484,9 +15484,9 @@ const char *weechat_hdata_string (struct t_hdata *hdata, void *pointer, const ch Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "string"); pour les tableaux, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "string"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15532,9 +15532,9 @@ void *weechat_hdata_pointer (struct t_hdata *hdata, void *pointer, const char *n Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "pointeur"); pour les tableaux, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "pointeur"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15580,9 +15580,9 @@ time_t weechat_hdata_time (struct t_hdata *hdata, void *pointer, const char *nam Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "time"); pour les tableaux, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "time"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15650,9 +15650,9 @@ struct t_hashtable *weechat_hdata_hashtable (struct t_hdata *hdata, void *pointe Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (doit être de type "hashtable"); pour les +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (doit être de type "hashtable"); pour les tableaux, le nom peut être "N|name" où N est un index dans le tableau (démarrant à 0), par exemple : "2|name" @@ -15708,11 +15708,11 @@ int weechat_hdata_set (struct t_hdata *hdata, void *pointer, const char *name, c Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'name' : nom de la variable (types autorisés : char, integer, long, string, +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _name_ : nom de la variable (types autorisés : char, integer, long, string, pointer, time) -* 'value' : nouvelle valeur pour la variable +* _value_ : nouvelle valeur pour la variable Valeur de retour : @@ -15743,9 +15743,9 @@ int weechat_hdata_update (struct t_hdata *hdata, void *pointer, struct t_hashtab Paramètres : -* 'hdata' : pointeur vers le hdata -* 'pointer' : pointeur vers un objet WeeChat ou d'une extension -* 'hashtable' : variables à mettre à jour : les clés sont les noms des +* _hdata_ : pointeur vers le hdata +* _pointer_ : pointeur vers un objet WeeChat ou d'une extension +* _hashtable_ : variables à mettre à jour : les clés sont les noms des variables, les valeurs sont les nouvelles valeurs pour les variables (clés et valeurs sont des chaînes de caractères), quelques clés spéciales sont acceptées : @@ -15832,23 +15832,23 @@ const char *weechat_hdata_get_string (struct t_hdata *hdata, const char *propert Paramètres : -* 'hdata' : pointeur vers le hdata -* 'property' : nom de la propriété : -** 'var_keys' : chaîne avec la liste des clés pour les variables du hdata +* _hdata_ : pointeur vers le hdata +* _property_ : nom de la propriété : +** _var_keys_ : chaîne avec la liste des clés pour les variables du hdata (format : "key1,key2,key3") -** 'var_values' : chaîne avec la liste des valeurs pour les variables du hdata +** _var_values_ : chaîne avec la liste des valeurs pour les variables du hdata (format : "value1,value2,value3") -** 'var_keys_values' : chaîne avec la liste des clés et valeurs pour les +** _var_keys_values_ : chaîne avec la liste des clés et valeurs pour les variables du hdata (format : "key1:value1,key2:value2,key3:value3") -** 'var_prev' : nom de la variable dans la structure qui est un pointeur vers +** _var_prev_ : nom de la variable dans la structure qui est un pointeur vers l'élément précédent dans la liste -** 'var_next' : nom de la variable dans la structure qui est un pointeur vers +** _var_next_ : nom de la variable dans la structure qui est un pointeur vers l'élément suivant dans la liste -** 'list_keys' : chaîne avec la liste des clés pour les listes du hdata +** _list_keys_ : chaîne avec la liste des clés pour les listes du hdata (format : "key1,key2,key3") -** 'list_values' : chaîne avec la liste des valeurs pour les listes du hdata +** _list_values_ : chaîne avec la liste des valeurs pour les listes du hdata (format : "value1,value2,value3") -** 'list_keys_values' : chaîne avec la liste des clés et valeurs pour les listes +** _list_keys_values_ : chaîne avec la liste des clés et valeurs pour les listes du hdata (format : "key1:value1,key2:value2,key3:value3") Valeur de retour : @@ -15902,23 +15902,23 @@ struct t_upgrade_file *upgrade_file_new (const char *filename, Paramètres : -* 'filename' : nom du fichier (l'extension ".upgrade" est ajoutée +* _filename_ : nom du fichier (l'extension ".upgrade" est ajoutée automatiquement par WeeChat) -* 'callback_read' : fonction appelée pour chaque objet lu dans le fichier de +* _callback_read_ : fonction appelée pour chaque objet lu dans le fichier de mise à jour (si NULL, le fichier pour la mise à jour est ouvert en écriture), paramètres et valeur de retour : -** 'const void *pointer' : pointeur -** 'void *data' : pointeur -** 'struct t_upgrade_file *upgrade_file' : pointeur vers le fichier de mise à +** _const void *pointer_ : pointeur +** _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 +** _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_pointer' : pointeur donné au "callback" lorsqu'il est appelé +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_read_pointer_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat -* 'callback_read_data' : pointeur donné au "callback" lorsqu'il est appelé par +* _callback_read_data_ : pointeur donné au "callback" lorsqu'il est appelé par WeeChat; si non NULL, doit avoir été alloué par malloc (ou une fonction similaire) et est automatiquement libéré (par free) lorsque le fichier de mise à jour est fermé @@ -15961,9 +15961,9 @@ int weechat_upgrade_write_object (struct t_upgrade_file *upgrade_file, Paramètres : -* 'upgrade_file' : pointeur vers le fichier de mise à jour -* 'object_id' : identifiant de l'objet -* 'infolist' : infolist à écrire dans le fichier +* _upgrade_file_ : pointeur vers le fichier de mise à jour +* _object_id_ : identifiant de l'objet +* _infolist_ : infolist à écrire dans le fichier Valeur de retour : @@ -16009,7 +16009,7 @@ int weechat_upgrade_read (struct t_upgrade_file *upgrade_file); Paramètres : -* 'upgrade_file' : pointeur vers le fichier de mise à jour +* _upgrade_file_ : pointeur vers le fichier de mise à jour Valeur de retour : @@ -16046,7 +16046,7 @@ void weechat_upgrade_close (struct t_upgrade_file *upgrade_file); Paramètres : -* 'upgrade_file' : pointeur vers le fichier de mise à jour +* _upgrade_file_ : pointeur vers le fichier de mise à jour Exemple en C : diff --git a/doc/it/weechat_plugin_api.it.asciidoc b/doc/it/weechat_plugin_api.it.asciidoc index 66d9fad41..4df1a3142 100644 --- a/doc/it/weechat_plugin_api.it.asciidoc +++ b/doc/it/weechat_plugin_api.it.asciidoc @@ -6,7 +6,7 @@ :toclevels: 4 :toc-title: Indice :sectnums: -:sectnumlevels: 2 +:sectnumlevels: 3 :docinfo1: @@ -93,16 +93,16 @@ int weechat_plugin_init (struct t_weechat_plugin *plugin, Argomenti: -* 'plugin': puntatore alla struttura del plugin di WeeChat -* 'argc': numero di argomenti per il plugin (fornito dalla riga di comando +* _plugin_: puntatore alla struttura del plugin di WeeChat +* _argc_: numero di argomenti per il plugin (fornito dalla riga di comando dall'utente) -* 'argv': argomenti per il plugin +* _argv_: argomenti per il plugin Valori restituiti: -* 'WEECHAT_RC_OK' se l'operazione ha successo (il plugin +* _WEECHAT_RC_OK_ se l'operazione ha successo (il plugin verrà caricato) -* 'WEECHAT_RC_ERROR' se c'è un errore (il plugin NON +* _WEECHAT_RC_ERROR_ se c'è un errore (il plugin NON verrà caricato) // TRANSLATION MISSING @@ -111,8 +111,8 @@ Valori restituiti: // TRANSLATION MISSING When plugins are auto-loaded (for example on startup), WeeChat first loads all -plugins, and then calls the 'init' functions, using the priority defined in -each plugin. A high priority means that the 'init' function is called first. +plugins, and then calls the _init_ functions, using the priority defined in +each plugin. A high priority means that the _init_ function is called first. Default priority is 1000 (with such priority, the plugin is loaded after all default plugins). @@ -135,18 +135,18 @@ int weechat_plugin_end (struct t_weechat_plugin *plugin); Argomenti: -* 'plugin': puntatore alla struttura plugin di WeeChat +* _plugin_: puntatore alla struttura plugin di WeeChat Valori restituiti: -* 'WEECHAT_RC_OK' se l'operazione ha successo -* 'WEECHAT_RC_ERROR' se c'è un errore +* _WEECHAT_RC_OK_ se l'operazione ha successo +* _WEECHAT_RC_ERROR_ se c'è un errore [[compile_plugin]] === Compilazione del plugin La compilazione non richiede i sorgenti di WeeChat, è richiesto solo -il file 'weechat-plugin.h'. +il file _weechat-plugin.h_. Per compilare un plugin che ha un file "tizio.c" (in GNU/Linux): @@ -158,9 +158,9 @@ $ gcc -shared -fPIC -o libtizio.so tizio.o [[load_plugin]] === Caricamento del plugin -Copiare il file 'libtizio.so' nella cartella plugin di sistema (ad -esempio '/usr/local/lib/weechat/plugins') oppure nella cartella -plugin dell'utente (ad esempio '/home/xxx/.weechat/plugins'). +Copiare il file _libtizio.so_ nella cartella plugin di sistema (ad +esempio _/usr/local/lib/weechat/plugins_) oppure nella cartella +plugin dell'utente (ad esempio _/home/xxx/.weechat/plugins_). In WeeChat: @@ -171,7 +171,7 @@ In WeeChat: [[plugin_example]] === Plugin di esempio -Un esempio completo di plugin, che aggiunge un comando '/double': +Un esempio completo di plugin, che aggiunge un comando _/double_: visualizza due volte gli argomenti nel buffer corrente, oppure esegue un comando due volte (ok, non sarà molto utile, ma è solo un esempio!): @@ -273,7 +273,7 @@ const char *weechat_plugin_get_name (struct t_weechat_plugin *plugin); Argomenti: -* 'plugin': puntatore alla struttura plugin di WeeChat (può essere NULL) +* _plugin_: puntatore alla struttura plugin di WeeChat (può essere NULL) Valore restituito: @@ -309,7 +309,7 @@ questa API perché compatibili con UTF-8 e il locale. ==== charset_set Imposta il nuovo set caratteri del nuovo plugin (il set caratteri predefinito -è 'UTF-8', così se il plugin usa 'UTF-8' non è necessario chiamare questa +è _UTF-8_, così se il plugin usa _UTF-8_ non è necessario chiamare questa funzione). Prototipo: @@ -321,7 +321,7 @@ void weechat_charset_set (const char *charset); Argomenti: -* 'charset': nuovo set caratteri da usare +* _charset_: nuovo set caratteri da usare Esempio in C: @@ -355,8 +355,8 @@ char *weechat_iconv_to_internal (const char *charset, const char *string); Argomenti: -* 'charset': set caratteri da convertire -* 'string': stringa da convertire +* _charset_: set caratteri da convertire +* _string_: stringa da convertire Valore restituito: @@ -397,8 +397,8 @@ char *weechat_iconv_from_internal (const char *charset, const char *string); Argomenti: -* 'charset': set caratteri in uscita -* 'string': stringa da convertire +* _charset_: set caratteri in uscita +* _string_: stringa da convertire Valore restituito: @@ -438,7 +438,7 @@ const char *weechat_gettext (const char *string); Argomenti: -* 'string': stringa da tradurre +* _string_: stringa da tradurre Valore restituito: @@ -465,7 +465,7 @@ str = weechat.gettext("hello") ==== ngettext Restituisce la stringa tradotta, utilizzando il singolare o il plurale, in base -all'argomento 'count' (contatore). +all'argomento _count_ (contatore). Prototipo: @@ -477,9 +477,9 @@ const char *weechat_ngettext (const char *string, const char *plural, Argomenti: -* 'string': stringa da tradurre, singolare -* 'plural': stringa da tradurre, plurale -* 'count': utilizzato per scegliere tra singolare e plurale (la scelta viene +* _string_: stringa da tradurre, singolare +* _plural_: stringa da tradurre, plurale +* _count_: utilizzato per scegliere tra singolare e plurale (la scelta viene fatta in base alla lingua locale) Valore restituito: @@ -508,7 +508,7 @@ str = weechat.ngettext("file", "files", num_files) ==== strndup Restituisce una stringa duplicata, con un massimo di caratteri -impostato su 'chars'. +impostato su _chars_. Prototipo: @@ -519,8 +519,8 @@ char *weechat_strndup (const char *string, int length); Argomenti: -* 'string': stringa da duplicare -* 'length': caratteri massimi da duplicare +* _string_: stringa da duplicare +* _length_: caratteri massimi da duplicare Valore restituito: @@ -552,7 +552,7 @@ void weechat_string_tolower (char *string); Argomenti: -* 'string': stringa da convertire +* _string_: stringa da convertire Esempio in C: @@ -578,7 +578,7 @@ void weechat_string_toupper (char *string); Argomenti: -* 'string': stringa da convertire +* _string_: stringa da convertire Esempio in C: @@ -607,8 +607,8 @@ int weechat_strcasecmp (const char *string1, const char *string2); Argomenti: -* 'string1': prima stringa da comparare -* 'string2': seconda stringa da comparare +* _string1_: prima stringa da comparare +* _string2_: seconda stringa da comparare Valore restituito: @@ -643,12 +643,12 @@ int weechat_strcasecmp_range (const char *string1, const char *string2, int rang Argomenti: -* 'string1': prima stringa da comparare -* 'string2': seconda stringa da comparare -* 'range': numero di caratteri nel confronto maiuscole/minuscole, ad esempio: -** 26: "A-Z" vengono ridotti ad "a-z" -** 29: "A-Z [ \ ]" vengono ridotti ad "a-z { | }" -** 30: "A-Z [ \ ] ^" vengono ridotti ad "a-z { | } ~" +* _string1_: prima stringa da comparare +* _string2_: seconda stringa da comparare +* _range_: numero di caratteri nel confronto maiuscole/minuscole, ad esempio: +** 26: `A-Z` vengono ridotti ad `a-z` +** 29: `A-Z [ \ ]` vengono ridotti ad `a-z { | }` +** 30: `A-Z [ \ ] ^` vengono ridotti ad `a-z { | } ~` [NOTE] I valori 29 e 30 vengono usati da alcuni protocolli come IRC. @@ -675,7 +675,7 @@ Questa funzione non è disponibile nelle API per lo scripting. _Updated in 1.0._ Confronta stringa indipendente non sensibile alle maiuscole e alla -localizzazione, per un numero 'max' di caratteri. +localizzazione, per un numero _max_ di caratteri. Prototipo: @@ -686,9 +686,9 @@ int weechat_strncasecmp (const char *string1, const char *string2, int max); Argomenti: -* 'string1': prima stringa da comparare -* 'string2': seconda stringa da comparare -* 'max': numero massimo di caratteri da comparare +* _string1_: prima stringa da comparare +* _string2_: seconda stringa da comparare +* _max_: numero massimo di caratteri da comparare Valore restituito: @@ -712,7 +712,7 @@ Questa funzione non è disponibile nelle API per lo scripting. _WeeChat ≥ 0.3.7, updated in 1.0._ Confronta una stringa non sensibile alle maiuscole e alla localizzazione, per un -numero 'max' di caratteri, usando una serie per il confronto. +numero _max_ di caratteri, usando una serie per il confronto. Prototipo: @@ -723,13 +723,13 @@ int weechat_strncasecmp_range (const char *string1, const char *string2, int max Argomenti: -* 'string1': prima stringa da comparare -* 'string2': seconda stringa da comparare -* 'max': numero massimo di caratteri da comparare -* 'range': numero di caratteri nel confronto maiuscole/minuscole, ad esempio: -** 26: "A-Z" vengono ridotti ad "a-z" -** 29: "A-Z [ \ ]" vengono ridotti ad "a-z { | }" -** 30: "A-Z [ \ ] ^" vengono ridotti ad "a-z { | } ~" +* _string1_: prima stringa da comparare +* _string2_: seconda stringa da comparare +* _max_: numero massimo di caratteri da comparare +* _range_: numero di caratteri nel confronto maiuscole/minuscole, ad esempio: +** 26: `A-Z` vengono ridotti ad `a-z` +** 29: `A-Z [ \ ]` vengono ridotti ad `a-z { | }` +** 30: `A-Z [ \ ] ^` vengono ridotti ad `a-z { | } ~` [NOTE] I valori 29 e 30 vengono usati da alcuni protocolli come IRC. @@ -769,10 +769,10 @@ int weechat_strcmp_ignore_chars (const char *string1, const char *string2, Argomenti: -* 'string1': prima stringa per il confronto -* 'string2': seconda stringa per il confronto -* 'chars_ignored': stringa con caratteri da ignorare -* 'case_sensitive': 1 per il confronto sensibile alle maiuscole, altrimenti 0 +* _string1_: prima stringa per il confronto +* _string2_: seconda stringa per il confronto +* _chars_ignored_: stringa con caratteri da ignorare +* _case_sensitive_: 1 per il confronto sensibile alle maiuscole, altrimenti 0 Valore restituito: @@ -807,14 +807,14 @@ const char *weechat_strcasestr (const char *string, const char *search); Argomenti: -* 'string': stringa -* 'search': stringa da cercare in 'string' +* _string_: stringa +* _search_: stringa da cercare in _string_ Valore restituito: // TRANSLATION MISSING * puntatore alla stringa trovata, o NULL se non trovata - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) Esempio in C: @@ -845,7 +845,7 @@ int weechat_strlen_screen (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -887,11 +887,11 @@ int weechat_string_match (const char *string, const char *mask, Argomenti: -* 'string': stringa +* _string_: stringa // TRANSLATION MISSING -* 'mask': mask with wildcards ("*"), each wildcard matches 0 or more chars in +* _mask_: mask with wildcards (`+*+`), each wildcard matches 0 or more chars in the string -* 'case_sensitive': 1 per il confronto sensibile alle maiuscole, altrimenti 0 +* _case_sensitive_: 1 per il confronto sensibile alle maiuscole, altrimenti 0 // TRANSLATION MISSING [NOTE] @@ -932,8 +932,8 @@ match5 = weechat.string_match("abcdef", "*b*d*", 0) # 1 _WeeChat ≥ 0.3.3._ -Sostituisce la `~` iniziale con la stringa con la cartella home. Se la stringa -non inizia con `~`, viene restituita la stessa stringa. +Sostituisce la `+~+` iniziale con la stringa con la cartella home. Se la stringa +non inizia con `+~+`, viene restituita la stessa stringa. Prototipo: @@ -944,11 +944,11 @@ char *weechat_string_expand_home (const char *path); Argomenti: -* 'path': percorso +* _path_: percorso Valore restituito: -* percorso con la `~` iniziale sostituita dalla cartella home (deve essere +* percorso con la `+~+` iniziale sostituita dalla cartella home (deve essere liberata chiamando "free" dopo l'uso) Esempio in C: @@ -972,7 +972,7 @@ _WeeChat ≥ 1.3._ Evaluate a path in 3 steps: . replace leading `%h` by WeeChat home directory, -. replace leading `~` by user home directory (call to +. replace leading `+~+` by user home directory (call to <<_string_expand_home,weechat_string_expand_home>>), . evaluate variables (see <<_string_eval_expression,weechat_string_eval_expression>>). @@ -990,12 +990,12 @@ char *weechat_string_eval_path_home (const char *path, // TRANSLATION MISSING Argomenti: -* 'path': path -* 'pointers': hashtable for call to function +* _path_: path +* _pointers_: hashtable for call to function <<_string_eval_expression,weechat_string_eval_expression>> -* 'extra_vars': hashtable for call to function +* _extra_vars_: hashtable for call to function <<_string_eval_expression,weechat_string_eval_expression>> -* 'options': hashtable for call to function +* _options_: hashtable for call to function <<_string_eval_expression,weechat_string_eval_expression>> // TRANSLATION MISSING @@ -1039,8 +1039,8 @@ char *weechat_string_remove_quotes (const char *string, const char *quotes); Argomenti: -* 'string': stringa -* 'quotes': stringa con elenco di virgolette +* _string_: stringa +* _quotes_: stringa con elenco di virgolette Valore restituito: @@ -1074,10 +1074,10 @@ char *weechat_string_strip (const char *string, int left, int right, Argomenti: -* 'string': stringa -* 'left': rimuove i caratteri a sinistra se diversi da 0 -* 'right': rimuove i caratteri a destra se diversi da 0 -* 'chars': stringa con i caratteri da rimuovere +* _string_: stringa +* _left_: rimuove i caratteri a sinistra se diversi da 0 +* _right_: rimuove i caratteri a destra se diversi da 0 +* _chars_: stringa con i caratteri da rimuovere Valore restituito: @@ -1102,20 +1102,20 @@ _WeeChat ≥ 1.0._ // TRANSLATION MISSING Convert escaped chars to their value: -* `\"`: double quote -* `\\`: backslash -* `\a`: alert (BEL) -* `\b`: backspace -* `\e`: escape -* `\f`: form feed -* `\n`: new line -* `\r`: carriage return -* `\t`: horizontal tab -* `\v`: vertical tab -* `\0ooo`: char as octal value (ooo is 0 to 3 digits) -* `\xhh`: char as hexadecimal value (hh is 1 to 2 digits) -* `\uhhhh`: unicode char as hexadecimal value (hhhh is 1 to 4 digits) -* `\Uhhhhhhhh`: unicode char as hexadecimal value (hhhhhhhh is 1 to 8 digits) +* `+\"+`: double quote +* `+\\+`: backslash +* `+\a+`: alert (BEL) +* `+\b+`: backspace +* `+\e+`: escape +* `+\f+`: form feed +* `+\n+`: new line +* `+\r+`: carriage return +* `+\t+`: horizontal tab +* `+\v+`: vertical tab +* `+\0ooo+`: char as octal value (`ooo` is 0 to 3 digits) +* `+\xhh+`: char as hexadecimal value (`hh` is 1 to 2 digits) +* `+\uhhhh+`: unicode char as hexadecimal value (`hhhh` is 1 to 4 digits) +* `+\Uhhhhhhhh+`: unicode char as hexadecimal value (`hhhhhhhh` is 1 to 8 digits) Prototipo: @@ -1126,7 +1126,7 @@ char *weechat_string_convert_escaped_chars (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -1150,7 +1150,7 @@ Questa funzione non è disponibile nelle API per lo scripting. ==== string_mask_to_regex Restituisce una espressione regolare con una mask, dove l'unico carattere -speciale è "`*`". Tutti gli altri caratteri speciali per le espressioni regolari +speciale è `+*+`. Tutti gli altri caratteri speciali per le espressioni regolari non vengono riconosciuti. Prototipo: @@ -1162,7 +1162,7 @@ char *weechat_string_mask_to_regex (const char *mask); Argomenti: -* 'mask': mask +* _mask_: mask Valore restituito: @@ -1207,14 +1207,14 @@ const char *weechat_string_regex_flags (const char *regex, int default_flags, in Argomenti: // TRANSLATION MISSING -* 'regex': POSIX extended regular expression -* 'default_flags': combinazione dei seguenti valori (consultare `man regcomp`): +* _regex_: POSIX extended regular expression +* _default_flags_: combinazione dei seguenti valori (consultare `man regcomp`): ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE ** REG_NOSUB // TRANSLATION MISSING -* 'flags': pointer value is set with flags used in regular expression (default +* _flags_: pointer value is set with flags used in regular expression (default flags + flags set in regular expression) // TRANSLATION MISSING @@ -1225,15 +1225,15 @@ Flags must be at beginning of regular expression. Format is: Allowed flags are: // TRANSLATION MISSING -* 'e': POSIX extended regular expression ('REG_EXTENDED') -* 'i': case insensitive ('REG_ICASE') -* 'n': match-any-character operators don't match a newline ('REG_NEWLINE') -* 's': support for substring addressing of matches is not required ('REG_NOSUB') +* _e_: POSIX extended regular expression (_REG_EXTENDED_) +* _i_: case insensitive (_REG_ICASE_) +* _n_: match-any-character operators don_t match a newline (_REG_NEWLINE_) +* _s_: support for substring addressing of matches is not required (_REG_NOSUB_) Valore restituito: // TRANSLATION MISSING -* pointer in 'regex', after flags +* pointer in _regex_, after flags Esempio in C: @@ -1267,9 +1267,9 @@ int weechat_string_regcomp (void *preg, const char *regex, int default_flags) Argomenti: // TRANSLATION MISSING -* 'preg': pointer to 'regex_t' structure -* 'regex': POSIX extended regular expression -* 'default_flags': combination of following values (see `man regcomp`): +* _preg_: pointer to _regex_t_ structure +* _regex_: POSIX extended regular expression +* _default_flags_: combination of following values (see `man regcomp`): ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE @@ -1310,8 +1310,8 @@ int weechat_string_has_highlight (const char *string, Argomenti: -* 'string': stringa -* 'highlight_words': lista di parole per gli eventi, separate da virgole +* _string_: stringa +* _highlight_words_: lista di parole per gli eventi, separate da virgole Valore restituito: @@ -1343,7 +1343,7 @@ _WeeChat ≥ 0.3.4._ Check if a string has one or more highlights, using a POSIX extended regular expression. + For at least one match of regular expression on string, it must be surrounded -by delimiters (chars different from: alphanumeric, "-", "_" and "|"). +by delimiters (chars different from: alphanumeric, `+-+`, `+_+` and `+|+`). Prototipo: @@ -1354,9 +1354,9 @@ int weechat_string_has_highlight_regex (const char *string, const char *regex); Argomenti: -* 'string': stringa +* _string_: stringa // TRANSLATION MISSING -* 'regex': POSIX extended regular expression +* _regex_: POSIX extended regular expression Valore restituito: @@ -1394,13 +1394,13 @@ char *weechat_string_replace (const char *string, const char *search, Argomenti: -* 'string': stringa -* 'search': stringa da sostituire -* 'replace': sostituzione per la stringa 'search' +* _string_: stringa +* _search_: stringa da sostituire +* _replace_: sostituzione per la stringa _search_ Valore restituito: -* la stringa dopo 'search' sostituita da 'replace' (deve essere liberata +* la stringa dopo _search_ sostituita da _replace_ (deve essere liberata chiamando "free" dopo l'uso) Esempio in C: @@ -1436,24 +1436,25 @@ char *weechat_string_replace_regex (const char *string, void *regex, Argomenti: // TRANSLATION MISSING -* 'string': string -* 'regex': pointer to a regular expression ('regex_t' structure) compiled with +* _string_: string +* _regex_: pointer to a regular expression (_regex_t_ structure) compiled with WeeChat function <<_string_regcomp,weechat_string_regcomp>> or regcomp (see `man regcomp`) -* 'replace': replacement text, where following references are allowed: -** `$0` to `$99`: match 0 to 99 in regular expression (0 is the whole match, +* _replace_: replacement text, where following references are allowed: +** `+$0+` to `+$99+`: match 0 to 99 in regular expression (0 is the whole match, 1 to 99 are groups captured between parentheses) -** `$+`: the last match (with highest number) -** `$.*N`: match `N` (can be `+` or `0` to `99`), with all chars replaced by `*` - (the `*` char can be any char between space (32) and `~` (126)) -* 'reference_char': the char used for reference to match (commonly '$') -* 'callback': an optional callback called for each reference in 'replace' +** `+$++`: the last match (with highest number) +** `+$.*N+`: match `+N+` (can be `+++` or `+0+` to `+99+`), with all chars + replaced by `+*+` (the `+*+` char can be any char between space (32) and + `+~+` (126)) +* _reference_char_: the char used for reference to match (commonly `+$+`) +* _callback_: an optional callback called for each reference in _replace_ (except for matches replaced by a char); the callback must return: ** newly allocated string: it is used as replacement text (it is freed after use) ** NULL: the text received in callback is used as replacement text (without changes) -* 'callback_data': pointer given to callback when it is called +* _callback_data_: pointer given to callback when it is called Valore restituito: @@ -1497,16 +1498,16 @@ char **weechat_string_split (const char *string, const char *separators, Argomenti: -* 'string': stringa da dividere -* 'separators': delimitatori usati per dividere -* 'keep_eol': +* _string_: stringa da dividere +* _separators_: delimitatori usati per dividere +* _keep_eol_: ** 0: ogni stringa conterrà una parola ** 1: ogni stringa conterrà tutte le stringhe fino a fine riga (consultare il seguente esempio) ** 2: come il punto 1, ma non rimuove i delimitatori alla fine della stringa prima della divisione _(WeeChat ≥ 0.3.6)_ -* 'num_items_max': numero massimo di elementi creati (0 = nessun limite) -* 'num_items': puntatore ad int che conterrà il numero di elementi creati +* _num_items_max_: numero massimo di elementi creati (0 = nessun limite) +* _num_items_: puntatore ad int che conterrà il numero di elementi creati Valore restituito: @@ -1570,8 +1571,8 @@ char **weechat_string_split_shell (const char *string, int *num_items); Argomenti: -* 'string': stringa da dividere -* 'num_items': puntatore ad int che conterrà il numero di elementi creati +* _string_: stringa da dividere +* _num_items_: puntatore ad int che conterrà il numero di elementi creati Valore restituito: @@ -1610,7 +1611,7 @@ void weechat_string_free_split (char **split_string); Argomenti: -* 'split_string': stringa divisa dalla funzione +* _split_string_: stringa divisa dalla funzione <<_string_split,weechat_string_split>> Esempio in C: @@ -1641,9 +1642,9 @@ char *weechat_string_build_with_split_string (char **split_string, Argomenti: -* 'split_string': stringa divisa dalla funzione +* _split_string_: stringa divisa dalla funzione <<_string_split,weechat_string_split>> -* 'separator': stringa usata per separare le stringhe +* _separator_: stringa usata per separare le stringhe Valore restituito: @@ -1668,8 +1669,8 @@ Questa funzione non è disponibile nelle API per lo scripting. ==== string_split_command -Divide una lista di comandi separata da 'separator' (che può essere -omesso aggiungendo "\" nella stringa). +Divide una lista di comandi separata da _separator_ (che può essere +omesso aggiungendo `+\+` nella stringa). Prototipo: @@ -1680,8 +1681,8 @@ char **weechat_string_split_command (const char *command, char separator); Argomenti: -* 'command': comando da dividere -* 'separator': separatore +* _command_: comando da dividere +* _separator_: separatore Valore restituito: @@ -1716,7 +1717,7 @@ void weechat_string_free_split_command (char **split_command); Argomenti: -* 'split_command': comando diviso da +* _split_command_: comando diviso da <<_string_split_command,weechat_string_split_command>> Esempio in C: @@ -1745,7 +1746,7 @@ char *weechat_string_format_size (unsigned long long size); Argomenti: -* 'size': dimensione (in byte) +* _size_: dimensione (in byte) Valore restituito: @@ -1792,8 +1793,8 @@ char *weechat_string_remove_color (const char *string, Argomenti: -* 'string': stringa -* 'replacement': se non NULL e non vuota, i codici colore di WeeChat sono +* _string_: stringa +* _replacement_: se non NULL e non vuota, i codici colore di WeeChat sono sostituiti dal primo carattere di questa stringa, altrimenti i codici colori di WeeChat ed i caratteri seguenti (se correlate al colore) sono rimossi dalla stringa @@ -1843,9 +1844,9 @@ void weechat_string_encode_base64 (const char *from, int length, char *to); Argomenti: -* 'from': stringa da codificare -* 'length': lunghezza della stringa da codificare (ad esempio `strlen(from)`) -* 'to': puntatore alla stringa per memorizzare il risultato (deve essere +* _from_: stringa da codificare +* _length_: lunghezza della stringa da codificare (ad esempio `strlen(from)`) +* _to_: puntatore alla stringa per memorizzare il risultato (deve essere sufficientemente lunga, il risultato è più lungo della stringa iniziale) Esempio in C: @@ -1875,13 +1876,13 @@ int weechat_string_decode_base64 (const char *from, char *to); Argomenti: -* 'from': stringa da decodificare -* 'to': puntatore alla stringa per memorizzare il risultato (deve essere +* _from_: stringa da decodificare +* _to_: puntatore alla stringa per memorizzare il risultato (deve essere sufficientemente lunga, il risultato è più lungo della stringa iniziale) Valore restituito: -* lunghezza della stringa memorizzata in *to (lo '\0' finale non conta) +* lunghezza della stringa memorizzata in _*to_ (lo _\0_ finale non conta) Esempio in C: @@ -1914,12 +1915,12 @@ char *string_hex_dump (const char *data, int data_size, int bytes_per_line, Argomenti: // TRANSLATION MISSING -* 'data': the data to dump -* 'data_size': number of bytes to dump in 'data' -* 'bytes_per_line': number of bytes to display in each line -* 'prefix': the prefix to display at the beginning of each line +* _data_: the data to dump +* _data_size_: number of bytes to dump in _data_ +* _bytes_per_line_: number of bytes to display in each line +* _prefix_: the prefix to display at the beginning of each line (optional, can be NULL) -* 'suffix': the suffix to display at the end of each line +* _suffix_: the suffix to display at the end of each line (optional, can be NULL) Valore restituito: @@ -1945,7 +1946,7 @@ Questa funzione non è disponibile nelle API per lo scripting. _WeeChat ≥ 0.3.2._ Verifica che il primo carattere della stringa sia un carattere comando -(il comando carattere predefinito è '/'). +(il comando carattere predefinito è `+/+`). Prototipo: @@ -1956,7 +1957,7 @@ int weechat_string_is_command_char (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -1999,7 +2000,7 @@ const char *weechat_string_input_for_buffer (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2054,28 +2055,28 @@ char *weechat_string_eval_expression (const char *expr, Argomenti: // TRANSLATION MISSING -* 'expr': the expression to evaluate (see table below) -* 'pointers': hashtable with pointers (keys must be string, values must be +* _expr_: the expression to evaluate (see table below) +* _pointers_: hashtable with pointers (keys must be string, values must be pointer); pointers "window" and "buffer" are automatically added if they are not in hashtable (with pointer to current window/buffer) (can be NULL): -** 'regex': pointer to a regular expression ('regex_t' structure) compiled with +** _regex_: pointer to a regular expression (_regex_t_ structure) compiled with WeeChat function <<_string_regcomp,weechat_string_regcomp>> or - regcomp (see `man regcomp`); this option is similar to 'regex' in hashtable - 'options' (below), but is used for better performance -* 'extra_vars': extra variables that will be expanded (can be NULL) -* 'options': a hashtable with some options (keys and values must be string) + regcomp (see `man regcomp`); this option is similar to _regex_ in hashtable + _options_ (below), but is used for better performance +* _extra_vars_: extra variables that will be expanded (can be NULL) +* _options_: a hashtable with some options (keys and values must be string) (can be NULL): -** 'type': default behavior is just to replace values in expression, other +** _type_: default behavior is just to replace values in expression, other types can be selected: -*** 'condition': the expression is evaluated as a condition: operators and +*** _condition_: the expression is evaluated as a condition: operators and parentheses are used, result is a boolean ("0" or "1") -** 'prefix': prefix before variables to replace (default: "${") -** 'suffix': suffix after variables to replace (default: "}") -** 'regex': a regex used to replace text in 'expr' (which is then not +** _prefix_: prefix before variables to replace (default: `+${+`) +** _suffix_: suffix after variables to replace (default: `+}+`) +** _regex_: a regex used to replace text in _expr_ (which is then not evaluated) -** 'regex_replace': the replacement text to use with 'regex', to replace - text in 'expr' (the 'regex_replace' is evaluated on each match of 'regex' - against 'expr', until no match is found) +** _regex_replace_: the replacement text to use with _regex_, to replace + text in _expr_ (the _regex_replace_ is evaluated on each match of _regex_ + against _expr_, until no match is found) Valore restituito: @@ -2092,7 +2093,7 @@ expanded to last): |=== | Format | Description | Examples | Results -| `${name}` | Variable `name` from hashtable 'extra_vars' | +| `${name}` | Variable `name` from hashtable _extra_vars_ | `${name}` | `value` // TRANSLATION MISSING @@ -2116,8 +2117,8 @@ expanded to last): `********` | `${re:N}` | - Regex captured group: 0 = whole string matching, 1 to 99 = group captured, - `+` = last group captured | + Regex captured group: `0` = whole string matching, `1` to `99` = group + captured, `+++` = last group captured | `${re:1}` | `test` @@ -2263,7 +2264,7 @@ int weechat_utf8_has_8bits (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2298,11 +2299,11 @@ int weechat_utf8_is_valid (const char *string, int length, char **error); Argomenti: -* 'string': stringa +* _string_: stringa // TRANSLATION MISSING -* 'length': max number of UTF-8 chars to check; if ≤ 0, the whole string is +* _length_: max number of UTF-8 chars to check; if ≤ 0, the whole string is checked _(WeeChat ≥ 1.4)_ -* 'error': se non NULL, '*error' è impostato con il puntatore al primo +* _error_: se non NULL, _*error_ è impostato con il puntatore al primo carattere UTF-8 non valido nella stringa, se esiste Valore restituito: @@ -2341,8 +2342,8 @@ void weechat_utf8_normalize (char *string, char replacement); Argomenti: -* 'string': stringa -* 'replacement': carattere sotitutivo per i caratteri non validi +* _string_: stringa +* _replacement_: carattere sotitutivo per i caratteri non validi Esempio in C: @@ -2371,16 +2372,16 @@ const char *weechat_utf8_prev_char (const char *string_start, Argomenti: -* 'string_start': inizio della stringa (la funzione non restituirà un carattere prima +* _string_start_: inizio della stringa (la funzione non restituirà un carattere prima di questo puntatore) -* 'string': puntatore alla stringa (deve essere ≥ 'string_start') +* _string_: puntatore alla stringa (deve essere ≥ _string_start_) Valore restituito: // TRANSLATION MISSING * puntatore al precedente carattere UTF-8, NULL se non trovata (raggiunta l'inizio della stringa) - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) Esempio in C: @@ -2408,14 +2409,14 @@ const char *weechat_utf8_next_char (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: // TRANSLATION MISSING * puntatore al carattere UTF-8 successivo, NULL se non trovato (raggiunta la fine della stringa) - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) Esempio in C: @@ -2440,7 +2441,7 @@ int weechat_utf8_char_int (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2469,7 +2470,7 @@ int weechat_utf8_char_size (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2498,7 +2499,7 @@ int weechat_utf8_strlen (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2517,7 +2518,7 @@ Questa funzione non è disponibile nelle API per lo scripting. ==== utf8_strnlen Restituisce la lunghezza della stringa UTF-8 (in caratteri UTF-8), per -un massimo di 'bytes' nella stringa. +un massimo di _bytes_ nella stringa. Prototipo: @@ -2528,8 +2529,8 @@ int weechat_utf8_strnlen (const char *string, int bytes); Argomenti: -* 'string': stringa -* 'bytes': massimo di byte +* _string_: stringa +* _bytes_: massimo di byte Valore restituito: @@ -2559,7 +2560,7 @@ int weechat_utf8_strlen_screen (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2592,8 +2593,8 @@ int weechat_utf8_charcmp (const char *string1, const char *string2); Argomenti: -* 'string1': prima stringa da comparare -* 'string2': seconda stringa da comparare +* _string1_: prima stringa da comparare +* _string2_: seconda stringa da comparare Valore restituito: @@ -2627,8 +2628,8 @@ int weechat_utf8_charcasecmp (const char *string1, const char *string2); Argomenti: -* 'string1': prima stringa da comparare -* 'string2': seconda stringa da comparare +* _string1_: prima stringa da comparare +* _string2_: seconda stringa da comparare Valore restituito: @@ -2660,7 +2661,7 @@ int weechat_utf8_char_size_screen (const char *string); Argomenti: -* 'string': stringa +* _string_: stringa Valore restituito: @@ -2693,14 +2694,14 @@ const char *weechat_utf8_add_offset (const char *string, int offset); Argomenti: -* 'string': stringa -* 'offset': numero di caratteri +* _string_: stringa +* _offset_: numero di caratteri Valore restituito: // TRANSLATION MISSING * puntatore alla stringa, N caratteri dopo (NULL se non raggiungibile) - (_WeeChat ≥ 1.3_: pointer returned is a 'const char *' instead of 'char *') + (_WeeChat ≥ 1.3_: pointer returned is a _const char *_ instead of _char *_) Esempio in C: @@ -2726,8 +2727,8 @@ int weechat_utf8_real_pos (const char *string, int pos); Argomenti: -* 'string': stringa -* 'pos': posizione (numero di caratteri) +* _string_: stringa +* _pos_: posizione (numero di caratteri) Valore restituito: @@ -2756,8 +2757,8 @@ int weechat_utf8_pos (const char *string, int real_pos); Argomenti: -* 'string': stringa -* 'real_pos': posizione (byte) +* _string_: stringa +* _real_pos_: posizione (byte) Valore restituito: @@ -2775,7 +2776,7 @@ Questa funzione non è disponibile nelle API per lo scripting. ==== utf8_strndup -Restituisce la stringa duplicata, di lunghezza massima 'lenght'. +Restituisce la stringa duplicata, di lunghezza massima _length_. Prototipo: @@ -2786,8 +2787,8 @@ char *weechat_utf8_strndup (const char *string, int length); Argomenti: -* 'string': stringa -* 'length': caratteri massimi da duplicare +* _string_: stringa +* _length_: caratteri massimi da duplicare Valore restituito: @@ -2823,8 +2824,8 @@ int weechat_mkdir_home (char *directory, int mode); Argomenti: -* 'directory': nome della cartella da creare -* 'mode': modalità per la cartella +* _directory_: nome della cartella da creare +* _mode_: modalità per la cartella Valore restituito: @@ -2864,8 +2865,8 @@ int weechat_mkdir (char *directory, int mode); Argomenti: -* 'directory': nome della cartella da creare -* 'mode': modalità per la cartella +* _directory_: nome della cartella da creare +* _mode_: modalità per la cartella Valore restituito: @@ -2905,8 +2906,8 @@ int weechat_mkdir_parents (char *directory, int mode); Argomenti: -* 'directory': nome della cartella da creare -* 'mode': modalità per la cartella +* _directory_: nome della cartella da creare +* _mode_: modalità per la cartella Valore restituito: @@ -2953,12 +2954,12 @@ void weechat_exec_on_files (const char *directory, Argomenti: -* 'directory': cartella in cui cercare i file -* 'hidden_files': 1 per includere i file nascosti, altrimenti 0 -* 'callback': funzione chiamata per ogni file trovato, argomenti: -** 'void *data': puntatore -** 'const char *filename': nome file trovato -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat +* _directory_: cartella in cui cercare i file +* _hidden_files_: 1 per includere i file nascosti, altrimenti 0 +* _callback_: funzione chiamata per ogni file trovato, argomenti: +** _void *data_: puntatore +** _const char *filename_: nome file trovato +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat Esempio in C: @@ -2990,7 +2991,7 @@ char *weechat_file_get_content (const char *filename); Argomenti: -* 'filename': percorso e nome file +* _filename_: percorso e nome file Valore restituito: @@ -3029,8 +3030,8 @@ int weechat_util_timeval_cmp (struct timeval *tv1, struct timeval *tv2); Argomenti: -* 'tv1': prima struttura "timeval" -* 'tv2': seconda struttura "timeval" +* _tv1_: prima struttura "timeval" +* _tv2_: seconda struttura "timeval" Valore restituito: @@ -3068,8 +3069,8 @@ long long weechat_util_timeval_diff (struct timeval *tv1, struct timeval *tv2); Argomenti: -* 'tv1': prima struttura "timeval" -* 'tv2': seconda struttura "timeval" +* _tv1_: prima struttura "timeval" +* _tv2_: seconda struttura "timeval" Valore restituito: @@ -3107,9 +3108,9 @@ void weechat_util_timeval_add (struct timeval *tv, long long interval); Argomenti: -* 'tv': struttura timeval +* _tv_: struttura timeval // TRANSLATION MISSING -* 'interval': interval (in microseconds) +* _interval_: interval (in microseconds) // TRANSLATION MISSING [NOTE] @@ -3132,7 +3133,7 @@ _WeeChat ≥ 0.3.2, updated in 1.3._ // TRANSLATION MISSING Get date/time as a string built with "strftime" and the format defined in -option 'weechat.look.time_format'. +option _weechat.look.time_format_. Prototipo: @@ -3143,7 +3144,7 @@ const char *weechat_util_get_time_string (const time_t *date); Argomenti: -* 'date': puntatore alla data +* _date_: puntatore alla data Valore restituito: @@ -3179,7 +3180,7 @@ int weechat_util_version_number (const char *version); Argomenti: // TRANSLATION MISSING -* 'version': WeeChat version as string (example: "0.3.9" or "0.3.9-dev") +* _version_: WeeChat version as string (example: "0.3.9" or "0.3.9-dev") Esempio in C: @@ -3248,13 +3249,13 @@ struct t_weelist_item *weechat_list_add (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'data': dati da inserire nella lista -* 'where': posizione nella lista: -** 'WEECHAT_LIST_POS_SORT': aggiunge alla lista, mantenendola ordinata -** 'WEECHAT_LIST_POS_BEGINNING': aggiunge all'inizio della lista -** 'WEECHAT_LIST_POS_END': aggiunge alla fine della lista -* 'user_data': qualsiasi puntatore +* _weelist_: puntatore alla lista +* _data_: dati da inserire nella lista +* _where_: posizione nella lista: +** _WEECHAT_LIST_POS_SORT_: aggiunge alla lista, mantenendola ordinata +** _WEECHAT_LIST_POS_BEGINNING_: aggiunge all'inizio della lista +** _WEECHAT_LIST_POS_END_: aggiunge alla fine della lista +* _user_data_: qualsiasi puntatore Valore restituito: @@ -3293,8 +3294,8 @@ struct t_weelist_item *weechat_list_search (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'data': dati da cercare nella lista +* _weelist_: puntatore alla lista +* _data_: dati da cercare nella lista Valore restituito: @@ -3334,8 +3335,8 @@ int weechat_list_search_pos (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'data': dati da cercare nella lista +* _weelist_: puntatore alla lista +* _data_: dati da cercare nella lista Valore restituito: @@ -3374,8 +3375,8 @@ struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'data': dati da cercare nella lista +* _weelist_: puntatore alla lista +* _data_: dati da cercare nella lista Valore restituito: @@ -3415,8 +3416,8 @@ int weechat_list_casesearch_pos (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'data': dati da cercare nella lista +* _weelist_: puntatore alla lista +* _data_: dati da cercare nella lista Valore restituito: @@ -3454,8 +3455,8 @@ struct t_weelist_item *weechat_list_get (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'position': posizione nella lista (il primo elemento è 0) +* _weelist_: puntatore alla lista +* _position_: posizione nella lista (il primo elemento è 0) Valore restituito: @@ -3492,8 +3493,8 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); Argomenti: -* 'item': puntatore all'elemento -* 'value': nuovo valore per l'elemento +* _item_: puntatore all'elemento +* _value_: nuovo valore per l'elemento Esempio in C: @@ -3526,7 +3527,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); Argomenti: -* 'item': puntatore all'elemento +* _item_: puntatore all'elemento Valore restituito: @@ -3564,7 +3565,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); Argomenti: -* 'item': puntatore all'elemento +* _item_: puntatore all'elemento Valore restituito: @@ -3602,7 +3603,7 @@ const char *weechat_list_string (struct t_weelist_item *item); Argomenti: -* 'item': puntatore all'elemento +* _item_: puntatore all'elemento Valore restituito: @@ -3639,7 +3640,7 @@ char *weechat_list_size (struct t_weelist *weelist); Argomenti: -* 'weelist': puntatore alla lista +* _weelist_: puntatore alla lista Valore restituito: @@ -3678,8 +3679,8 @@ void weechat_list_remove (struct t_weelist *weelist, Argomenti: -* 'weelist': puntatore alla lista -* 'item': puntatore all'elemento +* _weelist_: puntatore alla lista +* _item_: puntatore all'elemento Esempio in C: @@ -3712,7 +3713,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); Argomenti: -* 'weelist': puntatore alla lista +* _weelist_: puntatore alla lista Esempio in C: @@ -3745,7 +3746,7 @@ void weechat_list_free (struct t_weelist *weelist); Argomenti: -* 'weelist': puntatore alla lista +* _weelist_: puntatore alla lista Esempio in C: @@ -3792,39 +3793,39 @@ struct t_hashtable *weechat_hashtable_new (int size, Argomenti: -* 'size': dimensione dell'array interno per memorizzare le chiavi con hash, un +* _size_: dimensione dell'array interno per memorizzare le chiavi con hash, un valore più alto usa più memoria, ma ha migliori performance. (questo *non* è un limite per il numero di elementi nella tabella hash) -* 'type_keys': tipo per le chiavi nella tabella hash: -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'type_values': tipo per i valori nella tabella hash: -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -// TRANSLATION MISSING -* 'callback_hash_key': callback used to "hash" a key (key as integer value), can +* _type_keys_: tipo per le chiavi nella tabella hash: +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _type_values_: tipo per i valori nella tabella hash: +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +// TRANSLATION MISSING +* _callback_hash_key_: callback used to "hash" a key (key as integer value), can be NULL if key type is not "buffer" (a default hash function is used), arguments and return value: -** 'struct t_hashtable *hashtable': puntatore alla tabella hash -** 'const void *key': chiave +** _struct t_hashtable *hashtable_: puntatore alla tabella hash +** _const void *key_: chiave ** return value: hash della chiave // TRANSLATION MISSING -* 'callback_keycmp': callback used to compare two keys, can be NULL if key type +* _callback_keycmp_: callback used to compare two keys, can be NULL if key type is not "buffer" (a default comparison function is used), arguments and return value: -** 'struct t_hashtable *hashtable': puntatore alla tabella hash -** 'const void *key1': prima chiave -** 'const void *key2': seconda chiave +** _struct t_hashtable *hashtable_: puntatore alla tabella hash +** _const void *key1_: prima chiave +** _const void *key2_: seconda chiave ** valore restituito: -*** numero negativo se 'key1' è minore di 'key2' -*** 0 se 'key1' è uguale a 'key2' -*** numero positivo se 'key1' è maggiore di 'key2' +*** numero negativo se _key1_ è minore di _key2_ +*** 0 se _key1_ è uguale a _key2_ +*** numero positivo se _key1_ è maggiore di _key2_ Valore restituito: @@ -3863,12 +3864,12 @@ struct t_hashtable_item *weechat_hashtable_set_with_size (struct t_hashtable *ha Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'key': puntatore alla chiave -* 'key_size': dimensione della chiave (in byte), usata solo se il tipo delle +* _hashtable_: puntatore alla tabella hash +* _key_: puntatore alla chiave +* _key_size_: dimensione della chiave (in byte), usata solo se il tipo delle chiavi nella tabella hash è "buffer" -* 'value': puntatore al valore -* 'value_size': dimensione del valore (in byte), utilizzata solo se il tipo dei +* _value_: puntatore al valore +* _value_size_: dimensione del valore (in byte), utilizzata solo se il tipo dei valori nella tabella è "buffer" Valore restituito: @@ -3904,9 +3905,9 @@ struct t_hashtable_item *weechat_hashtable_set (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'key': puntatore alla chiave -* 'value': puntatore al valore +* _hashtable_: puntatore alla tabella hash +* _key_: puntatore alla chiave +* _value_: puntatore al valore Valore restituito: @@ -3935,8 +3936,8 @@ void *weechat_hashtable_get (struct t_hashtable *hashtable, void *key); Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'key': puntatore alla chiave +* _hashtable_: puntatore alla tabella hash +* _key_: puntatore alla chiave Valore restituito: @@ -3968,8 +3969,8 @@ int weechat_hashtable_has_key (struct t_hashtable *hashtable, void *key); Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'key': puntatore alla chiave +* _hashtable_: puntatore alla tabella hash +* _key_: puntatore alla chiave Valore restituito: @@ -4009,9 +4010,9 @@ void weechat_hashtable_map (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'callback_map': funzione chiamata per ogni voce nella tabella hash -* 'callback_map_data': puntatore fornito alla mappa di callback quando chiamata +* _hashtable_: puntatore alla tabella hash +* _callback_map_: funzione chiamata per ogni voce nella tabella hash +* _callback_map_data_: puntatore fornito alla mappa di callback quando chiamata Esempio in C: @@ -4054,12 +4055,12 @@ void weechat_hashtable_map_string (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'callback_map': funzione chiamata per ogni voce nella tabella hash -* 'callback_map_data': puntatore fornito alla mappa di callback quando chiamata +* _hashtable_: puntatore alla tabella hash +* _callback_map_: funzione chiamata per ogni voce nella tabella hash +* _callback_map_data_: puntatore fornito alla mappa di callback quando chiamata [NOTE] -Le stringhe 'key' e 'value' inviate alla callback sono temporanee, vengono +Le stringhe _key_ e _value_ inviate alla callback sono temporanee, vengono eliminate dopo la chiamata alla callback. Esempio in C: @@ -4097,7 +4098,7 @@ struct t_hashtable *weechat_hashtable_dup (struct t_hashtable *hashtable); Argomenti: -* 'hashtable': puntatore alla tabella hash +* _hashtable_: puntatore alla tabella hash Valore restituito: @@ -4130,10 +4131,10 @@ int weechat_hashtable_get_integer (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'property': nome della proprietà: -** 'size': dimensione dell'array interno "htable" nella tabella hash -** 'items_count': numero di elementi nella tabella hash +* _hashtable_: puntatore alla tabella hash +* _property_: nome della proprietà: +** _size_: dimensione dell'array interno "htable" nella tabella hash +** _items_count_: numero di elementi nella tabella hash Valore restituito: @@ -4165,26 +4166,26 @@ const char *weechat_hashtable_get_string (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'property': nome della proprietà: -** 'type_keys': tipo per le chiavi: -*** 'integer': intero -*** 'string': stringa -*** 'pointer': puntatore -*** 'buffer': buffer -*** 'time': tempo -** 'type_values': tipo per i valori: -*** 'integer': intero -*** 'string': stringa -*** 'pointer': puntatore -*** 'buffer': buffer -*** 'time': tempo -** 'keys': stringa con la lista di chiavi (formato: "chiave1,chiave2,chiave3") -** 'keys_sorted': stringa con l'elenco di chiavi ordinate (formato: "chiave1,chiave2,chiave3") -** 'values': stringa con la lista di valori (formato: "valore1,valore2,valore3") -** 'keys_values': stringa con la lista di valori e chiavi +* _hashtable_: puntatore alla tabella hash +* _property_: nome della proprietà: +** _type_keys_: tipo per le chiavi: +*** _integer_: intero +*** _string_: stringa +*** _pointer_: puntatore +*** _buffer_: buffer +*** _time_: tempo +** _type_values_: tipo per i valori: +*** _integer_: intero +*** _string_: stringa +*** _pointer_: puntatore +*** _buffer_: buffer +*** _time_: tempo +** _keys_: stringa con la lista di chiavi (formato: "chiave1,chiave2,chiave3") +** _keys_sorted_: stringa con l'elenco di chiavi ordinate (formato: "chiave1,chiave2,chiave3") +** _values_: stringa con la lista di valori (formato: "valore1,valore2,valore3") +** _keys_values_: stringa con la lista di valori e chiavi (formato: "chiave1:valore1,chiave2:valore2,chiave3:valore3") -** 'keys_values_sorted': stringa con la lista di chiavi e valori (ordinata per chiavi) +** _keys_values_sorted_: stringa con la lista di chiavi e valori (ordinata per chiavi) (formato: "chiave1:valore1,chiave2:valore2,chiave3:valore3") Valore restituito: @@ -4220,15 +4221,15 @@ void weechat_hashtable_set_pointer (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'property': nome della proprietà: +* _hashtable_: puntatore alla tabella hash +* _property_: nome della proprietà: // TRANSLATION MISSING -** 'callback_free_key': set callback function used to free keys in hashtable +** _callback_free_key_: set callback function used to free keys in hashtable _(WeeChat ≥ 0.4.2)_ -** 'callback_free_value': imposta la funzione callback usata per +** _callback_free_value_: imposta la funzione callback usata per liberare i valori nella tabella hash // TRANSLATION MISSING -* 'pointer': new pointer value for property +* _pointer_: new pointer value for property Esempio in C: @@ -4270,9 +4271,9 @@ int weechat_hashtable_add_to_infolist (struct t_hashtable *hashtable, Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'infolist_item': puntatore all'elemento della lista info -* 'prefix': stringa usata come prefisso per i nomi nella lista info +* _hashtable_: puntatore alla tabella hash +* _infolist_item_: puntatore all'elemento della lista info +* _prefix_: stringa usata come prefisso per i nomi nella lista info Valore restituito: @@ -4313,8 +4314,8 @@ void weechat_hashtable_remove (struct t_hashtable *hashtable, const void *key); Argomenti: -* 'hashtable': puntatore alla tabella hash -* 'key': puntatore alla chiave +* _hashtable_: puntatore alla tabella hash +* _key_: puntatore alla chiave Esempio in C: @@ -4341,7 +4342,7 @@ void weechat_hashtable_remove_all (struct t_hashtable *hashtable); Argomenti: -* 'hashtable': puntatore alla tabella hash +* _hashtable_: puntatore alla tabella hash Esempio in C: @@ -4368,7 +4369,7 @@ void weechat_hashtable_free (struct t_hashtable *hashtable); Argomenti: -* 'hashtable': puntatore alla tabella hash +* _hashtable_: puntatore alla tabella hash Esempio in C: @@ -4406,21 +4407,21 @@ struct t_config_file *weechat_config_new (const char *name, Argomenti: -* 'name': nome del file di configurazione (senza percorso o estensione) -* 'callback_reload': funzione chiamata quando il file di configurazione viene +* _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 e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_config_file *config_file': puntatore al file di configurazione +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito per ricaricare il callback +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_reload_pointer_: puntatore fornito per ricaricare il callback quando richiesto da WeeChat // TRANSLATION MISSING -* 'callback_reload_data': puntatore fornito dalla callback quando chiamata da +* _callback_reload_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the configuration file is freed @@ -4524,101 +4525,101 @@ struct t_config_section *weechat_config_new_section ( Argomenti: -* 'config_file': puntatore al file di configurazione -* 'name': nome della sezione -* 'user_can_add_options': 1 se l'utente può creare nuove opzioni nella sezione, +* _config_file_: puntatore al file di configurazione +* _name_: nome della sezione +* _user_can_add_options_: 1 se l'utente può creare nuove opzioni nella sezione, oppure 0 se non gli è consentito -* 'user_can_delete_options': 1 se l'utente può eliminare le opzioni nella sezione, +* _user_can_delete_options_: 1 se l'utente può eliminare le opzioni nella sezione, oppure 0 se non gli è consentito -* 'callback_read': funzione chiamata quando un'opzione nella sezione viene letta +* _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 e valore restituito: -** 'const void *pointer': puntatore -** '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 +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando chiamata da +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_read_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_read_data': puntatore fornito dalla callback quando chiamata da +* _callback_read_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_write': funzione chiamata quando la sezione è scritta nel file (dovrebbe +* _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 e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_config_file *config_file': puntatore al file di configurazione -** 'const char *section_name': nome della sezione +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando chiamata da +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_write_data': puntatore fornito dalla callback quando chiamata da +* _callback_write_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_write_default': funzione chiamata quando i valori predefiniti per +* _callback_write_default_: funzione chiamata quando i valori predefiniti per la sezione devono essere scritti in un file, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_config_file *config_file': puntatore al file di configurazione -** 'const char *section_name': nome della sezione +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_default_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_write_default_data': puntatore fornito dalla callback quando +* _callback_write_default_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_create_option': funzione chiamata quando viene creata una nuova +* _callback_create_option_: funzione chiamata quando viene creata una nuova opzione nella sezione (NULL se la sezione non consente di creare nuove opzioni), argomenti e valore restituito: -** 'const void *pointer': puntatore -** '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 +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando +*** _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_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_create_option_data': puntatore fornito dalla callback quando +* _callback_create_option_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed -* 'callback_delete_option': funzione chiamata quando un'opzione viene eliminata +* _callback_delete_option_: funzione chiamata quando un'opzione viene eliminata nella sezione (NULL se la sezione non consente di eliminare delle opzioni), argomenti e valore restituito: -** 'const void *pointer': puntatore -** '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 +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando +*** _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_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_delete_option_data': puntatore fornito dalla callback quando +* _callback_delete_option_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the section is freed @@ -4776,8 +4777,8 @@ struct t_config_section *weechat_config_search_section ( Argomenti: -* 'config_file': puntatore al file di configurazione -* 'section_name': nome della sezione da cercare +* _config_file_: puntatore al file di configurazione +* _section_name_: nome della sezione da cercare Valore restituito: @@ -4845,62 +4846,62 @@ struct t_config_option *weechat_config_new_option ( Argomenti: -* 'config_file': puntatore al file di configurazione -* 'section': puntatore alla sezione +* _config_file_: puntatore al file di configurazione +* _section_: puntatore alla sezione // TRANSLATION MISSING -* 'name': nome dell'opzione; with WeeChat ≥ 1.4, the name can include a parent +* _name_: nome dell'opzione; with WeeChat ≥ 1.4, the name can include a parent option name (the value of parent option will be displayed in `/set` command output if this option is "null"), the syntax is then: "name << file.section.option" -* 'type': tipo dell'opzione: -** 'boolean': valore booleano (on/off) -** 'integer': valore intero (con stringhe opzionali per i valori) -** 'string': valore stringa -** 'color': colore -* 'description': descrizione dell'opzione -* 'string_values': valori come stringa (separati da "|"), usato dal tipo 'integer' +* _type_: tipo dell'opzione: +** _boolean_: valore booleano (on/off) +** _integer_: valore intero (con stringhe opzionali per i valori) +** _string_: valore stringa +** _color_: colore +* _description_: descrizione dell'opzione +* _string_values_: valori come stringa (separati da `+|+`), usato dal tipo _integer_ (opzionale) -* 'min': valore minimo (per il tipo 'integer') -* 'max': valore massimo (per il tipo 'integer') -* 'default_value': valore predefinito per l'opzione (usato per il reset dell'opzione) -* 'value': valore per l'opzione -* 'null_value_allowed': 1 se 'null' (valore non definito) è consentito per l'opzione, +* _min_: valore minimo (per il tipo _integer_) +* _max_: valore massimo (per il tipo _integer_) +* _default_value_: valore predefinito per l'opzione (usato per il reset dell'opzione) +* _value_: valore per l'opzione +* _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 +* _callback_check_value_: funzione chiamata per verificare il nuovo valore per l'opzione (ozionale), argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_config_option *option': puntatore all'opzione -** 'const char *value': nuovo valore per l'opzione +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_config_option *option_: puntatore all'opzione +** _const char *value_: nuovo valore per l'opzione ** valore restituito: *** 1 se il valore è corretto *** 0 se il valore non è valido -* 'callback_check_value_pointer': puntatore fornito alla callback check_value +* _callback_check_value_pointer_: puntatore fornito alla callback check_value quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_check_value_data': puntatore fornito dalla callback quando chiamata +* _callback_check_value_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the option is freed -* 'callback_change': funzione chiamata quando il valore dell'opzione è stata +* _callback_change_: funzione chiamata quando il valore dell'opzione è stata cambiata (opzionale), argomenti: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_config_option *option': puntatore all'opzione -* 'callback_change_pointer': puntatore fornito per cambiare alla callback +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_config_option *option_: puntatore all'opzione +* _callback_change_pointer_: puntatore fornito per cambiare alla callback quando chiamato da WeeChat // TRANSLATION MISSING -* 'callback_change_data': puntatore fornito dalla callback quando chiamata da +* _callback_change_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the option is freed -* 'callback_delete': funzione chiamata quando l'opzione verrà eliminata +* _callback_delete_: funzione chiamata quando l'opzione verrà eliminata (opzionale), argomenti: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_config_option *option': puntatore all'opzione -* 'callback_delete_pointer': puntatore fornito per eiliminare alla callback +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_config_option *option_: puntatore all'opzione +* _callback_delete_pointer_: puntatore fornito per eiliminare alla callback quando chiamato da WeeChat // TRANSLATION MISSING -* 'callback_delete_data': puntatore fornito dalla callback quando chiamata da +* _callback_delete_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the option is freed @@ -5042,7 +5043,7 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color", [NOTE] In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6 strings (due to a Ruby limitation of 15 arguments by function), see the -'WeeChat Scripting Guide' for more info _(fixed in version 0.4.1)_. +_WeeChat Scripting Guide_ for more info _(fixed in version 0.4.1)_. ==== config_search_option @@ -5060,9 +5061,9 @@ struct t_config_option *weechat_config_search_option ( Argomenti: -* 'config_file': puntatore al file di configurazione -* 'section': puntatore alla sezione -* 'name': nome dell'opzione da cercare +* _config_file_: puntatore al file di configurazione +* _section_: puntatore alla sezione +* _name_: nome dell'opzione da cercare Valore restituito: @@ -5104,12 +5105,12 @@ void weechat_config_search_section_option (struct t_config_file *config_file, Argomenti: -* 'config_file': puntatore al file di configurazione -* 'section': puntatore alla sezione -* 'option_name': nome dell'opzione -* 'section_found': puntatore al puntatore della sezione, sarà impostato alla +* _config_file_: puntatore al file di configurazione +* _section_: puntatore alla sezione +* _option_name_: nome dell'opzione +* _section_found_: puntatore al puntatore della sezione, sarà impostato alla sezione dell'opzione, se viene trovata -* 'option_found': puntatore al puntatore dell'opzione, sarà impostato al +* _option_found_: puntatore al puntatore dell'opzione, sarà impostato al puntatore di un'opzione, se viene trovata Esempio in C: @@ -5155,15 +5156,15 @@ void weechat_config_search_with_string (const char *option_name, Argomenti: -* 'option_name': nome completo dell'opzione (formato: "file.section.option") -* 'config_file': puntatore al puntatore del file di configurazione, sarà impostato +* _option_name_: nome completo dell'opzione (formato: "file.section.option") +* _config_file_: puntatore al puntatore del file di configurazione, sarà impostato al puntatore al file di configurazione se l'opzione viene trovata -* 'section': puntatore al puntatore della sezione, sarà impostato alla sezione +* _section_: puntatore al puntatore della sezione, sarà impostato alla sezione dell'opzione, se viene trovata -* 'option': puntatore al puntatore dell'opzione, sarà impostato al puntatore di +* _option_: puntatore al puntatore dell'opzione, sarà impostato al puntatore di un'opzione, se viene trovata // TRANSLATION MISSING -* 'pos_option_name': pointer to a string pointer, will be set to pointer to +* _pos_option_name_: pointer to a string pointer, will be set to pointer to name of option, if found Esempio in C: @@ -5206,7 +5207,7 @@ int weechat_config_string_to_boolean (const char *text); Argomenti: -* 'text': testo da analizzare +* _text_: testo da analizzare Valore restituito: @@ -5253,17 +5254,17 @@ int weechat_config_option_reset (struct t_config_option *option, Argomenti: -* 'option': puntatore all'opzione -* 'run_callback': 1 per la chiamata alla callbackse il valore dell'opzione +* _option_: puntatore all'opzione +* _run_callback_: 1 per la chiamata alla callbackse il valore dell'opzione è cambiato, altrimenti 0 Valore restituito: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' se il valore dell'opzione è stato +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ se il valore dell'opzione è stato resettato -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' se il valore non è stato +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ se il valore non è stato modificato -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' in caso di errore +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ in caso di errore Esempio in C: @@ -5314,17 +5315,17 @@ int weechat_config_option_set (struct t_config_option *option, Argomenti: -* 'option': puntatore all'opzione -* 'value': nuovo valore per l'opzione -* 'run_callback': 1 per la chiamata alla callback chang se il valore dell'opzione +* _option_: puntatore all'opzione +* _value_: nuovo valore per l'opzione +* _run_callback_: 1 per la chiamata alla callback chang se il valore dell'opzione è cambiato, altrimenti 0 Valore restituito: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' se il valore dell'opzione è +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ se il valore dell'opzione è cambiato -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' se il valore non è cambiato -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' in caso di errore +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ se il valore non è cambiato +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ in caso di errore Esempio in C: @@ -5375,8 +5376,8 @@ int weechat_config_option_set_null (struct t_config_option *option, Argomenti: -* 'option': puntatore all'opzione -* 'run_callback': 1 per la chiamata alla callback chang se il valore +* _option_: puntatore all'opzione +* _run_callback_: 1 per la chiamata alla callback chang se il valore dell'opzione è cambiato (se non è null), altrimenti 0 [NOTE] @@ -5385,10 +5386,10 @@ Argomenti: Valore restituito: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' se il valore dell'opzione è +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ se il valore dell'opzione è cambiato -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' se il valore non è cambiato -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' in caso di errore +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ se il valore non è cambiato +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ in caso di errore Esempio in C: @@ -5438,16 +5439,16 @@ int weechat_config_option_unset (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione Valore restituito: -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' se il valore dell'opzione non è +* _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ se il valore dell'opzione non è stato ripristinato -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' se il valore dell'opzione è stato +* _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ se il valore dell'opzione è stato ripristinato -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' se l'opzione è stata rimossa -* 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' in caso di errore +* _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ se l'opzione è stata rimossa +* _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ in caso di errore Esempio in C: @@ -5503,8 +5504,8 @@ void weechat_config_option_rename (struct t_config_option *option, Argomenti: -* 'option': puntatore all'opzione -* 'new_name': nuovo nome per l'opzione +* _option_: puntatore all'opzione +* _new_name_: nuovo nome per l'opzione Esempio in C: @@ -5538,22 +5539,22 @@ void *weechat_config_option_get_pointer (struct t_config_option *option, Argomenti: -* 'option': puntatore all'opzione -* 'property': nome della proprietà: -** 'config_file': puntatore al file di configurazione ('struct t_config_file *') -** 'section': puntatore alla sezione ('struct t_config_section *') -** 'name': nome dell'opzione ('char *') +* _option_: puntatore all'opzione +* _property_: nome della proprietà: +** _config_file_: puntatore al file di configurazione (_struct t_config_file *_) +** _section_: puntatore alla sezione (_struct t_config_section *_) +** _name_: nome dell'opzione (_char *_) // TRANSLATION MISSING -** 'parent_name': name of parent option ('char *') _(WeeChat ≥ 1.4)_ -** 'type': tipo dell'opzione ('int *') -** 'description': descrizione dell'opzione ('char *') -** 'string_values': valori stringa ('char *') -** 'min': valore minimo ('int *') -** 'max': valore massimo ('int *') -** 'default_value': valore predefinito (dipende dal tipo) -** 'value': valore corrente (dipende dal tipo) -** 'prev_option': puntatore all'opzione precedente ('struct t_config_option *') -** 'next_option': puntatore all'opzione successiva ('struct t_config_option *') +** _parent_name_: name of parent option (_char *_) _(WeeChat ≥ 1.4)_ +** _type_: tipo dell'opzione (_int *_) +** _description_: descrizione dell'opzione (_char *_) +** _string_values_: valori stringa (_char *_) +** _min_: valore minimo (_int *_) +** _max_: valore massimo (_int *_) +** _default_value_: valore predefinito (dipende dal tipo) +** _value_: valore corrente (dipende dal tipo) +** _prev_option_: puntatore all'opzione precedente (_struct t_config_option *_) +** _next_option_: puntatore all'opzione successiva (_struct t_config_option *_) Valore restituito: @@ -5582,7 +5583,7 @@ int weechat_config_option_is_null (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione Valore restituito: @@ -5628,7 +5629,7 @@ int weechat_config_option_default_is_null (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione Valore restituito: @@ -5674,15 +5675,15 @@ int weechat_config_boolean (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': boolean value of option (0 or 1) -* 'integer': 0 -* 'string': 0 -* 'color': 0 +* _boolean_: boolean value of option (0 or 1) +* _integer_: 0 +* _string_: 0 +* _color_: 0 Esempio in C: @@ -5725,15 +5726,15 @@ int weechat_config_boolean_default (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': default boolean value of option (0 or 1) -* 'integer': 0 -* 'string': 0 -* 'color': 0 +* _boolean_: default boolean value of option (0 or 1) +* _integer_: 0 +* _string_: 0 +* _color_: 0 Esempio in C: @@ -5776,15 +5777,15 @@ int weechat_config_integer (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': boolean value of option (0 or 1) -* 'integer': integer value of option -* 'string': 0 -* 'color': color index +* _boolean_: boolean value of option (0 or 1) +* _integer_: integer value of option +* _string_: 0 +* _color_: color index Esempio in C: @@ -5819,15 +5820,15 @@ int weechat_config_integer_default (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': default boolean value of option (0 or 1) -* 'integer': default integer value of option -* 'string': 0 -* 'color': default color index +* _boolean_: default boolean value of option (0 or 1) +* _integer_: default integer value of option +* _string_: 0 +* _color_: default color index Esempio in C: @@ -5862,16 +5863,16 @@ const char *weechat_config_string (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': "on" if value is true, otherwise "off" -* 'integer': string value if the option is an integer with string values, +* _boolean_: "on" if value is true, otherwise "off" +* _integer_: string value if the option is an integer with string values, otherwise NULL -* 'string': string value of option -* 'color': name of color +* _string_: string value of option +* _color_: name of color Esempio in C: @@ -5906,16 +5907,16 @@ const char *weechat_config_string_default (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': "on" if default value is true, otherwise "off" -* 'integer': default string value if the option is an integer with string +* _boolean_: "on" if default value is true, otherwise "off" +* _integer_: default string value if the option is an integer with string values, otherwise NULL -* 'string': default string value of option -* 'color': name of default color +* _string_: default string value of option +* _color_: name of default color Esempio in C: @@ -5950,15 +5951,15 @@ const char *weechat_config_color (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': NULL -* 'integer': NULL -* 'string': NULL -* 'color': name of color +* _boolean_: NULL +* _integer_: NULL +* _string_: NULL +* _color_: name of color Esempio in C: @@ -5993,15 +5994,15 @@ const char *weechat_config_color_default (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione // TRANSLATION MISSING Return value, depending on the option type: -* 'boolean': NULL -* 'integer': NULL -* 'string': NULL -* 'color': name of default color +* _boolean_: NULL +* _integer_: NULL +* _string_: NULL +* _color_: name of default color Esempio in C: @@ -6039,8 +6040,8 @@ void weechat_config_write_option (struct t_config_file *config_file, Argomenti: -* 'config_file': puntatore al file di configurazione -* 'option': puntatore all'opzione +* _config_file_: puntatore al file di configurazione +* _option_: puntatore all'opzione Esempio in C: @@ -6090,9 +6091,9 @@ void weechat_config_write_line (struct t_config_file *config_file, Argomenti: -* 'config_file': puntatore al file di configurazione -* 'option_name': nome dell'opzione -* 'value': valore (se NULL, allora la riga con il nome della sezione viene +* _config_file_: puntatore al file di configurazione +* _option_name_: nome dell'opzione +* _value_: valore (se NULL, allora la riga con il nome della sezione viene scritto, ad esempio: "[section]") Esempio in C: @@ -6140,13 +6141,13 @@ int weechat_config_write (struct t_config_file *config_file); Argomenti: -* 'config_file': puntatore al file di configurazione +* _config_file_: puntatore al file di configurazione Valore restituito: -* 'WEECHAT_CONFIG_WRITE_OK' se la configurazione è stata scritta -* 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' se non c'è memoria sufficiente -* 'WEECHAT_CONFIG_WRITE_ERROR' se si è verificato un altro errore +* _WEECHAT_CONFIG_WRITE_OK_ se la configurazione è stata scritta +* _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ se non c'è memoria sufficiente +* _WEECHAT_CONFIG_WRITE_ERROR_ se si è verificato un altro errore Esempio in C: @@ -6196,13 +6197,13 @@ int weechat_config_read (struct t_config_file *config_file); Argomenti: -* 'config_file': puntatore al file di configurazione +* _config_file_: puntatore al file di configurazione Valore restituito: -* 'WEECHAT_CONFIG_READ_OK' se la configurazione è stata caricata -* 'WEECHAT_CONFIG_READ_MEMORY_ERROR' se non c'è memoria sufficiente -* 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' se il file non è stato trovato +* _WEECHAT_CONFIG_READ_OK_ se la configurazione è stata caricata +* _WEECHAT_CONFIG_READ_MEMORY_ERROR_ se non c'è memoria sufficiente +* _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ se il file non è stato trovato Esempio in C: @@ -6252,13 +6253,13 @@ int weechat_config_reload (struct t_config_file *config_file); Argomenti: -* 'config_file': configuration file pointer +* _config_file_: configuration file pointer Valore restituito: -* 'WEECHAT_CONFIG_READ_OK' se il file di configurazione è stato ricaricato -* 'WEECHAT_CONFIG_READ_MEMORY_ERROR' se non c'è memoria sufficiente -* 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' se il file non è stato trovato +* _WEECHAT_CONFIG_READ_OK_ se il file di configurazione è stato ricaricato +* _WEECHAT_CONFIG_READ_MEMORY_ERROR_ se non c'è memoria sufficiente +* _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ se il file non è stato trovato Esempio in C: @@ -6308,7 +6309,7 @@ void weechat_config_option_free (struct t_config_option *option); Argomenti: -* 'option': puntatore all'opzione +* _option_: puntatore all'opzione Esempio in C: @@ -6341,7 +6342,7 @@ void weechat_config_section_free_options (struct t_config_section *section); Argomenti: -* 'section': puntatore alla sezione +* _section_: puntatore alla sezione Esempio in C: @@ -6374,7 +6375,7 @@ void weechat_config_section_free (struct t_config_section *section); Argomenti: -* 'section': puntatore alla sezione +* _section_: puntatore alla sezione Esempio in C: @@ -6407,7 +6408,7 @@ void weechat_config_free (struct t_config_file *config_file); Argomenti: -* 'config_file': puntatore al file di configurazione +* _config_file_: puntatore al file di configurazione Esempio in C: @@ -6440,7 +6441,7 @@ struct t_config_option *weechat_config_get (const char *option_name); Argomenti: -* 'option_name': nome completo dell'opzione (formato: "file.section.option") +* _option_name_: nome completo dell'opzione (formato: "file.section.option") Valore restituito: @@ -6477,7 +6478,7 @@ const char *weechat_config_get_plugin (const char *option_name); Argomenti: -* 'option_name': nome dell'opzione, WeeChat aggiungerà il prefisso +* _option_name_: nome dell'opzione, WeeChat aggiungerà il prefisso "plugins.var.xxx." (dove "xxx" è il nome del plugin corrente) Valore restituito: @@ -6518,7 +6519,7 @@ int weechat_config_is_set_plugin (const char *option_name); Argomenti: -* 'option_name': nome dell'opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." +* _option_name_: nome dell'opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." (dove "xxx" è il nome del plugin corrente) Valore restituito: @@ -6568,16 +6569,16 @@ int weechat_config_set_plugin (const char *option_name, const char *value); Argomenti: -* 'option_name': nome dell'opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." +* _option_name_: nome dell'opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." (dove "xxx" è il nome del plugin corrente) -* 'value': new value for option +* _value_: new value for option Valore restituito: -* 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' se il valore dell'opzione è stato modificato -* 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' se il valore non è cambiato -* 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' se l'opzione non è stata trovata -* 'WEECHAT_CONFIG_OPTION_SET_ERROR' in caso di errore +* _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ se il valore dell'opzione è stato modificato +* _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ se il valore non è cambiato +* _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ se l'opzione non è stata trovata +* _WEECHAT_CONFIG_OPTION_SET_ERROR_ in caso di errore Esempio in C: @@ -6636,9 +6637,9 @@ void weechat_config_set_desc_plugin (const char *option_name, Argomenti: -* 'option_name': nome dell'opzione, WeeChat aggiungerà il prefisso "plugins.desc.xxx." +* _option_name_: nome dell'opzione, WeeChat aggiungerà il prefisso "plugins.desc.xxx." (dove "xxx" è il nome del plugin corrente) -* 'description': descrizione per l'opzione +* _description_: descrizione per l'opzione [NOTE] Non è un problema se l'opzione (plugins.var.xx.option_name) non esiste. @@ -6677,17 +6678,17 @@ int weechat_config_unset_plugin (const char *option_name); Argomenti: -* 'option_name': nome dell'opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." +* _option_name_: nome dell'opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." (dove xxx è il nome del plugin corrente) Valore restituito: -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' se il valore dell'opzione non è +* _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ se il valore dell'opzione non è stato resettato -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' se il valore dell'opzione è stato +* _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ se il valore dell'opzione è stato resettato -* 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' se l'opzione è stata rimossa -* 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' in caso di errore +* _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ se l'opzione è stata rimossa +* _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ in caso di errore Esempio in C: @@ -6754,12 +6755,12 @@ int weechat_key_bind (const char *context, struct t_hashtable *keys); Argomenti: -* 'context': contesto per i tasti: -** 'default': contesto default (azioni comuni) -** 'search': contesto search (quando si cerca testo nel buffer) -** 'cursor': movimento libero del cursore sullo schermo -** 'mouse': tasti per gli eventi del mouse -* 'keys': tabella hash con le combinazioni dei tasti +* _context_: contesto per i tasti: +** _default_: contesto default (azioni comuni) +** _search_: contesto search (quando si cerca testo nel buffer) +** _cursor_: movimento libero del cursore sullo schermo +** _mouse_: tasti per gli eventi del mouse +* _keys_: tabella hash con le combinazioni dei tasti Valore restituito: @@ -6817,9 +6818,9 @@ int weechat_key_unbind (const char *context, const char *key); Argomenti: -* 'context': contesto per i tasti (consultare <<_key_bind,weechat_key_bind>>) -* 'key': tasto da rimuovere o un valore speciale "area:XXX" per rimuovere tutti - i tasti che hanno 'XXX' come prima o seconda area +* _context_: contesto per i tasti (consultare <<_key_bind,weechat_key_bind>>) +* _key_: tasto da rimuovere o un valore speciale "area:XXX" per rimuovere tutti + i tasti che hanno _XXX_ come prima o seconda area Valore restituito: @@ -6871,7 +6872,7 @@ const char *weechat_prefix (const char *prefix); Argomenti: // TRANSLATION MISSING -* 'prefix': nome del prefisso, see table below +* _prefix_: nome del prefisso, see table below Valore restituito: @@ -6881,14 +6882,14 @@ Valore restituito: // TRANSLATION MISSING List of prefixes: -[width="70%",cols="^2e,^1,^3,5",options="header"] +[width="70%",cols="^2m,^1,^3,5",options="header"] |=== -| Prefisso | Valore | Colore | Descrizione -| error | `=!=` | giallo | Messaggio di errore -| network | `--` | magenta | Messaggio dalla rete -| action | `*` | bianco | Azione automatica -| join | `-->` | verde chiaro | Qualcuno entra nella chat corrente -| quit | `<--` | rosso chiaro | Qualcuno lascia la chat corrente +| Prefisso | Valore | Colore | Descrizione +| error | `+=!=+` | giallo | Messaggio di errore +| network | `+--+` | magenta | Messaggio dalla rete +| action | `+*+` | bianco | Azione automatica +| join | `+-->+` | verde chiaro | Qualcuno entra nella chat corrente +| quit | `+<--+` | rosso chiaro | Qualcuno lascia la chat corrente |=== [NOTE] @@ -6925,52 +6926,52 @@ const char *weechat_color (const char *color_name); Argomenti: -* 'color_name': nome del colore, uno di: +* _color_name_: nome del colore, uno di: // TRANSLATION MISSING ** WeeChat color option name (from weechat.color.xxx), for example - 'chat_delimiters' + _chat_delimiters_ // TRANSLATION MISSING ** option name (format: file.section.option), for example - 'irc.color.message_quit' (_WeeChat ≥ 1.2_) + _irc.color.message_quit_ (_WeeChat ≥ 1.2_) ** colore con attributi/sfondo opzionali (vedi sotto) ** attributo: -*** 'bold': imposta grassetto -*** '-bold': rimuove grassetto -*** 'reverse': imposta inverso -*** '-reverse': rimuove inverso -*** 'italic': imposta corsivo -*** '-italic': rimuove corsivo -*** 'underline': imposta sottolineato -*** '-underline': rimuove sottolineato -// TRANSLATION MISSING -*** 'emphasis': toggle the emphasis for text (note: this should be used only in +*** _bold_: imposta grassetto +*** _-bold_: rimuove grassetto +*** _reverse_: imposta inverso +*** _-reverse_: rimuove inverso +*** _italic_: imposta corsivo +*** _-italic_: rimuove corsivo +*** _underline_: imposta sottolineato +*** _-underline_: rimuove sottolineato +// TRANSLATION MISSING +*** _emphasis_: toggle the emphasis for text (note: this should be used only in bars, because WeeChat uses text emphasis when searching text in buffer) _(WeeChat ≥ 0.4.2)_ ** nome colore della barra: -*** 'bar_fg': colore di primo piano della barra -*** 'bar_delim': colore dei delimitatori della barra -*** 'bar_bg': colore di sfondo della barra +*** _bar_fg_: colore di primo piano della barra +*** _bar_delim_: colore dei delimitatori della barra +*** _bar_bg_: colore di sfondo della barra ** reset: -*** 'reset': ripristina colore ed attributi -*** 'resetcolor': ripristina colore (mantiene attributi) _(WeeChat ≥ 0.3.6)_ +*** _reset_: ripristina colore ed attributi +*** _resetcolor_: ripristina colore (mantiene attributi) _(WeeChat ≥ 0.3.6)_ Il formato del colore è: attributi (opzionale) + nome colore +",sfondo" (opzionale). Gli attributi possibili sono: -* `*` : testo in grassetto -* `!` : video inverso -* `/` : corsivo -* `_` : testo sottolineato -* `|` : mantiene attributi: non ripristina +* `+*+` : testo in grassetto +* `+!+` : video inverso +* `+/+` : corsivo +* `+_+` : testo sottolineato +* `+|+` : mantiene attributi: non ripristina grassetto/inverso/corsivo/sottolineato al cambio di colore _(WeeChat ≥ 0.3.6)_ Esempi: -* `yellow` : giallo -* `_green` : verde sottolineato -* `*214` : arancione grassetto -* `yellow,red` : giallo su rosso -* `|cyan` : ciano (e mantiene qualsiasi attributo impostato in precedenza) +* `+yellow+` : giallo +* `+_green+` : verde sottolineato +* `+*214+` : arancione grassetto +* `+yellow,red+` : giallo su rosso +* `+|cyan+` : ciano (e mantiene qualsiasi attributo impostato in precedenza) Valore restituito: @@ -7011,8 +7012,8 @@ void weechat_printf (struct t_gui_buffer *buffer, const char *message, ...); Argomenti: -* 'buffer': puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat -* 'message': messaggio da visualizzare +* _buffer_: puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat +* _message_: messaggio da visualizzare [NOTE] La prima tabulazione nel messaggio ("\t") è usata per separare il prefisso dal messaggio. + @@ -7074,10 +7075,10 @@ void weechat_printf_date (struct t_gui_buffer *buffer, time_t date, Argomenti: -* 'buffer': puntatore al buffer, se NULL, il messaggio viene visualizzato +* _buffer_: puntatore al buffer, se NULL, il messaggio viene visualizzato sul buffer di WeeChat -* 'date': data per il messaggio (0 indica data/ora corrente) -* 'message': messaggio da visualizzare +* _date_: data per il messaggio (0 indica data/ora corrente) +* _message_: messaggio da visualizzare Esempio in C: @@ -7103,10 +7104,10 @@ void weechat_printf_tags (struct t_gui_buffer *buffer, const char *tags, Argomenti: -* 'buffer': puntatore al buffer, se NULL il messaggio viene visualizzato +* _buffer_: puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat -* 'tags': lista di tag separati da virgole -* 'message': messaggio da visualizzare +* _tags_: lista di tag separati da virgole +* _message_: messaggio da visualizzare Esempio in C: @@ -7133,11 +7134,11 @@ void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date, Argomenti: -* 'buffer': puntatore al buffer, se NULL il messaggio viene visualizzato +* _buffer_: puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat -* 'date': data per il messaggio (0 indica data/ora corrente) -* 'tags': lista di tag separati da virgole -* 'message': messaggio da visualizzare +* _date_: data per il messaggio (0 indica data/ora corrente) +* _tags_: lista di tag separati da virgole +* _message_: messaggio da visualizzare Tag usati di frequente (elenco non esaustivo): @@ -7204,13 +7205,13 @@ void weechat_printf_y (struct t_gui_buffer *buffer, int y, Argomenti: -* 'buffer': puntatore al buffer +* _buffer_: puntatore al buffer // TRANSLATION MISSING -* 'y': numero di riga (la prima riga è 0); a negative value adds a line after - last line displayed: absolute value of 'y' is the number of lines after last +* _y_: numero di riga (la prima riga è 0); a negative value adds a line after + last line displayed: absolute value of _y_ is the number of lines after last line (for example -1 is immediately after last line, -2 is 2 lines after last line) _(WeeChat ≥ 1.0)_ -* 'message': messaggio da visualizzare +* _message_: messaggio da visualizzare Esempio in C: @@ -7246,7 +7247,7 @@ void weechat_log_printf (const char *message, ...); Argomenti: -* 'message': messaggio da scrivere +* _message_: messaggio da scrivere Esempio in C: @@ -7330,30 +7331,30 @@ struct t_hook *weechat_hook_command (const char *command, Argomenti: -* 'command': nome del comando +* _command_: nome del comando (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* 'description': descrizione per il comando (visualizzata con `/help comando`) -* 'args': argomenti per il comando (visualizzati con `/help command`) -* 'args_description': descrizione degli argomenti (visualizzata con `/help command`) -* 'completion': modello di completamento per il comando:: elenco di completamenti +* _description_: descrizione per il comando (visualizzata con `/help comando`) +* _args_: argomenti per il comando (visualizzati con `/help command`) +* _args_description_: descrizione degli argomenti (visualizzata con `/help command`) +* _completion_: modello di completamento per il comando:: elenco di completamenti 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 e + 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 e valore restituito: -** 'const void *pointer': puntatore -** '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 +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito dalla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7363,9 +7364,9 @@ include::autogen/plugin_api/completions.asciidoc[] Codici speciali: -* '%%command': riutilizza il modello di completamento dal comando 'command' -* '%-': ferma completamento -* '%*': ripete l'ultimo completamento +* `+%%command+`: riutilizza il modello di completamento dal comando _command_ +* `+%-+`: ferma completamento +* `+%*+`: ripete l'ultimo completamento Valore restituito: @@ -7401,20 +7402,20 @@ struct t_hook *my_command_hook = ---- Ad esempio, se il comando chiamato è `/comando abc def ghi`, allora -'argv' e 'argv_eol' contengono i seguenti valori: +_argv_ e _argv_eol_ contengono i seguenti valori: -* 'argv': -** 'argv[0]' == "/command" -** 'argv[1]' == "abc" -** 'argv[2]' == "def" -** 'argv[3]' == "ghi" -* 'argv_eol': -** 'argv_eol[0]' == "/command abc def ghi" -** 'argv_eol[1]' == "abc def ghi" -** 'argv_eol[2]' == "def ghi" -** 'argv_eol[3]' == "ghi" +* _argv_: +** _argv[0]_ == "/command" +** _argv[1]_ == "abc" +** _argv[2]_ == "def" +** _argv[3]_ == "ghi" +* _argv_eol_: +** _argv_eol[0]_ == "/command abc def ghi" +** _argv_eol[1]_ == "abc def ghi" +** _argv_eol[2]_ == "def ghi" +** _argv_eol[3]_ == "ghi" -Per gli script, 'args' ha valore "abc def ghi". +Per gli script, _args_ ha valore "abc def ghi". Script (Python): @@ -7466,27 +7467,27 @@ struct t_hook *weechat_hook_command_run (const char *command, Argomenti: // TRANSLATION MISSING -* 'command': comando su cui eseguire l'hook (wildcard "*" is allowed) +* _command_: comando su cui eseguire l'hook (wildcard `+*+` is allowed) (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* 'callback': funzione chiamata quando il comando è in esecuzione, argomenti e +* _callback_: funzione chiamata quando il comando è in esecuzione, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_gui_buffer *buffer': buffer dove viene eseguito il comando -** 'const char *command': il comando eseguito, con i propri argomenti +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted [NOTE] -La callback può restituire 'WEECHAT_RC_OK' o 'WEECHAT_RC_OK_EAT' (il comando +La callback può restituire _WEECHAT_RC_OK_ o _WEECHAT_RC_OK_EAT_ (il comando non verrà eseguito da WeeChat dopo la callback). Valore restituito: @@ -7548,25 +7549,25 @@ struct t_hook *weechat_hook_timer (long interval, Argomenti: -* 'interval': intervallo tra due chiamate (millisecondi, 1000 = 1 secondo) +* _interval_: intervallo tra due chiamate (millisecondi, 1000 = 1 secondo) // TRANSLATION MISSING -* 'align_second': allineamento su un secondo. Per esempio, rrent time is 09:00, +* _align_second_: allineamento su un secondo. Per esempio, rrent time is 09:00, if interval = 60000 (60 seconds), and align_second = 60, then timer is called each minute when second is 0 // TRANSLATION MISSING -* 'max_calls': number of calls to timer (if 0, then timer has no end) +* _max_calls_: number of calls to timer (if 0, then timer has no end) // TRANSLATION MISSING -* 'callback': function called when time is reached, argomenti e valore +* _callback_: function called when time is reached, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'int remaining_calls': remaining calls (-1 if timer has no end) +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _int remaining_calls_: remaining calls (-1 if timer has no end) ** valore restituito: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7630,23 +7631,23 @@ struct t_hook *weechat_hook_fd (int fd, Argomenti: -* 'fd': descrittore file -* 'flag_read': 1 = cattura l'evento lettura (read), 0 = ignora -* 'flag_write': 1 = cattura l'evento scrittura (write), 0 = ignora +* _fd_: descrittore file +* _flag_read_: 1 = cattura l'evento lettura (read), 0 = ignora +* _flag_write_: 1 = cattura l'evento scrittura (write), 0 = ignora // TRANSLATION MISSING -* 'flag_exception': 1 = cattura l'eccezione evento (event), 0 = ignora +* _flag_exception_: 1 = cattura l'eccezione evento (event), 0 = ignora (_WeeChat ≥ 1.3_: this argument is ignored and not used any more) -* 'callback': funzione che chiama un evento selezionato che si verifica +* _callback_: funzione che chiama un evento selezionato che si verifica per un file (o un socket), argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'int fd': descrittore file +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _int fd_: descrittore file ** valore restituito: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7701,7 +7702,7 @@ WeeChat makes an automatic split of command and arguments (like the shell does). If the split is not correct (according to quotes in your command), or if you want to use shell, you can use function <<_hook_process_hashtable,weechat_hook_process_hashtable>> with -arguments in the hashtable 'options' _(WeeChat ≥ 0.4.0)_. +arguments in the hashtable _options_ _(WeeChat ≥ 0.4.0)_. Prototipo: @@ -7723,39 +7724,39 @@ struct t_hook *weechat_hook_process (const char *command, Argomenti: // TRANSLATION MISSING -* 'command': command to launch in child process, URL _(WeeChat ≥ 0.3.7)_ or +* _command_: command to launch in child process, URL _(WeeChat ≥ 0.3.7)_ or function _(WeeChat ≥ 1.5)_ (see below) -* 'timeout': timeout per il comando (in millisecondi): dopo questo timeout, +* _timeout_: timeout per il comando (in millisecondi): dopo questo timeout, il processo figlio viene terminato (0 indica nessun timeout) -* 'callback': funzione chiamata quando i dati dal processo figlio sono disponibili, +* _callback_: funzione chiamata quando i dati dal processo figlio sono disponibili, oppure quando è terminato, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *command': comando eseguito dal processo figlio -** 'int return_code': codice restituito: -*** '>= 0': codice ritorno figlio per un comando, e per un URL i valori +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _const char *command_: comando eseguito dal processo figlio +** _int return_code_: codice restituito: +*** _>= 0_: codice ritorno figlio per un comando, e per un URL i valori possibili sono: -**** '0': trasferimento riuscito -**** '1': URL non valido -**** '2': errore di trasferimento -**** '3': memoria non sufficiente -**** '4': errore con un file -*** '< 0': -**** 'WEECHAT_HOOK_PROCESS_RUNNING': dati disponibili, ma figlio ancora in +**** _0_: trasferimento riuscito +**** _1_: URL non valido +**** _2_: errore di trasferimento +**** _3_: memoria non sufficiente +**** _4_: errore con un file +*** _< 0_: +**** _WEECHAT_HOOK_PROCESS_RUNNING_: dati disponibili, ma figlio ancora in esecuzione) -**** 'WEECHAT_HOOK_PROCESS_ERROR': errore nella esecuzione del comando +**** _WEECHAT_HOOK_PROCESS_ERROR_: errore nella esecuzione del comando // TRANSLATION MISSING -**** 'WEECHAT_HOOK_PROCESS_CHILD': callback is called in the child process -** 'out': output standard del comando (stdout) -** 'err': output di errore del comando (stderr) +**** _WEECHAT_HOOK_PROCESS_CHILD_: callback is called in the child process +** _out_: output standard del comando (stdout) +** _err_: output di errore del comando (stderr) ** valore restituito: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ // TRANSLATION MISSING *** child process return code (in case of function with "func:" in command) -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -7774,11 +7775,11 @@ un URL sono disponibili con la funzione // TRANSLATION MISSING The command can also be a function name with format: "func:name", to execute the function "name" _(WeeChat ≥ 1.5)_. This function receives a single argument -('data') and must return a string, which is sent to the callback. + +(_data_) and must return a string, which is sent to the callback. + In C API, the callback is called with the return code set to -'WEECHAT_HOOK_PROCESS_CHILD', which means the callback is running in the child +_WEECHAT_HOOK_PROCESS_CHILD_, which means the callback is running in the child process (after fork). + -In scripting API, the function 'name' is called directly and its result +In scripting API, the function _name_ is called directly and its result (string) is sent to the callback (like the output of an external command). // TRANSLATION MISSING @@ -7952,7 +7953,7 @@ struct t_hook *weechat_hook_process_hashtable (const char *command, Gli argomenti sono gli stessi della funzione <<_hook_process,weechat_hook_process>>, con un argomento aggiuntivo: -* 'options': le opzioni per il comando eseguito; la tabella hash è duplicata +* _options_: le opzioni per il comando eseguito; la tabella hash è duplicata nella funzione, per cui è possibile liberarla dopo questa chiamata // TRANSLATION MISSING @@ -7970,7 +7971,7 @@ available: any string | Arguments for command; if no argument is given with these options, the command is automatically split like the shell does (and then command - arguments are read in the 'command' argument) + arguments are read in the _command_ argument) // TRANSLATION MISSING | stdin + @@ -7991,7 +7992,7 @@ available: _(WeeChat ≥ 1.0)_ | (not used) | Run the process in a detached mode: stdout and stderr are redirected to - '/dev/null' + _/dev/null_ |=== Per il comando "url:..." sono disponibili le seguenti opzioni (consultare @@ -8007,8 +8008,8 @@ l'opzione. Per le opzioni con il tipo "mask" il formato è: Per un URL, sono consentite due opzioni aggiuntive (stringhe) per il file in input/output: -* 'file_in': file da leggere e inviare con gli URL (invio del file "post") -* 'file_out': scrive URL scaricato/file in questo file (invece dello standard +* _file_in_: file da leggere e inviare con gli URL (invio del file "post") +* _file_out_: scrive URL scaricato/file in questo file (invece dello standard * output) Valore restituito: @@ -8174,56 +8175,56 @@ struct t_hook *weechat_hook_connect (const char *proxy, Argomenti: -* 'proxy': nome del proxy da utilizzare per la connessione (opzionale, +* _proxy_: nome del proxy da utilizzare per la connessione (opzionale, NULL significa connessione senza proxy) -* 'address': nome o indirizzo IP al quale connettersi -* 'port': numero della porta +* _address_: nome o indirizzo IP al quale connettersi +* _port_: numero della porta // TRANSLATION MISSING -* 'ipv6': 1 to use IPv6 (with fallback to IPv4), 0 to use only IPv4 +* _ipv6_: 1 to use IPv6 (with fallback to IPv4), 0 to use only IPv4 // TRANSLATION MISSING -* 'retry': retry count, used to fallback to IPv4 hosts if IPv6 hosts connect +* _retry_: retry count, used to fallback to IPv4 hosts if IPv6 hosts connect but then fail to accept the client -* 'gnutls_sess': sessione GnuTLS (opzionale) -* 'gnutls_cb' callback GnuTLS (opzionale) -* 'gnutls_dhkey_size': dimensione della chiave utilizzata nello Scambio +* _gnutls_sess_: sessione GnuTLS (opzionale) +* _gnutls_cb_ callback GnuTLS (opzionale) +* _gnutls_dhkey_size_: dimensione della chiave utilizzata nello Scambio Chiavi Diffie-Hellman (GnuTLS) -* 'gnutls_priorities': priorità per gnutls (per la sintassi, consultare la - documentazione della funzione 'gnutls_priority_init' nel manuale di gnutls), i +* _gnutls_priorities_: priorità per gnutls (per la sintassi, consultare la + documentazione della funzione _gnutls_priority_init_ nel manuale di gnutls), i valori di base sono: -** 'PERFORMANCE' -** 'NORMAL' (predefinito) -** 'SECURE128' -** 'SECURE256' -** 'EXPORT' -** 'NONE' -* 'local_hostname': nome host locale da utilizzare per la connessione +** _PERFORMANCE_ +** _NORMAL_ (predefinito) +** _SECURE128_ +** _SECURE256_ +** _EXPORT_ +** _NONE_ +* _local_hostname_: nome host locale da utilizzare per la connessione (opzionale) -* 'callback': funzione chiamata quando la connessione è avvenuta con +* _callback_: funzione chiamata quando la connessione è avvenuta con successo oppure no, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'int status': stato della connessione: -*** 'WEECHAT_HOOK_CONNECT_OK': connessione avvenuta con successo -*** 'WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND': indirizzo non trovato -*** 'WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND': indirizzo IP non trovato -*** 'WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED': connessione rifiutata -*** 'WEECHAT_HOOK_CONNECT_PROXY_ERROR': errore con il proxy -*** 'WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR': errore con il nome host locale -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR': errore inizializzazione GnuTLS -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR': errore di handshake GnuTLS -*** 'WEECHAT_HOOK_CONNECT_MEMORY_ERROR': memoria insufficiente -*** 'WEECHAT_HOOK_CONNECT_TIMEOUT': timeout -*** 'WEECHAT_HOOK_CONNECT_SOCKET_ERROR': errore nella creazione socket -** 'gnutls_rc': valore del risultato di 'gnutls_handshake()' -** 'sock': socket utilizzato per la connessione -** 'const char *error': valore del risultato di 'gnutls_strerror(gnutls_rc)' -** 'const char *ip_address': indirizzo IP trovato +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _int status_: stato della connessione: +*** _WEECHAT_HOOK_CONNECT_OK_: connessione avvenuta con successo +*** _WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND_: indirizzo non trovato +*** _WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND_: indirizzo IP non trovato +*** _WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED_: connessione rifiutata +*** _WEECHAT_HOOK_CONNECT_PROXY_ERROR_: errore con il proxy +*** _WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR_: errore con il nome host locale +*** _WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR_: errore inizializzazione GnuTLS +*** _WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR_: errore di handshake GnuTLS +*** _WEECHAT_HOOK_CONNECT_MEMORY_ERROR_: memoria insufficiente +*** _WEECHAT_HOOK_CONNECT_TIMEOUT_: timeout +*** _WEECHAT_HOOK_CONNECT_SOCKET_ERROR_: errore nella creazione socket +** _gnutls_rc_: valore del risultato di _gnutls_handshake()_ +** _sock_: socket utilizzato per la connessione +** _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_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -8355,39 +8356,39 @@ struct t_hook *weechat_hook_print (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer, se NULL, verranno catturati i messaggi da qualsiasi +* _buffer_: puntatore al buffer, se NULL, verranno catturati i messaggi da qualsiasi buffer // TRANSLATION MISSING -* 'tags': catch only messages with these tags (optional): +* _tags_: catch only messages with these tags (optional): // TRANSLATION MISSING ** with WeeChat ≥ 0.4.3: comma-separated list of tags that must be in message (logical "or"); it is possible to combine many tags as a logical "and" with - separator "+"; wildcard "*" is allowed in tags + separator `+++`; wildcard `+*+` is allowed in tags // TRANSLATION MISSING ** with WeeChat ≤ 0.4.2: comma-separated list of tags that must all be in message (logical "and") -* 'message': verranno catturati solo i messaggi con questa stringa (opzionale, +* _message_: verranno catturati solo i messaggi con questa stringa (opzionale, non sensibile alle maiuscole) -* 'strip_colors': se 1, i colori verranno estratti dal messaggio visualizzato, prima +* _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 e +* _callback_: funzione chiamata quando viene stampato un messaggio, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_gui_buffer *buffer': puntatore al buffer -** 'time_t date': data -** 'int tags_count': numero di tag per riga -** 'const char **tags': array con tag per riga -** 'int displayed': 1 se la riga è visualizzata, 0 se filtrata (nascosta) -** 'int highlight': 1 se la riga viene evidenziata, altrimenti 0 -** 'const char *prefix': prefisso -** 'const char *message': messaggio +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_gui_buffer *buffer_: puntatore al buffer +** _time_t date_: data +** _int tags_count_: numero di tag per riga +** _const char **tags_: array con tag per riga +** _int displayed_: 1 se la riga è visualizzata, 0 se filtrata (nascosta) +** _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_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -8397,10 +8398,10 @@ Valore restituito: // TRANSLATION MISSING [IMPORTANT] -In scripts, with WeeChat ≥ 1.0, the callback arguments 'displayed' and -'highlight' are integers (with WeeChat ≤ 0.4.3, they were strings). + +In scripts, with WeeChat ≥ 1.0, the callback arguments _displayed_ and +_highlight_ are integers (with WeeChat ≤ 0.4.3, they were strings). + To be compatible with all versions, it is recommended to convert the argument -to integer before testing it, for example in Python: "`if int(highlight):`". +to integer before testing it, for example in Python: `if int(highlight):`. Esempio in C: @@ -8462,28 +8463,28 @@ struct t_hook *weechat_hook_signal (const char *signal, Argomenti: // TRANSLATION MISSING -* 'signal': segnale da catturare, wildcard "*" is allowed +* _signal_: segnale da catturare, wildcard `+*+` is allowed (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>), see table below -* 'callback': funzione chiamata a segnale ricevuto, argomenti e valore +* _callback_: funzione chiamata a segnale ricevuto, argomenti e valore restituito: -** 'const void *pointer': puntatore -** '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 +** _const void *pointer_: puntatore +** _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' +*** _WEECHAT_RC_OK_ // TRANSLATION MISSING -*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately) +*** _WEECHAT_RC_OK_EAT_ (stop sending the signal immediately) _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -8992,19 +8993,19 @@ List of signals sent by WeeChat and plugins: | weechat | key_combo_default + _(WeeChat ≥ 1.0)_ | String: key combo | - Key combo in 'default' context + Key combo in _default_ context // TRANSLATION MISSING | weechat | key_combo_search + _(WeeChat ≥ 1.0)_ | String: key combo | - Key combo in 'search' context + Key combo in _search_ context // TRANSLATION MISSING | weechat | key_combo_cursor + _(WeeChat ≥ 1.0)_ | String: key combo | - Key combo in 'cursor' context + Key combo in _cursor_ context // TRANSLATION MISSING | weechat | mouse_enabled + @@ -9204,7 +9205,7 @@ List of signals sent by WeeChat and plugins: |=== [NOTE] -^(1)^ 'xxx' è il nome del server IRC, 'yyy' è il nome del comando IRC. +^(1)^ _xxx_ è il nome del server IRC, _yyy_ è il nome del comando IRC. Esempio in C: @@ -9256,20 +9257,20 @@ int weechat_hook_signal_send (const char *signal, const char *type_data, Argomenti: -* 'signal': segnale da inviare -* 'type_data': tipo di dati inviati con il segnale (consultare +* _signal_: segnale da inviare +* _type_data_: tipo di dati inviati con il segnale (consultare <<_hook_signal,weechat_hook_signal>>) -* 'signal_data': dati inviati con il segnale +* _signal_data_: dati inviati con il segnale // TRANSLATION MISSING Return value _(WeeChat ≥ 1.0)_: // TRANSLATION MISSING -* return code of last callback executed ('WEECHAT_RC_OK' if no callback was +* return code of last callback executed (_WEECHAT_RC_OK_ if no callback was executed): -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ Esempio in C: @@ -9318,24 +9319,24 @@ weechat.hook_signal_send("logger_backlog", weechat.WEECHAT_HOOK_SIGNAL_POINTER, Cinque segnali che possono essere inviati per installare uno script, a seconda del linguaggio: -* 'perl_script_install' -* 'python_script_install' -* 'ruby_script_install' -* 'lua_script_install' -* 'tcl_script_install' -* 'guile_script_install' -* 'javascript_script_install' +* _perl_script_install_ +* _python_script_install_ +* _ruby_script_install_ +* _lua_script_install_ +* _tcl_script_install_ +* _guile_script_install_ +* _javascript_script_install_ La callback compirà le seguenti azioni alla ricezione del segnale: . scarica e rimuove lo script installato -. sposta il nuovo script nella cartella '~/.weechat/xxx/' (dove 'xxx' è il +. sposta il nuovo script nella cartella _~/.weechat/xxx/_ (dove _xxx_ è il linguaggio) -. crea un link al nuovo script nella cartella '~/.weechat/xxx/autoload/' +. crea un link al nuovo script nella cartella _~/.weechat/xxx/autoload/_ . carica il nuovo script // TRANSLATION MISSING -These signals are used by 'script' plugin to install scripts. +These signals are used by _script_ plugin to install scripts. L'argomento è una stringa con il percorso dello script da installare. @@ -9361,21 +9362,21 @@ weechat.hook_signal_send("python_script_install", WEECHAT_HOOK_SIGNAL_STRING, Cinque segnali che possono essere inviati per rimuovere un elenco di script, a seconda del linguaggio: -* 'perl_script_remove' -* 'python_script_remove' -* 'ruby_script_remove' -* 'lua_script_remove' -* 'tcl_script_remove' -* 'guile_script_remove' -* 'javascript_script_remove' +* _perl_script_remove_ +* _python_script_remove_ +* _ruby_script_remove_ +* _lua_script_remove_ +* _tcl_script_remove_ +* _guile_script_remove_ +* _javascript_script_remove_ Per ogni script nella lista, la callback scaricherà e rimuoverà lo script. // TRANSLATION MISSING -These signals are used by 'script' plugin to remove scripts. +These signals are used by _script_ plugin to remove scripts. L'argomento è una stringa con una lista separata da virgole di script da -rimuovere (script è il nome senza percorso, ad esempio 'script.py'). +rimuovere (script è il nome senza percorso, ad esempio _script.py_). Esempio in C: @@ -9412,11 +9413,11 @@ L'argomento è una stringa con il seguente formato: * punto e virgola // TRANSLATION MISSING * comma-separated list of options (optional): -** 'priority_high': queue with high priority (like user messages); this is the +** _priority_high_: queue with high priority (like user messages); this is the default priority -** 'priority_low': queue with low priority (like messages automatically sent by +** _priority_low_: queue with low priority (like messages automatically sent by WeeChat) -** 'user_message': force user message (don't execute a command) +** _user_message_: force user message (don't execute a command) * punto e virgola * elenco separato da virgole di tag usate per l'invio di un messaggio (opzionale) @@ -9471,24 +9472,24 @@ struct t_hook *weechat_hook_hsignal (const char *signal, Argomenti: // TRANSLATION MISSING -* 'signal': segnale da catturare, wildcard "*" is allowed +* _signal_: segnale da catturare, wildcard `+*+` is allowed (priorità consentita, consultare la nota a proposito di <<hook_priority,priority>>), see table below -* 'callback': funzione chiamata a segnale ricevuto, argomenti e valore +* _callback_: funzione chiamata a segnale ricevuto, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *signal': segnale ricevuto -** 'struct t_hashtable *hashtable': tabella hash +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _const char *signal_: segnale ricevuto +** _struct t_hashtable *hashtable_: tabella hash ** valore restituito: -*** 'WEECHAT_RC_OK' +*** _WEECHAT_RC_OK_ // TRANSLATION MISSING -*** 'WEECHAT_RC_OK_EAT' (stop sending the signal immediately) +*** _WEECHAT_RC_OK_EAT_ (stop sending the signal immediately) _(WeeChat ≥ 0.4.0)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9511,54 +9512,54 @@ List of hsignals sent by WeeChat and plugins: // TRANSLATION MISSING | weechat | nicklist_group_added + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'group' ('struct t_gui_nick_group *'): group | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _group_ (_struct t_gui_nick_group *_): group | Group added in nicklist // TRANSLATION MISSING | weechat | nicklist_nick_added + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'nick' ('struct t_gui_nick *'): nick | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _nick_ (_struct t_gui_nick *_): nick | Nick added in nicklist // TRANSLATION MISSING | weechat | nicklist_group_removing + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'group' ('struct t_gui_nick_group *'): group | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _group_ (_struct t_gui_nick_group *_): group | Removing group from nicklist // TRANSLATION MISSING | weechat | nicklist_nick_removing + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'nick' ('struct t_gui_nick *'): nick | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _nick_ (_struct t_gui_nick *_): nick | Removing nick from nicklist // TRANSLATION MISSING | weechat | nicklist_group_changed + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'group' ('struct t_gui_nick_group *'): group | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _group_ (_struct t_gui_nick_group *_): group | Group changed in nicklist // TRANSLATION MISSING | weechat | nicklist_nick_changed + _(WeeChat ≥ 0.4.1)_ | - 'buffer' ('struct t_gui_buffer *'): buffer + - 'parent_group' ('struct t_gui_nick_group *'): parent group + - 'nick' ('struct t_gui_nick *'): nick | + _buffer_ (_struct t_gui_buffer *_): buffer + + _parent_group_ (_struct t_gui_nick_group *_): parent group + + _nick_ (_struct t_gui_nick *_): nick | Nick changed in nicklist |=== [NOTE] -^(1)^ 'xxx' è l'argomento del segnale usato nella redirezione, 'yyy' è lo schema +^(1)^ _xxx_ è l'argomento del segnale usato nella redirezione, _yyy_ è lo schema di redirezione. Esempio in C: @@ -9608,18 +9609,18 @@ int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable Argomenti: -* 'signal': segnale da inviare -* 'hashtable': tabella hash +* _signal_: segnale da inviare +* _hashtable_: tabella hash // TRANSLATION MISSING Return value _(WeeChat ≥ 1.0)_: // TRANSLATION MISSING -* return code of last callback executed ('WEECHAT_RC_OK' if no callback was +* return code of last callback executed (_WEECHAT_RC_OK_ if no callback was executed): -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ Esempio in C: @@ -9661,52 +9662,52 @@ di un comando irc ad una callback. L'argomento è una tabella hash con le seguenti componenti (chiavi e valori sono stringhe): -* 'server': nome interno del server (richiesto) -* 'pattern': schema di redirezione da usare (richiesto), sia uno di default +* _server_: nome interno del server (richiesto) +* _pattern_: schema di redirezione da usare (richiesto), sia uno di default (definito dal plugin irc), oppure definito dall'utente (consultare <<hsignal_irc_redirect_pattern>>), gli schemi predefiniti sono: -** 'ison' -** 'list' -** 'mode_channel' -** 'mode_channel_ban' ("mode #channel b") -** 'mode_channel_ban_exception' ("mode #channel e") -** 'mode_channel_invite' ("mode #channel I") -** 'mode_user' -** 'monitor' -** 'names' -** 'ping' -** 'time' -** 'topic' -** 'userhost' -** 'who' -** 'whois' -** 'whowas' -* 'signal': nome segnale (richiesto) -* 'count': numero di volte in cui verrà utilizzata la redirezione (opzionale, predefinito è 1) -* 'string': stringa che deve essere presente nei messaggi irc ricevuti (opzionale, ma +** _ison_ +** _list_ +** _mode_channel_ +** _mode_channel_ban_ ("mode #channel b") +** _mode_channel_ban_exception_ ("mode #channel e") +** _mode_channel_invite_ ("mode #channel I") +** _mode_user_ +** _monitor_ +** _names_ +** _ping_ +** _time_ +** _topic_ +** _userhost_ +** _who_ +** _whois_ +** _whowas_ +* _signal_: nome segnale (richiesto) +* _count_: numero di volte in cui verrà utilizzata la redirezione (opzionale, predefinito è 1) +* _string_: stringa che deve essere presente nei messaggi irc ricevuti (opzionale, ma raccomandata, se una stringa può essere usata per identificare i messaggi) -* 'timeout': timeout per la redirezione, in secondi (opzionale, predefiniti sono) -* 'cmd_filter': elenco separato da virgole di comandi irc da filtrare (solo questi +* _timeout_: timeout per la redirezione, in secondi (opzionale, predefiniti sono) +* _cmd_filter_: elenco separato da virgole di comandi irc da filtrare (solo questi comandi verranno inviati alle callback, altri ignorati) (opzionale) Subito dopo aver inviato questo hsignal, è necessario inviare il comando al server irc, e la redirezione verrà usata per questo comando. Quando è stata ricevuta la risposta completa dal proprio comando, verrà -inviato un hsignal. Questo hsignal ha il nome 'irc_redirection_xxx_yyy' dove -'xxx' è il segnale e 'yyy' lo 'schema' usato. +inviato un hsignal. Questo hsignal ha il nome _irc_redirection_xxx_yyy_ dove +_xxx_ è il segnale e _yyy_ lo _schema_ usato. La tabella hash inviata in hsignal ha il seguente contenuto (chiavi e valori sono stringhe): -* 'output': output del comando (i messaggi vengono separati da "\n") -* 'output_size': numero di byte in 'output' (come stringa) -* 'error': stringa di errore (in caso di errore): -** 'timeout': redirezione fermata dopo il timeout -* 'server': nome interno del server -* 'pattern': schema di redirezione -* 'signal': nome del segnale -* 'command': comando rediretto +* _output_: output del comando (i messaggi vengono separati da "\n") +* _output_size_: numero di byte in _output_ (come stringa) +* _error_: stringa di errore (in caso di errore): +** _timeout_: redirezione fermata dopo il timeout +* _server_: nome interno del server +* _pattern_: schema di redirezione +* _signal_: nome del segnale +* _command_: comando rediretto Esempio in C: @@ -9767,14 +9768,14 @@ per la redirezione irc (consultare <<hsignal_irc_redirect_command>>). L'argomento è una tabella hash con le seguenti voci (chiavi e valori sono stringa): -* 'pattern': nome dello schema (richiesto) -* 'timeout': timeout predefinito per lo schema, in secondi (opzionale, predefinito è 60) -* 'cmd_start': elenco separato da virgole di comandi che avviano la redirezione (opzionale) -* 'cmd_stop': elenco separato da virgole di comandi che fermano la redirezione (richiesto) -* 'cmd_extra': elenco separato da virgole di comandi che possono essere ricevuti dopo aver +* _pattern_: nome dello schema (richiesto) +* _timeout_: timeout predefinito per lo schema, in secondi (opzionale, predefinito è 60) +* _cmd_start_: elenco separato da virgole di comandi che avviano la redirezione (opzionale) +* _cmd_stop_: elenco separato da virgole di comandi che fermano la redirezione (richiesto) +* _cmd_extra_: elenco separato da virgole di comandi che possono essere ricevuti dopo aver fermato i comandi (opzionale) -Per ogni comando in 'cmd_start', 'cmd_stop' e 'cmd_extra', è possibile fornire +Per ogni comando in _cmd_start_, _cmd_stop_ e _cmd_extra_, è possibile fornire un intero con la posizione di "string" che va trovato nel messaggio ricevuto, ad esempio: @@ -9853,22 +9854,22 @@ struct t_hook *weechat_hook_config (const char *option, Argomenti: // TRANSLATION MISSING -* 'option': opzione, il formato è il nome completo, come usato con il comando - `/set` (ad esempio: `weechat.look.item_time_format`), wildcard "*" is allowed +* _option_: opzione, il formato è il nome completo, come usato con il comando + `/set` (ad esempio: `weechat.look.item_time_format`), wildcard `+*+` is allowed (priorità consentita, consultare la note riguardo la <<hook_priority,priority>>) -* 'callback': funzione chiamata quando l'opzione di configurazione è cambiata, +* _callback_: funzione chiamata quando l'opzione di configurazione è cambiata, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *option': nome dell'opzione -** 'const char *value': nuovo valore per l'opzione +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9933,26 +9934,26 @@ struct t_hook *weechat_hook_completion (const char *completion_item, Argomenti: -* 'completion_item': nome dell'elemento del completamento, è possibile usare - in seguito '%(name)' in un comando con un hook (argomento 'completion') +* _completion_item_: nome dell'elemento del completamento, è possibile usare + in seguito _%(name)_ in un comando con un hook (argomento _completion_) (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* 'callback': funzione chiamata quando viene usato l'elemento completamento +* _callback_: funzione chiamata quando viene usato l'elemento completamento (l'utente sta completando qualcosa usando questo elemento), argomenti e valore restituito: -** 'const void *pointer': puntatore -** '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 +** _const void *pointer_: puntatore +** _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 <<_hook_completion_list_add,weechat_hook_completion_list_add>>) ** valore restituito: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -9968,7 +9969,7 @@ The callback must only call function and must *NOT* update the command line. + To update the command line when key[Tab] is pressed, you can use the function <<_hook_command_run,weechat_hook_command_run>> with command: -"/input complete_next" (and you must return 'WEECHAT_RC_OK_EAT' if your callback +"/input complete_next" (and you must return _WEECHAT_RC_OK_EAT_ if your callback has updated the command line, so that WeeChat will not perform the completion). Valore restituito: @@ -10029,11 +10030,11 @@ const char *weechat_hook_completion_get_string (struct t_gui_completion *complet Argomenti: -* 'completion': puntatore al completamento -* 'property': nome della proprietà: -** 'base_command': comando usato per il completamento -** 'base_word': parola che viene completata -** 'args': argomenti del comando (inclusa la parola base) +* _completion_: puntatore al completamento +* _property_: nome della proprietà: +** _base_command_: comando usato per il completamento +** _base_word_: parola che viene completata +** _args_: argomenti del comando (inclusa la parola base) Esempio in C: @@ -10086,14 +10087,14 @@ void weechat_hook_completion_list_add (struct t_gui_completion *completion, Argomenti: -* 'completion': puntatore al completamento -* 'word': parola da aggiungere -* 'nick_completion': 1 se la parola è un nick, altrimenti 0 -* 'where': posizione in cui la parola sarà inserita nella lista: -** 'WEECHAT_LIST_POS_SORT': qualunque posizione, per mantenere +* _completion_: puntatore al completamento +* _word_: parola da aggiungere +* _nick_completion_: 1 se la parola è un nick, altrimenti 0 +* _where_: posizione in cui la parola sarà inserita nella lista: +** _WEECHAT_LIST_POS_SORT_: qualunque posizione, per mantenere la lista ordinata -** 'WEECHAT_LIST_POS_BEGINNING': inizio della lista -** 'WEECHAT_LIST_POS_END': fine della lista +** _WEECHAT_LIST_POS_BEGINNING_: inizio della lista +** _WEECHAT_LIST_POS_END_: fine della lista Esempio in C: consultare <<_hook_completion,weechat_hook_completion>>. @@ -10131,21 +10132,21 @@ struct t_hook *weechat_hook_modifier (const char *modifier, Argomenti: // TRANSLATION MISSING -* 'modifier': nome modificatore, lista di modificatori utilizzati da +* _modifier_: nome modificatore, lista di modificatori utilizzati da Weechat o dai plugin (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>), see table below -* 'callback': funzione chiamata quando viene usato il modificatore, +* _callback_: funzione chiamata quando viene usato il modificatore, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *modifier': nome del modificatore -** 'const char *modifier_data': dati per il modificatore -** 'const char *string': stringa da modificare +** _const void *pointer_: puntatore +** _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_pointer': puntatore fornito alla callback quando chiamata da WeeChat +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10270,8 +10271,8 @@ List of modifiers used by WeeChat and plugins: |=== [NOTE] -^(1)^ 'xxx' è il nome del comando IRC. + -^(2)^ 'yyy' è il nome della barra. +^(1)^ _xxx_ è il nome del comando IRC. + +^(2)^ _yyy_ è il nome della barra. Esempio in C: @@ -10332,9 +10333,9 @@ char *weechat_hook_modifier_exec (const char *modifier, Argomenti: -* 'modifier': nome modificatore -* 'modifier_data': dati modificatore -* 'string': stringa da modificare +* _modifier_: nome modificatore +* _modifier_data_: dati modificatore +* _string_: stringa da modificare Valore restituito: @@ -10383,21 +10384,21 @@ struct t_hook *weechat_hook_info (const char *info_name, Argomenti: -* 'info_name': nome della info +* _info_name_: nome della info (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* 'description': descrizione -* 'args_description': descrizione degli argomenti -* 'callback': funzione chiamata alla richiesta di una info, argomenti e valore +* _description_: descrizione +* _args_description_: descrizione degli argomenti +* _callback_: funzione chiamata alla richiesta di una info, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *info_name': nome della info -** 'const char *arguments': argomenti addizionali, dipendono dalle info +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _const char *info_name_: nome della info +** _const char *arguments_: argomenti addizionali, dipendono dalle info ** valore restituito: valore dell'info richiesta -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10464,24 +10465,24 @@ struct t_hook *weechat_hook_info_hashtable (const char *info_name, Argomenti: -* 'info_name': nome della info +* _info_name_: nome della info (priorità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* 'description': descrizione -* 'args_description': descrizione della tabella hash attesa (opzionale, può +* _description_: descrizione +* _args_description_: descrizione della tabella hash attesa (opzionale, può essere NULL) -* 'output_description': descrizione della tabella hash restituita dalla +* _output_description_: descrizione della tabella hash restituita dalla callback (opzionale, può essere NULL) -* 'callback': funzione chiamata alla richiesta della info, argomenti e valore +* _callback_: funzione chiamata alla richiesta della info, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *info_name': nome della info -** 'struct t_hashtable *hashtable': tabella hash, in base alla info +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _const char *info_name_: nome della info +** _struct t_hashtable *hashtable_: tabella hash, in base alla info ** valore restituito: tabella hash richiesta -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10554,24 +10555,24 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, Argomenti: -* 'infolist_name': nome della lista info +* _infolist_name_: nome della lista info (priotità consentita, consultare la nota riguardo la <<hook_priority,priority>>) -* '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 e +* _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 e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *infolist_name': nome della lista info -** 'void *pointer': puntatore ad un oggetto che la lista info deve restituire +** _const void *pointer_: puntatore +** _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 +** _const char *arguments_: argomento aggiuntivo, dipende dalla lista info ** valore restituito: lista info richiesta -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10644,17 +10645,17 @@ struct t_hook *weechat_hook_hdata (const char *hdata_name, Argomenti: -* 'hdata_name': nome dell'hdata +* _hdata_name_: nome dell'hdata (priorità consentita, consultare la nota a proposito di <<hook_priority,priority>>) -* 'description': descrizione -* 'callback': funzione chiamata alla richiesta di hdata, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'const char *hdata_name': nome dell'hdata +* _description_: descrizione +* _callback_: funzione chiamata alla richiesta di hdata, argomenti e valore restituito: +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _const char *hdata_name_: nome dell'hdata ** return value: hdata richiesto -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10708,21 +10709,21 @@ struct t_hook *weechat_hook_focus (const char *area, Argomenti: -* 'area': "chat" per la zona di chat, o il nome di un elemento barra +* _area_: "chat" per la zona di chat, o il nome di un elemento barra (priorità consentita, consultare la nota a riguardo di <<hook_priority,priority>>) -* 'callback': funzione chiamata al momento del focus, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_hashtable *info': tabella hash con informazioni sul focus e +* _callback_: funzione chiamata al momento del focus, argomenti e valore restituito: +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_hashtable *info_: tabella hash con informazioni sul focus e stringhe restituite da altre chiamate alle callback sul focus (con la priorità più alta) (consultare la tabella in basso) ** valore restituito: sia il puntatore "info" tabella hash completa), o il puntatore ad una nuova tabella hash (creata dalla callback, con chiavi e valori di tipo "string), questa nuovo contenuto della tabella hash verrà - aggiunto ad 'info' per le altre chiamate alle callback del focus -* 'callback_pointer': puntatore fornito alla callback quando chiamata da WeeChat + aggiunto ad _info_ per le altre chiamate alle callback del focus +* _callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_data': puntatore fornito alla callback quando chiamata da WeeChat; +* _callback_data_: puntatore fornito alla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the hook is deleted @@ -10913,11 +10914,11 @@ void weechat_hook_set (struct t_hook *hook, const char *property, Argomenti: -* 'hook': qualcosa su cui è presente un hook con "weechat_hook_xxx()" +* _hook_: qualcosa su cui è presente un hook con "weechat_hook_xxx()" // TRANSLATION MISSING -* 'property': nome della proprietà (see table below) +* _property_: nome della proprietà (see table below) // TRANSLATION MISSING -* 'value': new value for property +* _value_: new value for property // TRANSLATION MISSING Properties: @@ -10931,24 +10932,24 @@ Properties: | subplugin | any type | qualsiasi stringa | // TRANSLATION MISSING Name of sub plugin (commonly script name, which is displayed in - `/help command` for a hook of type 'command') + `/help command` for a hook of type _command_) | stdin + _(WeeChat ≥ 0.4.3)_ | - 'process', 'process_hashtable' | qualsiasi stringa | + _process_, _process_hashtable_ | qualsiasi stringa | // TRANSLATION MISSING - Send data on standard input ('stdin') of child process + Send data on standard input (_stdin_) of child process | stdin_close + _(WeeChat ≥ 0.4.3)_ | // TRANSLATION MISSING - 'process', 'process_hashtable' | (not used) | + _process_, _process_hashtable_ | (not used) | // TRANSLATION MISSING - Close pipe used to send data on standard input ('stdin') of child process + Close pipe used to send data on standard input (_stdin_) of child process | signal + _(WeeChat ≥ 1.0)_ | - 'process', 'process_hashtable' | + _process_, _process_hashtable_ | // TRANSLATION MISSING signal number or one of these names: `hup`, `int`, `quit`, `kill`, `term`, `usr1`, `usr2` | @@ -10998,7 +10999,7 @@ void weechat_unhook (struct t_hook *hook); Argomenti: -* 'hook': qualcosa su cui è presente un hook con "weechat_hook_xxx()" +* _hook_: qualcosa su cui è presente un hook con "weechat_hook_xxx()" Esempio in C: @@ -11038,7 +11039,7 @@ void weechat_unhook_all (const char *subplugin); Argomenti: // TRANSLATION MISSING -* 'subplugin': if not NULL, unhook only hooks with this "subplugin" set +* _subplugin_: if not NULL, unhook only hooks with this "subplugin" set (this argument is not available in scripting API) Esempio in C: @@ -11091,34 +11092,34 @@ struct t_gui_buffer *weechat_buffer_new (const char *name, Argomenti: -* 'name': nome del buffer (deve essere unico per il plugin) -* 'input_callback': funzione chiamata quando il testo in input è stato +* _name_: nome del buffer (deve essere unico per il plugin) +* _input_callback_: funzione chiamata quando il testo in input è stato inserito nel buffer, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_gui_buffer *buffer': puntatore al buffer -** 'const char *input_data': dati in input +** _const void *pointer_: puntatore +** _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' -* 'input_callback_pointer': puntatore fornito alla callback quando chiamata da +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _input_callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'input_callback_data': puntatore fornito dalla callback quando chiamata da +* _input_callback_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the buffer is closed -* 'close_callback': funzione chiamata alla chiusura del buffer, argomenti e +* _close_callback_: funzione chiamata alla chiusura del buffer, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_gui_buffer *buffer': puntatore al buffer +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_gui_buffer *buffer_: puntatore al buffer ** valore restituito: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'close_callback_pointer': puntatore fornito alla callback quando chiamata da +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _close_callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'close_callback_data': puntatore fornito dalla callback quando chiamata da +* _close_callback_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the buffer is closed @@ -11223,12 +11224,12 @@ struct t_gui_buffer *weechat_buffer_search (const char *plugin, Argomenti: // TRANSLATION MISSING -* 'plugin': name of plugin, following special value is allowed: -** `==`: the name used is the buffer full name (for example: +* _plugin_: name of plugin, following special value is allowed: +** `+==+`: the name used is the buffer full name (for example: `irc.freenode.#weechat` instead of `freenode.#weechat`) _(WeeChat ≥ 1.0)_ // TRANSLATION MISSING -* 'name': name of buffer, if it is NULL or empty string, the current buffer is +* _name_: name of buffer, if it is NULL or empty string, the current buffer is returned (buffer displayed by current window); if the name starts with `(?i)`, the search is case insensitive _(WeeChat ≥ 1.0)_ @@ -11257,7 +11258,7 @@ buffer = weechat.buffer_search("my_plugin", "my_buffer") ==== buffer_search_main -Cerca nel buffer principale di WeeChat (per primo nel buffer 'core', il primo +Cerca nel buffer principale di WeeChat (per primo nel buffer _core_, il primo visualizzato all'avvio di WeeChat). Prototipo: @@ -11269,7 +11270,7 @@ struct t_gui_buffer *weechat_buffer_search_main (); Valore restituito: -* puntatore al buffer principale di WeeChat (buffer 'core') +* puntatore al buffer principale di WeeChat (buffer _core_) Esempio in C: @@ -11302,7 +11303,7 @@ void weechat_buffer_clear (struct t_gui_buffer *buffer); Argomenti: -* 'buffer': puntatore al buffer +* _buffer_: puntatore al buffer Esempio in C: @@ -11342,7 +11343,7 @@ void weechat_buffer_close (struct t_gui_buffer *buffer); Argomenti: -* 'buffer': puntatore al buffer +* _buffer_: puntatore al buffer Esempio in C: @@ -11384,8 +11385,8 @@ void weechat_buffer_merge (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'target_buffer': buffer di destinazione, dove il buffer verrà unito +* _buffer_: puntatore al buffer +* _target_buffer_: buffer di destinazione, dove il buffer verrà unito Esempio in C: @@ -11422,10 +11423,10 @@ void weechat_buffer_unmerge (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'number': numero di destinazione per il buffer staccato, +* _buffer_: puntatore al buffer +* _number_: numero di destinazione per il buffer staccato, se è < 1, allora il buffer verrà spostato al numero di - 'buffer' +1 + _buffer_ +1 Esempio in C: @@ -11460,66 +11461,66 @@ int weechat_buffer_get_integer (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'property': nome della proprietà: -** 'number': numero del buffer (inizia da 1) -** 'layout_number': numero del buffer salvato nel layout -** 'layout_number_merge_order': ordine di unione per i layout -** 'short_name_is_set': 1 se il nome breve è impostato, 0 in caso contrario -** 'type': tipo dibuffer (0: formattato, 1: contenuto libero) -** 'notify': livello di notifica per il buffer -** 'num_displayed': numero delle finestre che visualizzano il buffer +* _buffer_: puntatore al buffer +* _property_: nome della proprietà: +** _number_: numero del buffer (inizia da 1) +** _layout_number_: numero del buffer salvato nel layout +** _layout_number_merge_order_: ordine di unione per i layout +** _short_name_is_set_: 1 se il nome breve è impostato, 0 in caso contrario +** _type_: tipo dibuffer (0: formattato, 1: contenuto libero) +** _notify_: livello di notifica per il buffer +** _num_displayed_: numero delle finestre che visualizzano il buffer // TRANSLATION MISSING -** 'active': 2 if buffer is the only active (merged), 1 se il buffer è attivo, +** _active_: 2 if buffer is the only active (merged), 1 se il buffer è attivo, 0 se il buffer è unito e non selezionato // TRANSLATION MISSING -** 'hidden': 1 if buffer is hidden, otherwise 0 +** _hidden_: 1 if buffer is hidden, otherwise 0 _(WeeChat ≥ 1.0)_ // TRANSLATION MISSING -** 'zoomed': 1 if buffer is merged and zoomed, otherwise 0 +** _zoomed_: 1 if buffer is merged and zoomed, otherwise 0 _(WeeChat ≥ 1.0)_ -** 'print_hooks_enabled': 1 se gli hook sulla stampa sono abilitati, +** _print_hooks_enabled_: 1 se gli hook sulla stampa sono abilitati, altrimenti 0 // TRANSLATION MISSING -** 'day_change': 1 if messages for the day change are displayed, otherwise 0 +** _day_change_: 1 if messages for the day change are displayed, otherwise 0 _(WeeChat ≥ 0.4.3)_ // TRANSLATION MISSING -** 'clear': 1 if buffer can be cleared with command `/buffer clear`, otherwise 0 +** _clear_: 1 if buffer can be cleared with command `/buffer clear`, otherwise 0 _(WeeChat ≥ 1.0)_ // TRANSLATION MISSING -** 'filter': 1 if filters are enabled on buffer, otherwise 0 +** _filter_: 1 if filters are enabled on buffer, otherwise 0 _(WeeChat ≥ 1.0)_ -** 'lines_hidden': 1 se almeno una riga è nascosta sul buffer (filtrata), +** _lines_hidden_: 1 se almeno una riga è nascosta sul buffer (filtrata), oppure 0 se vengono visualizzate tutte le righe -** 'prefix_max_length': lunghezza massima del prefisso in questo buffer -** 'time_for_each_line': 1 se l'ora è visualizzata per ogni riga nel buffer +** _prefix_max_length_: lunghezza massima del prefisso in questo buffer +** _time_for_each_line_: 1 se l'ora è visualizzata per ogni riga nel buffer (predefinito), altrimenti 0 -** 'nicklist': 1 se la lista nick è abilitata, altrimenti 0 -** 'nicklist_case_sensitive': 1 se i nick sono sensibili alle maiuscole, +** _nicklist_: 1 se la lista nick è abilitata, altrimenti 0 +** _nicklist_case_sensitive_: 1 se i nick sono sensibili alle maiuscole, altrimenti 0 -** 'nicklist_max_length': lunghezza massima per un nick -** 'nicklist_display_groups': 1 se i gruppi vengono visualizzati, altrimenti 0 +** _nicklist_max_length_: lunghezza massima per un nick +** _nicklist_display_groups_: 1 se i gruppi vengono visualizzati, altrimenti 0 // TRANSLATION MISSING -** 'nicklist_count': number of nicks and groups in nicklist +** _nicklist_count_: number of nicks and groups in nicklist // TRANSLATION MISSING -** 'nicklist_groups_count': number of groups in nicklist +** _nicklist_groups_count_: number of groups in nicklist // TRANSLATION MISSING -** 'nicklist_nicks_count': number of nicks in nicklist -** 'nicklist_visible_count': numero di nick/gruppi visualizzati -** 'input': 1 se l'input è abilitato, altrimenti 0 -** 'input_get_unknown_commands': 1 se i comandi sconosciuti vengono inviati +** _nicklist_nicks_count_: number of nicks in nicklist +** _nicklist_visible_count_: numero di nick/gruppi visualizzati +** _input_: 1 se l'input è abilitato, altrimenti 0 +** _input_get_unknown_commands_: 1 se i comandi sconosciuti vengono inviati alla callback di input, altrimenti 0 -** 'input_size': dimensione per l'input (in byte) -** 'input_length': lunghezza dell'input (numero di caratteri) -** 'input_pos': posizione del cursore nell'input del buffer -** 'input_1st_display': primo carattere visualizzato su schermo -** 'num_history': numero di comandi nella cronologia -** 'text_search': tipo di ricerca nel testo: +** _input_size_: dimensione per l'input (in byte) +** _input_length_: lunghezza dell'input (numero di caratteri) +** _input_pos_: posizione del cursore nell'input del buffer +** _input_1st_display_: primo carattere visualizzato su schermo +** _num_history_: numero di comandi nella cronologia +** _text_search_: tipo di ricerca nel testo: *** 0: nessuna ricerca in questo momento *** 1: ricerca all'indietro (direzione: messaggi più vecchi) *** 2: ricerca in avanti (direzione: messaggi più nuovi) -** 'text_search_exact': 1 se la ricerca testo è esatta -** 'text_search_found': 1 se il testo viene trovato, altrimenti 0 +** _text_search_exact_: 1 se la ricerca testo è esatta +** _text_search_found_: 1 se il testo viene trovato, altrimenti 0 Valore restituito: @@ -11558,27 +11559,27 @@ const char *weechat_buffer_get_string (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'property': nome proprietà: -** 'plugin': nome del plugin che ha creato questo buffer ("core" +* _buffer_: puntatore al buffer +* _property_: nome proprietà: +** _plugin_: nome del plugin che ha creato questo buffer ("core" per il buffer principale di WeeChat) -** 'name': nome del buffer -** 'full_name': nome completo del buffer ("plugin.nome") _(WeeChat ≥ 0.3.7)_ -** 'short_name': nome breve del buffer (nota: usato solo per il display e può +** _name_: nome del buffer +** _full_name_: nome completo del buffer ("plugin.nome") _(WeeChat ≥ 0.3.7)_ +** _short_name_: nome breve del buffer (nota: usato solo per il display e può essere cambiato dall'utente, questo nome non va usato per trovare il nome del - buffer, utilizzare invece 'name', 'fullname' o la variabile locale 'channel') -** 'title': titolo del buffer -** 'input': testo in ingresso -** 'text_search_input': input salvato prima della ricerca nel testo -** 'highlight_words': elenco di parole da evidenziare + buffer, utilizzare invece _name_, _fullname_ o la variabile locale _channel_) +** _title_: titolo del buffer +** _input_: testo in ingresso +** _text_search_input_: input salvato prima della ricerca nel testo +** _highlight_words_: elenco di parole da evidenziare // TRANSLATION MISSING -** 'highlight_regex': POSIX extended regular expression for highlight +** _highlight_regex_: POSIX extended regular expression for highlight // TRANSLATION MISSING -** 'highlight_tags_restrict': restrict highlights to messages with these tags +** _highlight_tags_restrict_: restrict highlights to messages with these tags // TRANSLATION MISSING -** 'highlight_tags': force highlight on messages with these tags -** 'hotlist_max_level_nicks': livello massimo della hotlist per alcuni nick -** 'localvar_xxx': ottiene il contenuto della variabile locale "xxx" +** _highlight_tags_: force highlight on messages with these tags +** _hotlist_max_level_nicks_: livello massimo della hotlist per alcuni nick +** _localvar_xxx_: ottiene il contenuto della variabile locale "xxx" (sostituire "xxx" con il nome della variabile da leggere) Valore restituito: @@ -11621,11 +11622,11 @@ void *weechat_buffer_pointer (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'property': nome proprietà: -** 'plugin': puntatore al plugin che ha creato questo buffer (NULL +* _buffer_: puntatore al buffer +* _property_: nome proprietà: +** _plugin_: puntatore al plugin che ha creato questo buffer (NULL per il buffer principale di WeeChat) -** 'highlight_regex_compiled': espressione regolare 'highlight_regex' compilata +** _highlight_regex_compiled_: espressione regolare _highlight_regex_ compilata Valore restituito: @@ -11664,11 +11665,11 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, Argomenti: -* 'buffer': puntatore al buffer +* _buffer_: puntatore al buffer // TRANSLATION MISSING -* 'property': nome della proprietà (see table below) +* _property_: nome della proprietà (see table below) // TRANSLATION MISSING -* 'value': new value for property +* _value_: new value for property // TRANSLATION MISSING Properties: @@ -11721,7 +11722,7 @@ Properties: | type | "formatted" oppure "free" | Imposta tipo per il: "formatted" (per stampare i messaggi di chat), oppure "free" (per contenuto libero); when the value is "free", the property - 'clear' is forced to "0" _(WeeChat ≥ 1.0)_ + _clear_ is forced to "0" _(WeeChat ≥ 1.0)_ | notify | "0", "1", "2", "3" | Imposta il livello di notifica per il buffer: "0" = non aggiungere alla hotlist, @@ -11816,11 +11817,11 @@ Properties: hotlist | key_bind_xxx | qualsiasi stringa | - Assegna un nuovo tasto 'xxx', specifico per questo buffer, il valore è il + Assegna un nuovo tasto _xxx_, specifico per questo buffer, il valore è il comando da eseguire per questo tasto | key_unbind_xxx | - | - Rimuove l'assegnazione del tasto 'xxx' per questo buffer + Rimuove l'assegnazione del tasto _xxx_ per questo buffer | input | qualsiasi stringa | Imposta un nuovo valore per l'input del buffer @@ -11835,11 +11836,11 @@ Properties: comando sconosciuto) | localvar_set_xxx | qualsiasi stringa | - Imposta il nuovo valore per la variabile locale 'xxx' (la variabile verrà + Imposta il nuovo valore per la variabile locale _xxx_ (la variabile verrà creata se non esiste) | localvar_del_xxx | - | - Rimuove la variabile locale 'xxx' + Rimuove la variabile locale _xxx_ |=== Esempio in C: @@ -11901,20 +11902,20 @@ void weechat_buffer_set_pointer (struct t_gui_buffer *buffer, const char *proper Argomenti: -* 'buffer': puntatore al buffer -* 'property': nome della proprietà: -** 'close_callback': set close callback function -** 'close_callback_data': set close callback data -** 'input_callback': set input callback function -** 'input_callback_data': set input callback data +* _buffer_: puntatore al buffer +* _property_: nome della proprietà: +** _close_callback_: set close callback function +** _close_callback_data_: set close callback data +** _input_callback_: set input callback function +** _input_callback_data_: set input callback data // TRANSLATION MISSING -** 'nickcmp_callback': set nick comparison callback function (this callback is +** _nickcmp_callback_: set nick comparison callback function (this callback is called when searching nick in nicklist) _(WeeChat ≥ 0.3.9)_ // TRANSLATION MISSING -** 'nickcmp_callback_data': set nick comparison callback data +** _nickcmp_callback_data_: set nick comparison callback data _(WeeChat ≥ 0.3.9)_ // TRANSLATION MISSING -* 'pointer': new pointer value for property +* _pointer_: new pointer value for property // TRANSLATION MISSING Prototypes for callbacks: @@ -11964,8 +11965,8 @@ char *weechat_buffer_string_replace_local_var (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'string': stringa con testo e variabili locali che utilizzano il formato "$var" +* _buffer_: puntatore al buffer +* _string_: stringa con testo e variabili locali che utilizzano il formato "$var" Valore restituito: @@ -12010,12 +12011,12 @@ int weechat_buffer_match_list (struct t_gui_buffer *buffer, const char *string); Argomenti: -* 'buffer': puntatore al buffer -* 'string': elenco separato da virgole di buffer: -** "*" indica tutti i buffer -** il nome preceduto da "!" viene escluso +* _buffer_: puntatore al buffer +* _string_: elenco separato da virgole di buffer: +** `+*+` indica tutti i buffer +** il nome preceduto da `+!+` viene escluso // TRANSLATION MISSING -** wildcard "*" is allowed in name +** wildcard `+*+` is allowed in name Valore restituito: @@ -12104,7 +12105,7 @@ struct t_gui_window *weechat_window_search_with_buffer (struct t_gui_buffer *buf Argomenti: -* 'buffer': puntatore al buffer +* _buffer_: puntatore al buffer Valore restituito: @@ -12146,28 +12147,28 @@ int weechat_window_get_integer (struct t_gui_window *window, Argomenti: -* 'window': puntatore alla finestra -* 'property': nome della proprietà: -** 'number': numero della finestra (inizia da 1) -** 'win_x': posizione X della finestra nel terminale (la prima colonna è 0) -** 'win_y': posizione Y della finestra nel terminale (la prima riga è 0) -** 'win_width': larghezza della finestra, in caratteri -** 'win_height': altezza della finestra, in caratteri -** 'win_width_pct': misura percentuale, paragonata alla finestra genitore +* _window_: puntatore alla finestra +* _property_: nome della proprietà: +** _number_: numero della finestra (inizia da 1) +** _win_x_: posizione X della finestra nel terminale (la prima colonna è 0) +** _win_y_: posizione Y della finestra nel terminale (la prima riga è 0) +** _win_width_: larghezza della finestra, in caratteri +** _win_height_: altezza della finestra, in caratteri +** _win_width_pct_: misura percentuale, paragonata alla finestra genitore (ad esempio 50 indica metà grandezza) -** 'win_height_pct': misura percentuale, paragonata alla finestra genitore +** _win_height_pct_: misura percentuale, paragonata alla finestra genitore (ad esempio 50 indica metà grandezza) -** 'win_chat_x': posizione X della finestra di chat nel terminale +** _win_chat_x_: posizione X della finestra di chat nel terminale (la prima colonna è 0) -** 'win_chat_y': posizione Y della finestra di chat nel terminale +** _win_chat_y_: posizione Y della finestra di chat nel terminale (la prima riga è 0) -** 'win_chat_width': larghezza della finestra di chat, in caratteri -** 'win_chat_height': altezza della finestra di chat, in caratteri -** 'first_line_displayed': 1 se la prima riga del buffer viene visualizzata +** _win_chat_width_: larghezza della finestra di chat, in caratteri +** _win_chat_height_: altezza della finestra di chat, in caratteri +** _first_line_displayed_: 1 se la prima riga del buffer viene visualizzata su schermo, altrimenti 0 -** 'scrolling': 1 se lo scorrimento è attivo sulla finestra (ultima riga non +** _scrolling_: 1 se lo scorrimento è attivo sulla finestra (ultima riga non visualizzata) -** 'lines_after': numero di righe non visualizzate dopo l'ultima visualizzata +** _lines_after_: numero di righe non visualizzate dopo l'ultima visualizzata (durante lo scorrimento) Valore restituito: @@ -12213,8 +12214,8 @@ int weechat_window_get_string (struct t_gui_window *window, Argomenti: -* 'window': puntatore alla finestra -* 'property': nome della proprietà +* _window_: puntatore alla finestra +* _property_: nome della proprietà Valore restituito: @@ -12234,10 +12235,10 @@ void *weechat_window_get_pointer (struct t_gui_window *window, Argomenti: -* 'window': puntatore alla finestra -* 'property': nome della proprietà: -** 'current': puntatore alla finestra corrente -** 'buffer': puntatore al buffer visualizzato dalla finestra +* _window_: puntatore alla finestra +* _property_: nome della proprietà: +** _current_: puntatore alla finestra corrente +** _buffer_: puntatore al buffer visualizzato dalla finestra Valore restituito: @@ -12277,7 +12278,7 @@ void weechat_window_set_title (const char *title); Argomenti: -* 'title': nuovo titolo per il terminale (NULL per resettarlo) +* _title_: nuovo titolo per il terminale (NULL per resettarlo) Esempio in C: @@ -12319,20 +12320,20 @@ struct t_gui_nick_group *weechat_nicklist_add_group (struct t_gui_buffer *buffer Argomenti: -* 'buffer': puntatore al buffer -* 'parent_group': puntatore al genitore del gruppo, NULL se il gruppo non ha genitore +* _buffer_: puntatore al buffer +* _parent_group_: puntatore al genitore del gruppo, NULL se il gruppo non ha genitore (lista nick radice) -* 'name': nome del gruppo -* 'color': nome per l'opzione colore: -** nome opzione per WeeChat, ad esempio 'weechat.color.nicklist_group' -** colore con sfondo opzionale, ad esempio 'yellow' o 'yellow,red' +* _name_: nome del gruppo +* _color_: nome per l'opzione colore: +** nome opzione per WeeChat, ad esempio _weechat.color.nicklist_group_ +** colore con sfondo opzionale, ad esempio _yellow_ o _yellow,red_ ** nome colore per la barra: -*** 'bar_fg': colore di primo piando per la barra -*** 'bar_delim': colore dei delimitatori per la barra -*** 'bar_bg': colore di sfondo per la barra -* 'visible': -** '1': gruppi e sottogruppi/nick sono visibili -** '0': gruppi e sottogruppi/nick sono nascosti +*** _bar_fg_: colore di primo piando per la barra +*** _bar_delim_: colore dei delimitatori per la barra +*** _bar_bg_: colore di sfondo per la barra +* _visible_: +** _1_: gruppi e sottogruppi/nick sono visibili +** _0_: gruppi e sottogruppi/nick sono nascosti [NOTE] Il nome del gruppo può iniziare con uno o più numeri, seguiti da una pipe, e @@ -12383,10 +12384,10 @@ struct t_gui_nick_group *weechat_nicklist_search_group (struct t_gui_buffer *buf Argomenti: -* 'buffer': puntatore al buffer -* 'from_group': ricerca solo da questo gruppo, se NULL, allora la cerca in +* _buffer_: puntatore al buffer +* _from_group_: ricerca solo da questo gruppo, se NULL, allora la cerca in tutta la lista nick -* 'name': nome gruppo da cercare +* _name_: nome gruppo da cercare Valore restituito: @@ -12430,27 +12431,27 @@ struct t_gui_nick_group *weechat_nicklist_add_nick (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore al gruppo -* 'name': nome nick -* 'color': nome dell'opzione per il colore: -*** nome opzione per WeeChat (da weechat.color.xxx), ad esempio 'chat_delimiters' -*** colore con sfondo opzionale, ad esempio 'yellow' o 'yellow,red' +* _buffer_: puntatore al buffer +* _group_: puntatore al gruppo +* _name_: nome nick +* _color_: nome dell'opzione per il colore: +*** nome opzione per WeeChat (da weechat.color.xxx), ad esempio _chat_delimiters_ +*** colore con sfondo opzionale, ad esempio _yellow_ o _yellow,red_ *** nome colore per la barra: -**** 'bar_fg': colore di primo piano per la barra -**** 'bar_delim': colore dei delimitatori per la barra -**** 'bar_bg': colore di sfondo per la barra -* 'prefix': prefisso visualizzato prima del nick -* 'prefix_color': nome dell'opzione per il colore: -** nome opzione per WeeChat (da weechat.color.xxx), ad esempio 'chat_delimiters' -** colore con sfondo opzionale, ad esempio 'yellow' o 'yellow,red' +**** _bar_fg_: colore di primo piano per la barra +**** _bar_delim_: colore dei delimitatori per la barra +**** _bar_bg_: colore di sfondo per la barra +* _prefix_: prefisso visualizzato prima del nick +* _prefix_color_: nome dell'opzione per il colore: +** nome opzione per WeeChat (da weechat.color.xxx), ad esempio _chat_delimiters_ +** colore con sfondo opzionale, ad esempio _yellow_ o _yellow,red_ ** nome colore per la barra: -*** 'bar_fg': colore di primo piano per la barra -*** 'bar_delim': colore dei delimitatori per la barra -*** 'bar_bg': colore di sfondo per la barra -* 'visible': -** '1': il nick è visibile -** '0': il nick è nascosto +*** _bar_fg_: colore di primo piano per la barra +*** _bar_delim_: colore dei delimitatori per la barra +*** _bar_bg_: colore di sfondo per la barra +* _visible_: +** _1_: il nick è visibile +** _0_: il nick è nascosto Valore restituito: @@ -12498,10 +12499,10 @@ struct t_gui_nick *weechat_nicklist_search_nick (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'from_group': cerca solo da questo gruppo, se NULL, allora cerca +* _buffer_: puntatore al buffer +* _from_group_: cerca solo da questo gruppo, se NULL, allora cerca nell'intera lista nick -* 'name': nick da cercare +* _name_: nick da cercare Valore restituito: @@ -12540,8 +12541,8 @@ void weechat_nicklist_remove_group (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore al gruppo da rimuovere (verranno rimossi anhe +* _buffer_: puntatore al buffer +* _group_: puntatore al gruppo da rimuovere (verranno rimossi anhe i sottogruppi/nick) Esempio in C: @@ -12576,8 +12577,8 @@ void weechat_nicklist_remove_nick (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'nick': puntatore al nick da rimuovere +* _buffer_: puntatore al buffer +* _nick_: puntatore al nick da rimuovere Esempio in C: @@ -12610,7 +12611,7 @@ void weechat_nicklist_remove_all (struct t_gui_buffer *buffer); Argomenti: -* 'buffer': puntatore al buffer +* _buffer_: puntatore al buffer Esempio in C: @@ -12648,9 +12649,9 @@ void weechat_nicklist_get_next_item (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore sul puntatore al gruppo -* 'nick': puntatore sul puntatore al nick +* _buffer_: puntatore al buffer +* _group_: puntatore sul puntatore al gruppo +* _nick_: puntatore sul puntatore al nick Esempio in C: @@ -12698,11 +12699,11 @@ int weechat_nicklist_group_get_integer (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore al gruppo -* 'property': nome della proprietà: -** 'visible': 1 se il gruppo è visibile, altrimenti 0 -** 'level': livello del gruppo (root è 0) +* _buffer_: puntatore al buffer +* _group_: puntatore al gruppo +* _property_: nome della proprietà: +** _visible_: 1 se il gruppo è visibile, altrimenti 0 +** _level_: livello del gruppo (root è 0) Valore restituito: @@ -12743,11 +12744,11 @@ const char *weechat_nicklist_group_get_string (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore al gruppo -* 'property': nome della proprietà: -** 'name': nome del gruppo -** 'color': colore del gruppo nella lista nick +* _buffer_: puntatore al buffer +* _group_: puntatore al gruppo +* _property_: nome della proprietà: +** _name_: nome del gruppo +** _color_: colore del gruppo nella lista nick Valore restituito: @@ -12788,10 +12789,10 @@ void *weechat_nicklist_group_get_pointer (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore al gruppo -* 'property': nome della proprietà: -** 'parent': puntatore al gruppo genitore +* _buffer_: puntatore al buffer +* _group_: puntatore al gruppo +* _property_: nome della proprietà: +** _parent_: puntatore al gruppo genitore Valore restituito: @@ -12833,12 +12834,12 @@ void weechat_nicklist_group_set (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'group': puntatore al gruppo +* _buffer_: puntatore al buffer +* _group_: puntatore al gruppo // TRANSLATION MISSING -* 'property': nome della proprietà (see table below) +* _property_: nome della proprietà (see table below) // TRANSLATION MISSING -* 'value': new value for property +* _value_: new value for property // TRANSLATION MISSING Properties: @@ -12905,10 +12906,10 @@ int weechat_nicklist_nick_get_integer (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'nick': puntatore al nick -* 'property': nome della proprietà: -** 'visible': 1 se il nick è visibile, altrimenti 0 +* _buffer_: puntatore al buffer +* _nick_: puntatore al nick +* _property_: nome della proprietà: +** _visible_: 1 se il nick è visibile, altrimenti 0 Valore restituito: @@ -12949,13 +12950,13 @@ const char *weechat_nicklist_nick_get_string (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'nick': puntatore al nick -* 'property': nome della proprietà: -** 'name': nome del nick -** 'color': colore del nick nella lista nick -** 'prefix': prefisso del nick -** 'prefix_color': colore del prefisso nella lista nick +* _buffer_: puntatore al buffer +* _nick_: puntatore al nick +* _property_: nome della proprietà: +** _name_: nome del nick +** _color_: colore del nick nella lista nick +** _prefix_: prefisso del nick +** _prefix_color_: colore del prefisso nella lista nick Valore restituito: @@ -12996,10 +12997,10 @@ void *weechat_nicklist_nick_get_pointer (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'nick': puntatore al nick -* 'property': nome proprietà: -** 'group': puntatore al gruppo che contiene questo nick +* _buffer_: puntatore al buffer +* _nick_: puntatore al nick +* _property_: nome proprietà: +** _group_: puntatore al gruppo che contiene questo nick Valore restituito: @@ -13041,12 +13042,12 @@ void weechat_nicklist_nick_set (struct t_gui_buffer *buffer, Argomenti: -* 'buffer': puntatore al buffer -* 'nick': puntatore al nick +* _buffer_: puntatore al buffer +* _nick_: puntatore al nick // TRANSLATION MISSING -* 'property': nome della proprietà (see table below) +* _property_: nome della proprietà (see table below) // TRANSLATION MISSING -* 'value': new value for property +* _value_: new value for property // TRANSLATION MISSING Properties: @@ -13127,7 +13128,7 @@ struct t_gui_bar_item *weechat_bar_item_search (const char *name); Argomenti: -* 'name': nome dell'elemento barra +* _name_: nome dell'elemento barra Valore restituito: @@ -13175,27 +13176,27 @@ struct t_gui_bar_item *weechat_bar_item_new (const char *name, Argomenti: -* 'name': nome dell'elemento barra -* 'build_callback': funzione chiamata quando l'elemento barra viene +* _name_: nome dell'elemento barra +* _build_callback_: funzione chiamata quando l'elemento barra viene compilato, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_gui_bar_item *item': puntatore all'elemento barra +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_gui_bar_item *item_: puntatore all'elemento barra // TRANSLATION MISSING -** 'struct t_gui_window *window': puntatore alla finestra (NULL when called for +** _struct t_gui_window *window_: puntatore alla finestra (NULL when called for a root bar) // TRANSLATION MISSING -** 'struct t_gui_buffer *buffer': buffer displayed in window (if window is NULL, +** _struct t_gui_buffer *buffer_: buffer displayed in window (if window is NULL, then it is current buffer) or buffer given in bar item with syntax: "@buffer:item" _(WeeChat ≥ 0.4.2)_ // TRANSLATION MISSING -** 'struct t_hashtable *extra_info': always NULL (argument is reserved for a +** _struct t_hashtable *extra_info_: always NULL (argument is reserved for a future version) _(WeeChat ≥ 0.4.2)_ ** valore restituito: contenuto dell'elemento barra -* 'build_callback_pointer': puntatore fornito alla callback quando +* _build_callback_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'build_callback_data': puntatore fornito dalla callback quando chiamata da +* _build_callback_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the bar item is removed @@ -13227,7 +13228,7 @@ Script (Python): // TRANSLATION MISSING [IMPORTANT] For compatibility with versions ≤ 0.4.1, the default callback has only 3 -arguments: 'data', 'item' and 'window' (no 'buffer' and 'extra_info'). + +arguments: _data_, _item_ and _window_ (no _buffer_ and _extra_info_). + To use a callback with all arguments, you must add "(extra)" before the name, see example below (supported only in WeeChat ≥ 0.4.2). @@ -13264,7 +13265,7 @@ void weechat_bar_item_update (const char *name); Argomenti: -* 'name': nome dell'elemento barra +* _name_: nome dell'elemento barra Esempio in C: @@ -13297,7 +13298,7 @@ void weechat_bar_item_remove (struct t_gui_bar_item *item); Argomenti: -* 'item': puntatore all'elemento barra +* _item_: puntatore all'elemento barra Esempio in C: @@ -13330,7 +13331,7 @@ struct t_gui_bar *weechat_bar_search (const char *name); Argomenti: -* 'name': nome della barra +* _name_: nome della barra Valore restituito: @@ -13381,50 +13382,50 @@ struct t_gui_bar *weechat_bar_new (const char *name, Argomenti: -* 'name': nome della barra -* 'hidden': -** 'on': la barra è nascosta -** 'off': la barra è visibile -* 'priority': priorità per la barra (intero) -* 'type': -** 'root': barra visualizzata una sola volta, al di fuori delle finestre -** 'window': barra visualizzata in ogni finestra -* 'condition': condizioni per la visualizzazione della barra: -** 'active': la barra viene visualizzata solo nella finestra attiva -** 'inactive': la barra viene visualizzata solo nelle finestre inattive -** 'nicklist': la barra viene visualizzata nelle finestre con liste nick +* _name_: nome della barra +* _hidden_: +** _on_: la barra è nascosta +** _off_: la barra è visibile +* _priority_: priorità per la barra (intero) +* _type_: +** _root_: barra visualizzata una sola volta, al di fuori delle finestre +** _window_: barra visualizzata in ogni finestra +* _condition_: condizioni per la visualizzazione della barra: +** _active_: la barra viene visualizzata solo nella finestra attiva +** _inactive_: la barra viene visualizzata solo nelle finestre inattive +** _nicklist_: la barra viene visualizzata nelle finestre con liste nick // TRANSLATION MISSING -** evaluated expression: see chapter about bars in 'WeeChat User's guide' -* 'position': 'top', 'bottom', 'left' o 'right' -* 'filling_top_bottom': -** 'horizontal': gli elementi sono posizionati in orizzontale +** evaluated expression: see chapter about bars in _WeeChat User's guide_ +* _position_: _top_, _bottom_, _left_ o _right_ +* _filling_top_bottom_: +** _horizontal_: gli elementi sono posizionati in orizzontale (spazio dopo ogni elemento) -** 'vertical': gli elementi sono posizionati in verticale +** _vertical_: gli elementi sono posizionati in verticale (nuova riga dopo ogni elemento) -** 'columns_horizontal': gli elementi sono posizionati in orizzontale, +** _columns_horizontal_: gli elementi sono posizionati in orizzontale, visualizzati su colonne -** 'columns_vertical': gli elementi sono posizionati in verticale, +** _columns_vertical_: gli elementi sono posizionati in verticale, visualizzati su colonne -* 'filling_left_right': -** 'horizontal': gli elementi sono posizionati in orizzontale +* _filling_left_right_: +** _horizontal_: gli elementi sono posizionati in orizzontale (spazio dopo ogni elemento) -** 'vertical': gli elementi sono posizionati in verticale +** _vertical_: gli elementi sono posizionati in verticale (nuova riga dopo ogni elemento) -** 'columns_horizontal': gli elementi sono posizionati in orizzontale, +** _columns_horizontal_: gli elementi sono posizionati in orizzontale, visualizzati su colonne -** 'columns_vertical': gli elementi sono posizionati in verticale, +** _columns_vertical_: gli elementi sono posizionati in verticale, visualizzati su colonne -* 'size': dimensione della barra in caratteri +* _size_: dimensione della barra in caratteri (0 corrisponde a dimensione automatica) -* 'size_max': dimensione massima per la barra +* _size_max_: dimensione massima per la barra (0 corrisponde a nessuna dimensione massima) -* 'color_fg': colore per il testo nella barra -* 'color_delim': colore per i delimitatori nella barra -* 'color_bg': colore di sfondo per la barra -* 'separator': -** 'on': la barra ha una riga di separazione con altre finestre/barre -** 'off': nessun separatore -* 'items': elenco di elemento nella barra, separati da virgola (spazio tra +* _color_fg_: colore per il testo nella barra +* _color_delim_: colore per i delimitatori nella barra +* _color_bg_: colore di sfondo per la barra +* _separator_: +** _on_: la barra ha una riga di separazione con altre finestre/barre +** _off_: nessun separatore +* _items_: elenco di elemento nella barra, separati da virgola (spazio tra gli elementi), o "+" (elementi incollati) Valore restituito: @@ -13480,11 +13481,11 @@ int weechat_bar_set (struct t_gui_bar *bar, const char *property, Argomenti: -* 'bar': puntatore alla barra -* 'property': name, hidden, priority, conditions, position, filling_top_bottom, +* _bar_: puntatore alla barra +* _property_: name, hidden, priority, conditions, position, filling_top_bottom, filling_left_right, size, size_max, color_fg, color_delim, color_bg, separator, items (consultare <<_bar_new,weechat_bar_new>>) -* 'value': nuovo valore per la proprietà +* _value_: nuovo valore per la proprietà Valore restituito: @@ -13521,7 +13522,7 @@ void weechat_bar_update (const char *name); Argomenti: -* 'name': nome della barra +* _name_: nome della barra Esempio in C: @@ -13554,7 +13555,7 @@ void weechat_bar_remove (struct t_gui_bar *bar); Argomenti: -* 'bar': puntatore alla barra +* _bar_: puntatore alla barra Esempio in C: @@ -13596,15 +13597,15 @@ int weechat_command (struct t_gui_buffer *buffer, const char *command); Argomenti: -* 'buffer': puntatore al buffer (il comando viene eseguito su questo buffer, +* _buffer_: puntatore al buffer (il comando viene eseguito su questo buffer, utilizzare NULL per il buffer corrente) -* 'command': comando da eseguire (se preceduto da "/"), oppure il testo +* _command_: comando da eseguire (se preceduto da "/"), oppure il testo viene inviato sul buffer Valori restituiti: (_WeeChat ≥ 1.1_) -* 'WEECHAT_RC_OK' se l'operazione ha successo -* 'WEECHAT_RC_ERROR' se c'è un errore +* _WEECHAT_RC_OK_ se l'operazione ha successo +* _WEECHAT_RC_ERROR_ se c'è un errore Esempio in C: @@ -13652,10 +13653,10 @@ int weechat_network_pass_proxy (const char *proxy, Argomenti: -* 'proxy': nome del proxy da utilizzare -* 'sock': socket da utilizzare -* 'address': indirizzo (nome host o indirizzo IP) -* 'port': port +* _proxy_: nome del proxy da utilizzare +* _sock_: socket da utilizzare +* _address_: indirizzo (nome host o indirizzo IP) +* _port_: port Valore restituito: @@ -13702,11 +13703,11 @@ int weechat_network_connect_to (const char *proxy, Argomenti: -* 'proxy': nome del proxy da utilizzare +* _proxy_: nome del proxy da utilizzare // TRANSLATION MISSING -* 'address': address to connect to (with port) +* _address_: address to connect to (with port) // TRANSLATION MISSING -* 'address_length': length of argument 'address' +* _address_length_: length of argument _address_ Valore restituito: @@ -13758,8 +13759,8 @@ const char *weechat_info_get (const char *info_name, const char *arguments); Argomenti: // TRANSLATION MISSING -* 'info_name': nome delle informazioni da leggere (see table below) -* 'arguments': argomenti per l'informazione richiesta (opzionake, NULL se non +* _info_name_: nome delle informazioni da leggere (see table below) +* _arguments_: argomenti per l'informazione richiesta (opzionake, NULL se non è richiesto alcun argomento) Valore restituito: @@ -13812,8 +13813,8 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, Argomenti: // TRANSLATION MISSING -* 'info_name': nome della info da leggere (see table below) -* 'hashtable': tabella hash con argomenti (dipende dalla info richiesta) +* _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) Valore restituito: @@ -13866,7 +13867,7 @@ if (hashtable_in) // TRANSLATION MISSING [NOTE] -See the 'WeeChat Scripting Guide' for more info about "irc_message_parse" +See the _WeeChat Scripting Guide_ for more info about "irc_message_parse" output. Script (Python): @@ -13894,11 +13895,11 @@ server IRC definiti). Per ogni elemento, esistono variabili come "name", Ogni variabile ha un tipo e un valore. I tipi possibili sono: -* 'integer': qualunque valore intero -* 'string': qualunque valore stringa -* 'pointer': qualunque puntatore -* 'buffer': buffer di lunghezza fissa, contenente qualunque dato -* 'time': valore tempo +* _integer_: qualunque valore intero +* _string_: qualunque valore stringa +* _pointer_: qualunque puntatore +* _buffer_: buffer di lunghezza fissa, contenente qualunque dato +* _time_: valore tempo ==== infolist_new @@ -13946,7 +13947,7 @@ struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); Argomenti: -* 'infolist': puntatore alla lista info +* _infolist_: puntatore alla lista info Valore restituito: @@ -13986,9 +13987,9 @@ struct t_infolist_var *weechat_infolist_new_var_integer (struct t_infolist_item Argomenti: -* 'item': puntatore all'elemento della lista info -* 'name': nome variabile -* 'value': valore intero +* _item_: puntatore all'elemento della lista info +* _name_: nome variabile +* _value_: valore intero Valore restituito: @@ -14030,9 +14031,9 @@ struct t_infolist_var *weechat_infolist_new_var_string (struct t_infolist_item * Argomenti: -* 'item': puntatore all'elemento della lista info -* 'name': nome variabile -* 'value': valore stringa +* _item_: puntatore all'elemento della lista info +* _name_: nome variabile +* _value_: valore stringa Valore restituito: @@ -14074,9 +14075,9 @@ struct t_infolist_var *weechat_infolist_new_var_pointer (struct t_infolist_item Argomenti: -* 'item': puntatore all'elemento della lista info -* 'name': nome variabile -* 'pointer': puntatore +* _item_: puntatore all'elemento della lista info +* _name_: nome variabile +* _pointer_: puntatore Valore restituito: @@ -14118,10 +14119,10 @@ struct t_infolist_var *weechat_infolist_new_var_buffer (struct t_infolist_item * Argomenti: -* 'item': puntatore all'elemento della lista info -* 'name': nome della variabile -* 'pointer': puntatore al buffer -* 'size': dimensione del buffer +* _item_: puntatore all'elemento della lista info +* _name_: nome della variabile +* _pointer_: puntatore al buffer +* _size_: dimensione del buffer Valore restituito: @@ -14157,9 +14158,9 @@ struct t_infolist_var *weechat_infolist_new_var_time (struct t_infolist_item *it Argomenti: -* 'item': puntatore all'elemento della lista info -* 'name': nome della variabile -* 'time': valore tempo +* _item_: puntatore all'elemento della lista info +* _name_: nome della variabile +* _time_: valore tempo Valore restituito: @@ -14209,10 +14210,10 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, Argomenti: // TRANSLATION MISSING -* 'infolist_name': nome della lista info da leggere (see table below) -* 'pointer': puntatore ad un elemento, per ricevere solo questo +* _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 +* _arguments_: argomenti per la lista info richiesta (opzionale, NULL se non è necessario alcun argomento) Valore restituito: @@ -14257,7 +14258,7 @@ int weechat_infolist_next (struct t_infolist *infolist); Argomenti: -* 'infolist': puntatore alla lista info +* _infolist_: puntatore alla lista info Valore restituito: @@ -14308,7 +14309,7 @@ int weechat_infolist_prev (struct t_infolist *infolist); Argomenti: -* 'infolist': puntatore alla lista info +* _infolist_: puntatore alla lista info Valore restituito: @@ -14357,7 +14358,7 @@ void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); Argomenti: -* 'infolist': puntatore alla lista info +* _infolist_: puntatore alla lista info Esempio in C: @@ -14394,8 +14395,8 @@ struct t_infolist_var *weechat_infolist_search_var (struct t_infolist *infolist, Argomenti: -* 'infolist': puntatore alla lista info -* 'name': nome della variabile +* _infolist_: puntatore alla lista info +* _name_: nome della variabile Valore restituito: @@ -14442,7 +14443,7 @@ const char *weechat_infolist_fields (struct t_infolist *infolist); Argomenti: -* 'infolist': puntatore alla lista info +* _infolist_: puntatore alla lista info Valore restituito: @@ -14487,8 +14488,8 @@ int weechat_infolist_integer (struct t_infolist *infolist, const char *var); Argomenti: -* 'infolist': puntatore alla lista info -* 'var': nome della variabile (deve essere di tipo "integer") +* _infolist_: puntatore alla lista info +* _var_: nome della variabile (deve essere di tipo "integer") Valore restituito: @@ -14527,8 +14528,8 @@ const char *weechat_infolist_string (struct t_infolist *infolist, const char *va Argomenti: -* 'infolist': puntatore alla lista info -* 'var': nome della variabile (deve essere di tipo "string") +* _infolist_: puntatore alla lista info +* _var_: nome della variabile (deve essere di tipo "string") Valore restituito: @@ -14567,8 +14568,8 @@ void *weechat_infolist_pointer (struct t_infolist *infolist, const char *var); Argomenti: -* 'infolist': puntatore alla lista info -* 'var': nome della variabile (deve essere di tipo "pointer") +* _infolist_: puntatore alla lista info +* _var_: nome della variabile (deve essere di tipo "pointer") Valore restituito: @@ -14608,9 +14609,9 @@ void *weechat_infolist_buffer (struct t_infolist *infolist, const char *var, Argomenti: -* 'infolist': puntatore alla lista info -* 'var': nome della variabile (deve essere di tipo "buffer") -* 'size': puntatore ad una variabile intera, verrà impostata con la +* _infolist_: puntatore alla lista info +* _var_: nome della variabile (deve essere di tipo "buffer") +* _size_: puntatore ad una variabile intera, verrà impostata con la dimensione del buffer Valore restituito: @@ -14644,8 +14645,8 @@ time_t weechat_infolist_time (struct t_infolist *infolist, const char *var); Argomenti: -* 'infolist': puntatore alla lista info -* 'var': nome della variabile (deve essere di tipo "time") +* _infolist_: puntatore alla lista info +* _var_: nome della variabile (deve essere di tipo "time") Valore restituito: @@ -14683,7 +14684,7 @@ void weechat_infolist_free (struct t_infolist *infolist); Argomenti: -* 'infolist': puntatore alla lista info +* _infolist_: puntatore alla lista info Esempio in C: @@ -14749,27 +14750,27 @@ struct t_hdata *weechat_hdata_new (const char *hdata_name, const char *var_prev, Argomenti: -* 'hdata_name': nome di un hdata -* 'var_prev': nome della variabile nella struttura che è puntatore all'elemento +* _hdata_name_: nome di un hdata +* _var_prev_: nome della variabile nella struttura che è puntatore all'elemento precedente nella lista (può essere NULL se non è disponibile tale variabile) -* 'var_next': nome della variabile nella struttura che è puntatore all'elemento +* _var_next_: nome della variabile nella struttura che è puntatore all'elemento successivo nella lista (può essere NULL se non è disponibile tale variabile) // TRANSLATION MISSING -* 'create_allowed': 1 if create of structure is allowed, otherwise 0 +* _create_allowed_: 1 if create of structure is allowed, otherwise 0 _(WeeChat ≥ 0.4.0)_ // TRANSLATION MISSING -* 'delete_allowed': 1 if delete of structure is allowed, otherwise 0 +* _delete_allowed_: 1 if delete of structure is allowed, otherwise 0 _(WeeChat ≥ 0.3.9)_ // TRANSLATION MISSING -* 'callback_update': callback to update data in hdata, can be NULL if no update +* _callback_update_: callback to update data in hdata, can be NULL if no update is allowed _(WeeChat ≥ 0.3.9)_, arguments and return value: -** 'void *data': pointer -** 'struct t_hdata *hdata': pointer to hdata -** 'struct t_hashtable *hashtable': hashtable with variables to update +** _void *data_: pointer +** _struct t_hdata *hdata_: pointer to hdata +** _struct t_hashtable *hashtable_: hashtable with variables to update (see <<_hdata_update,weechat_hdata_update>>) ** return value: number of variables updated // TRANSLATION MISSING -* 'callback_update_data': pointer given to update callback when it is called by +* _callback_update_data_: pointer given to update callback when it is called by WeeChat _(WeeChat ≥ 0.3.9)_ Valore restituito: @@ -14802,10 +14803,10 @@ void weechat_hdata_new_var (struct t_hdata *hdata, const char *name, int offset, Argomenti: -* 'hdata': puntatore ad hdata -* 'name': nome della variabile -* 'offset': offset della variabile nella struttura -* 'type': tipo variabile, una di: +* _hdata_: puntatore ad hdata +* _name_: nome della variabile +* _offset_: offset della variabile nella struttura +* _type_: tipo variabile, una di: ** WEECHAT_HDATA_CHAR ** WEECHAT_HDATA_INTEGER ** WEECHAT_HDATA_LONG @@ -14816,17 +14817,17 @@ Argomenti: ** WEECHAT_HDATA_HASHTABLE ** WEECHAT_HDATA_OTHER // TRANSLATION MISSING -* 'update_allowed': 1 if update of variable is allowed, otherwise 0 +* _update_allowed_: 1 if update of variable is allowed, otherwise 0 _(WeeChat ≥ 0.3.9)_ // TRANSLATION MISSING -* 'array_size': not NULL only if a variable is an array, and it can be: +* _array_size_: not NULL only if a variable is an array, and it can be: _(WeeChat ≥ 0.3.9)_ ** name of variable in hdata: this variable will be used as size of array (dynamic size for array) ** integer (as string): fixed size for array -** '*': automatic size: the size of array is computed by looking at values, when +** _*_: automatic size: the size of array is computed by looking at values, when the first NULL is found (only for type string, pointer or hashtable) -* 'hdata_name': nome di un hdata (se è un puntatore ad una struttura con dati) +* _hdata_name_: nome di un hdata (se è un puntatore ad una struttura con dati) Esempio in C: @@ -14887,12 +14888,12 @@ void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *poin Argomenti: -* 'hdata': puntatore hdata -* 'name': nome delal variabile -* 'pointer': puntatore alla lista +* _hdata_: puntatore hdata +* _name_: nome delal variabile +* _pointer_: puntatore alla lista // TRANSLATION MISSING -* 'flags': combination of following values: _(WeeChat ≥ 1.0)_ -** 'WEECHAT_HDATA_LIST_CHECK_POINTERS': list used to check pointers +* _flags_: combination of following values: _(WeeChat ≥ 1.0)_ +** _WEECHAT_HDATA_LIST_CHECK_POINTERS_: list used to check pointers Esempio in C: @@ -14956,7 +14957,7 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); Argomenti: // TRANSLATION MISSING -* 'hdata_name': nome di un hdata (see list below) +* _hdata_name_: nome di un hdata (see list below) Valore restituito: @@ -15000,8 +15001,8 @@ int weechat_hdata_get_var_offset (struct t_hdata *hdata, const char *name); Argomenti: -* 'hdata': puntatore hdata -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _name_: nome della variabile Valore restituito: @@ -15040,8 +15041,8 @@ int weechat_hdata_get_var_type (struct t_hdata *hdata, const char *name); Argomenti: -* 'hdata': puntatore hdata -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _name_: nome della variabile Valore restituito: @@ -15105,8 +15106,8 @@ const char *weechat_hdata_get_var_type_string (struct t_hdata *hdata, const char Argomenti: -* 'hdata': puntatore hdata -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _name_: nome della variabile Valore restituito: @@ -15147,9 +15148,9 @@ int weechat_hdata_get_var_array_size (struct t_hdata *hdata, void *pointer, cons Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntarore all'oggetto di WeeChat/plugin -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _pointer_: puntarore all'oggetto di WeeChat/plugin +* _name_: nome della variabile Valore restituito: @@ -15191,9 +15192,9 @@ const char *weechat_hdata_get_var_array_size_string (struct t_hdata *hdata, void Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntarore all'oggetto di WeeChat/plugin -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _pointer_: puntarore all'oggetto di WeeChat/plugin +* _name_: nome della variabile Valore restituito: @@ -15234,8 +15235,8 @@ const char *weechat_hdata_get_var_hdata (struct t_hdata *hdata, const char *name Argomenti: -* 'hdata': puntatore hdata -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _name_: nome della variabile Valore restituito: @@ -15274,9 +15275,9 @@ void *weechat_hdata_get_var (struct t_hdata *hdata, void *pointer, const char *n Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntarore all'oggetto di WeeChat/plugin -* 'name': nome della variabile +* _hdata_: puntatore hdata +* _pointer_: puntarore all'oggetto di WeeChat/plugin +* _name_: nome della variabile Valore restituito: @@ -15309,9 +15310,9 @@ void *weechat_hdata_get_var_at_offset (struct t_hdata *hdata, void *pointer, int Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore ad un oggetto di WeeChat/plugin -* 'offset': offset della variabile +* _hdata_: puntatore hdata +* _pointer_: puntatore ad un oggetto di WeeChat/plugin +* _offset_: offset della variabile Valore restituito: @@ -15345,8 +15346,8 @@ void *weechat_hdata_get_list (struct t_hdata *hdata, const char *name); Argomenti: -* 'hdata': puntatore hdata -* 'name': nome della lista +* _hdata_: puntatore hdata +* _name_: nome della lista Valore restituito: @@ -15388,13 +15389,13 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe Argomenti: -* 'hdata': puntatore hdata +* _hdata_: puntatore hdata // TRANSLATION MISSING -* 'list': puntatore alla lista; if NULL _(WeeChat ≥ 1.0)_, the pointer is +* _list_: puntatore alla lista; if NULL _(WeeChat ≥ 1.0)_, the pointer is checked with the lists in hdata that have flag "check pointers" (see <<_hdata_new_list,weechat_hdata_new_list>>), and if no such list exists, the pointer is considered as valid -* 'pointer': puntatore da verificare +* _pointer_: puntatore da verificare Valore restituito: @@ -15450,9 +15451,9 @@ void *weechat_hdata_move (struct t_hdata *hdata, void *pointer, int count); Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore ad un oggetto di WeeChat/plugin -* 'count': numero di salto(i) da eseguire (intero positivo o negativo, diverso +* _hdata_: puntatore hdata +* _pointer_: puntatore ad un oggetto di WeeChat/plugin +* _count_: numero di salto(i) da eseguire (intero positivo o negativo, diverso da 0) Valore restituito: @@ -15498,7 +15499,7 @@ if buffer: _WeeChat ≥ 0.4.1._ // TRANSLATION MISSING -Search element in a list: the expression 'search' is evaluated for each element +Search element in a list: the expression _search_ is evaluated for each element in list, until element is found (or end of list). Prototipo: @@ -15510,14 +15511,14 @@ void *weechat_hdata_search (struct t_hdata *hdata, void *pointer, const char *se Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore ad un oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore ad un oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'search': expression to evaluate, default pointer in expression is the name of +* _search_: expression to evaluate, default pointer in expression is the name of hdata (and this pointer changes for each element in list); for help on - expression, see command `/eval` in 'WeeChat User's guide' + expression, see command `/eval` in _WeeChat User's guide_ // TRANSLATION MISSING -* 'move': number of jump(s) to execute after unsuccessful search (negative or +* _move_: number of jump(s) to execute after unsuccessful search (negative or positive integer, different from 0) Valore restituito: @@ -15573,10 +15574,10 @@ char weechat_hdata_char (struct t_hdata *hdata, void *pointer, const char *name) Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore all'oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "char"); for arrays, +* _name_: nome della variabile (deve essere di tipo "char"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15617,10 +15618,10 @@ int weechat_hdata_integer (struct t_hdata *hdata, void *pointer, const char *nam Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore all'oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "integer"); for arrays, +* _name_: nome della variabile (deve essere di tipo "integer"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15665,10 +15666,10 @@ long weechat_hdata_long (struct t_hdata *hdata, void *pointer, const char *name) Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore all'oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "long"); for arrays, +* _name_: nome della variabile (deve essere di tipo "long"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15709,10 +15710,10 @@ const char *weechat_hdata_string (struct t_hdata *hdata, void *pointer, const ch Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore all'oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "string"); for arrays, +* _name_: nome della variabile (deve essere di tipo "string"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15757,10 +15758,10 @@ void *weechat_hdata_pointer (struct t_hdata *hdata, void *pointer, const char *n Argomenti: -* 'hdata': hdata hdata -* 'pointer': pointer all'oggetto di WeeChat/plugin +* _hdata_: hdata hdata +* _pointer_: pointer all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "pointer"); for arrays, +* _name_: nome della variabile (deve essere di tipo "pointer"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15805,10 +15806,10 @@ time_t weechat_hdata_time (struct t_hdata *hdata, void *pointer, const char *nam Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore all'oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "time"); for arrays, +* _name_: nome della variabile (deve essere di tipo "time"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15876,10 +15877,10 @@ struct t_hashtable *weechat_hdata_hashtable (struct t_hdata *hdata, void *pointe Argomenti: -* 'hdata': puntatore hdata -* 'pointer': puntatore all'oggetto di WeeChat/plugin +* _hdata_: puntatore hdata +* _pointer_: puntatore all'oggetto di WeeChat/plugin // TRANSLATION MISSING -* 'name': nome della variabile (deve essere di tipo "hashtable"); for arrays, +* _name_: nome della variabile (deve essere di tipo "hashtable"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name" @@ -15935,11 +15936,11 @@ int weechat_hdata_set (struct t_hdata *hdata, void *pointer, const char *name, c Argomenti: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'name': variable name (types allowed: char, integer, long, string, pointer, +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _name_: variable name (types allowed: char, integer, long, string, pointer, time) -* 'value': new value for variable +* _value_: new value for variable Valore restituito: @@ -15971,9 +15972,9 @@ int weechat_hdata_update (struct t_hdata *hdata, void *pointer, struct t_hashtab Argomenti: -* 'hdata': hdata pointer -* 'pointer': pointer to WeeChat/plugin object -* 'hashtable': variables to update: keys are name of variables, values are new +* _hdata_: hdata pointer +* _pointer_: pointer to WeeChat/plugin object +* _hashtable_: variables to update: keys are name of variables, values are new values for variables (keys and values are string), some special keys are allowed: // TRANSLATION MISSING @@ -16058,23 +16059,23 @@ const char *weechat_hdata_get_string (struct t_hdata *hdata, const char *propert Argomenti: -* 'hdata': puntatore hdata -* 'property': nome della proprietà: -** 'var_keys': stringa con la lista di chiavi per le variabili in hdata +* _hdata_: puntatore hdata +* _property_: nome della proprietà: +** _var_keys_: stringa con la lista di chiavi per le variabili in hdata (formato: "key1,key2,key3") -** 'var_values': stringa con la lista di valori per le variabili in hdata +** _var_values_: stringa con la lista di valori per le variabili in hdata (formato: "value1,value2,value3") -** 'var_keys_values': stringa cona la lista di chiavi e valori per le variabili in hdata +** _var_keys_values_: stringa cona la lista di chiavi e valori per le variabili in hdata (formato: "key1:value1,key2:value2,key3:value3") -** 'var_prev': nome della variabile nella struttura che fa da puntatore al +** _var_prev_: nome della variabile nella struttura che fa da puntatore al precedente elemento nella lista -** 'var_next': nome della variabile nella struttura che fa da puntatore al +** _var_next_: nome della variabile nella struttura che fa da puntatore al successivo elemento nella lista -** 'list_keys': stringa con la lista di chiavi per le liste in hdata +** _list_keys_: stringa con la lista di chiavi per le liste in hdata (formato: "key1,key2,key3") -** 'list_values': stringa con la lista di valori per le liste in hdata +** _list_values_: stringa con la lista di valori per le liste in hdata (formato: "value1,value2,value3") -** 'list_keys_values': stringa con la lista di chiavi e valori per le liste in hdata +** _list_keys_values_: stringa con la lista di chiavi e valori per le liste in hdata (formato: "key1:value1,key2:value2,key3:value3") Valore restituito: @@ -16129,22 +16130,22 @@ struct t_upgrade_file *upgrade_file_new (const char *filename, Argomenti: -* 'filename': nome del file (l'estensione ".upgrade" verrà aggiunta a questo nome +* _filename_: nome del file (l'estensione ".upgrade" verrà aggiunta a questo nome da WeeChat) -* 'callback_read': funzione chiamata per ogni oggetto letto nel file +* _callback_read_: funzione chiamata per ogni oggetto letto nel file di aggiornamento, argomenti e valore restituito: -** 'const void *pointer': puntatore -** 'void *data': puntatore -** 'struct t_upgrade_file *upgrade_file': puntatore al file di aggiornamento -** 'int object_id': id dell'oggetto -** 'struct t_infolist *infolist': lista info con il contenuto dell'oggetto +** _const void *pointer_: puntatore +** _void *data_: puntatore +** _struct t_upgrade_file *upgrade_file_: puntatore al file di aggiornamento +** _int object_id_: id dell'oggetto +** _struct t_infolist *infolist_: lista info con il contenuto dell'oggetto ** valore restituito: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_read_pointer': puntatore fornito alla callback quando chiamata da +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_read_pointer_: puntatore fornito alla callback quando chiamata da WeeChat // TRANSLATION MISSING -* 'callback_read_data': puntatore fornito dalla callback quando chiamata da +* _callback_read_data_: puntatore fornito dalla callback quando chiamata da WeeChat; if not NULL, it must have been allocated with malloc (or similar function) and it is automatically freed when the upgrade file is closed @@ -16186,9 +16187,9 @@ int weechat_upgrade_write_object (struct t_upgrade_file *upgrade_file, Argomenti: -* 'upgrade_file': puntatore al file di aggiornamento -* 'object_id': id per l'oggetto -* 'infolist': lista info da scrivere nel file +* _upgrade_file_: puntatore al file di aggiornamento +* _object_id_: id per l'oggetto +* _infolist_: lista info da scrivere nel file Valore restituito: @@ -16235,7 +16236,7 @@ int weechat_upgrade_read (struct t_upgrade_file *upgrade_file); Argomenti: -* 'upgrade_file': puntatore al file di aggiornamento +* _upgrade_file_: puntatore al file di aggiornamento Valore restituito: @@ -16272,7 +16273,7 @@ void weechat_upgrade_close (struct t_upgrade_file *upgrade_file); Argomenti: -* 'upgrade_file': puntatore al file di aggiornamento +* _upgrade_file_: puntatore al file di aggiornamento Esempio in C: diff --git a/doc/ja/weechat_plugin_api.ja.asciidoc b/doc/ja/weechat_plugin_api.ja.asciidoc index c2f30c79b..38650eb37 100644 --- a/doc/ja/weechat_plugin_api.ja.asciidoc +++ b/doc/ja/weechat_plugin_api.ja.asciidoc @@ -6,7 +6,7 @@ :toclevels: 4 :toc-title: 目次 :sectnums: -:sectnumlevels: 2 +:sectnumlevels: 3 :docinfo1: @@ -89,21 +89,21 @@ int weechat_plugin_init (struct t_weechat_plugin *plugin, 引数: -* 'plugin': WeeChat プラグイン構造体へのポインタ -* 'argc': プラグインに対する引数の数 (ユーザがコマンドラインで指定) -* 'argv': プラグインに対する引数 +* _plugin_: WeeChat プラグイン構造体へのポインタ +* _argc_: プラグインに対する引数の数 (ユーザがコマンドラインで指定) +* _argv_: プラグインに対する引数 戻り値: -* 'WEECHAT_RC_OK' 成功した場合 (プラグインを読み込みます) -* 'WEECHAT_RC_ERROR' エラーが起きた場合 (プラグインを読み込みません) +* _WEECHAT_RC_OK_ 成功した場合 (プラグインを読み込みます) +* _WEECHAT_RC_ERROR_ エラーが起きた場合 (プラグインを読み込みません) [[plugin_priority]] ===== プラグインの優先度 複数のプラグインが自動ロードされた場合 (たとえば起動時)、WeeChat -はまず全てのプラグインをロードし、各プラグインで定義された優先度に従って 'init' -関数を呼び出します。優先度を大きな値にすれば 'init' 関数を呼び出す順番が早くなります +はまず全てのプラグインをロードし、各プラグインで定義された優先度に従って _init_ +関数を呼び出します。優先度を大きな値にすれば _init_ 関数を呼び出す順番が早くなります デフォルトの優先度は 1000 です (この値を設定した場合、全てのデフォルトプラグインの後にプラグインをロードします)。 @@ -125,17 +125,17 @@ int weechat_plugin_end (struct t_weechat_plugin *plugin); 引数: -* 'plugin': WeeChat プラグイン構造体へのポインタ +* _plugin_: WeeChat プラグイン構造体へのポインタ 戻り値: -* 'WEECHAT_RC_OK' 成功した場合 -* 'WEECHAT_RC_ERROR' エラーが起きた場合 +* _WEECHAT_RC_OK_ 成功した場合 +* _WEECHAT_RC_ERROR_ エラーが起きた場合 [[compile_plugin]] === プラグインのコンパイル -コンパイルするために WeeChat のソースは不要で、'weechat-plugin.h' +コンパイルするために WeeChat のソースは不要で、_weechat-plugin.h_ ファイルだけが必要です。 1 つのファイル "toto.c" からなるプラグインは以下のようにコンパイルします (GNU/Linux の場合): @@ -148,9 +148,9 @@ $ gcc -shared -fPIC -o libtoto.so toto.o [[load_plugin]] === プラグインを読み込む -'libtoto.so' ファイルをシステムのプラグインディレクトリ (例えば -'/usr/local/lib/weechat/plugins') またはユーザのプラグインディレクトリ (例えば -'/home/xxx/.weechat/plugins') にコピーしてください。 +_libtoto.so_ ファイルをシステムのプラグインディレクトリ (例えば +_/usr/local/lib/weechat/plugins_) またはユーザのプラグインディレクトリ (例えば +_/home/xxx/.weechat/plugins_) にコピーしてください。 WeeChat の中で: @@ -161,7 +161,7 @@ WeeChat の中で: [[plugin_example]] === プラグインの例 -コマンド '/double' を追加するプラグインの例: 引数を 2 +コマンド _/double_ を追加するプラグインの例: 引数を 2 倍して現在のバッファに表示するか、コマンドを 2 回実行する (これは実用的なコマンドというよりも、ただの例です!): @@ -261,7 +261,7 @@ const char *weechat_plugin_get_name (struct t_weechat_plugin *plugin); 引数: -* 'plugin': WeeChat プラグイン構造体へのポインタ (NULL でも可) +* _plugin_: WeeChat プラグイン構造体へのポインタ (NULL でも可) 戻り値: @@ -295,8 +295,8 @@ UTF-8 とロケールに準じて取り扱うようになっているからで ==== charset_set -新しいプラグインの文字セットを設定する (デフォルトの文字セットは 'UTF-8' -です、このためプラグインで 'UTF-8' を使う場合は、この関数を呼び出す必要はありません。 +新しいプラグインの文字セットを設定する (デフォルトの文字セットは _UTF-8_ +です、このためプラグインで _UTF-8_ を使う場合は、この関数を呼び出す必要はありません。 プロトタイプ: @@ -307,7 +307,7 @@ void weechat_charset_set (const char *charset); 引数: -* 'charset': 新たに利用する文字セット +* _charset_: 新たに利用する文字セット C 言語での使用例: @@ -340,8 +340,8 @@ char *weechat_iconv_to_internal (const char *charset, const char *string); 引数: -* 'charset': 変換元の文字列の文字セット -* 'string': 変換元の文字列 +* _charset_: 変換元の文字列の文字セット +* _string_: 変換元の文字列 戻り値: @@ -380,8 +380,8 @@ char *weechat_iconv_from_internal (const char *charset, const char *string); 引数: -* 'charset': 変換先の文字列の文字セット -* 'string': 変換元の文字列 +* _charset_: 変換先の文字列の文字セット +* _string_: 変換元の文字列 戻り値: @@ -420,7 +420,7 @@ const char *weechat_gettext (const char *string); 引数: -* 'string': 翻訳元の文字列 +* _string_: 翻訳元の文字列 戻り値: @@ -446,7 +446,7 @@ str = weechat.gettext("hello") ==== ngettext -'count' +_count_ 引数を元に単数形または複数形で、翻訳済み文字列を返す。 プロトタイプ: @@ -459,9 +459,9 @@ const char *weechat_ngettext (const char *string, const char *plural, 引数: -* 'string': 翻訳元の文字列、単数形 -* 'plural': 翻訳元の文字列、複数形 -* 'count': 単数形と複数形のどちらを返すかの判断に使います +* _string_: 翻訳元の文字列、単数形 +* _plural_: 翻訳元の文字列、複数形 +* _count_: 単数形と複数形のどちらを返すかの判断に使います (選択は設定言語に依存) 戻り値: @@ -489,7 +489,7 @@ str = weechat.ngettext("file", "files", num_files) ==== strndup -複製した文字列を最大で 'length' 文字分返す。 +複製した文字列を最大で _length_ 文字分返す。 プロトタイプ: @@ -500,8 +500,8 @@ char *weechat_strndup (const char *string, int length); 引数: -* 'string': 複製元の文字列 -* 'length': 複製する文字列の最大文字数 +* _string_: 複製元の文字列 +* _length_: 複製する文字列の最大文字数 戻り値: @@ -532,7 +532,7 @@ void weechat_string_tolower (char *string); 引数: -* 'string': 変換元の文字列 +* _string_: 変換元の文字列 C 言語での使用例: @@ -558,7 +558,7 @@ void weechat_string_toupper (char *string); 引数: -* 'string': 変換元の文字列 +* _string_: 変換元の文字列 C 言語での使用例: @@ -586,8 +586,8 @@ int weechat_strcasecmp (const char *string1, const char *string2); 引数: -* 'string1': 1 番目の比較対象の文字列 -* 'string2': 2 番目の比較対象の文字列 +* _string1_: 1 番目の比較対象の文字列 +* _string2_: 2 番目の比較対象の文字列 戻り値: @@ -620,12 +620,12 @@ int weechat_strcasecmp_range (const char *string1, const char *string2, int rang 引数: -* 'string1': 1 番目の比較対象の文字列 -* 'string2': 2 番目の比較対象の文字列 -* 'range': 大文字小文字を無視する文字範囲の幅、例: -** 26: "A-Z" を "a-z" のように変換して比較 -** 29: "A-Z [ \ ]" を "a-z { | }" のように変換して比較 -** 30: "A-Z [ \ ] ^" を "a-z { | } ~" のように変換して比較 +* _string1_: 1 番目の比較対象の文字列 +* _string2_: 2 番目の比較対象の文字列 +* _range_: 大文字小文字を無視する文字範囲の幅、例: +** 26: `A-Z` を `a-z` のように変換して比較 +** 29: `A-Z [ \ ]` を `a-z { | }` のように変換して比較 +** 30: `A-Z [ \ ] ^` を `a-z { | } ~` のように変換して比較 [NOTE] 29 と 30 は IRC など一部のプロトコルで使います。 @@ -650,7 +650,7 @@ int diff = weechat_strcasecmp_range ("nick{away}", "NICK[away]", 29); /* == 0 * _WeeChat バージョン 1.0 で更新。_ -ロケールと大文字小文字を無視して 'max' 文字だけ文字列を比較。 +ロケールと大文字小文字を無視して _max_ 文字だけ文字列を比較。 プロトタイプ: @@ -661,9 +661,9 @@ int weechat_strncasecmp (const char *string1, const char *string2, int max); 引数: -* 'string1': 1 番目の比較対象の文字列 -* 'string2': 2 番目の比較対象の文字列 -* 'max': 比較する文字数の最大値 +* _string1_: 1 番目の比較対象の文字列 +* _string2_: 2 番目の比較対象の文字列 +* _max_: 比較する文字数の最大値 戻り値: @@ -686,7 +686,7 @@ int diff = weechat_strncasecmp ("aabb", "aacc", 2); /* == 0 */ _WeeChat バージョン 0.3.7 以上で利用可、バージョン 1.0 で更新。_ 大文字小文字を無視する文字範囲の幅を使い、ロケールと大文字小文字を無視して -'max' 文字だけ文字列を比較。 +_max_ 文字だけ文字列を比較。 プロトタイプ: @@ -697,13 +697,13 @@ int weechat_strncasecmp_range (const char *string1, const char *string2, int max 引数: -* 'string1': 1 番目の比較対象の文字列 -* 'string2': 2 番目の比較対象の文字列 -* 'max': 比較する文字数の最大値 -* 'range': 大文字小文字を無視する文字範囲の幅、例: -** 26: "A-Z" を "a-z" のように変換して比較 -** 29: "A-Z [ \ ]" を "a-z { | }" のように変換して比較 -** 30: "A-Z [ \ ] ^" を "a-z { | } ~" のように変換して比較 +* _string1_: 1 番目の比較対象の文字列 +* _string2_: 2 番目の比較対象の文字列 +* _max_: 比較する文字数の最大値 +* _range_: 大文字小文字を無視する文字範囲の幅、例: +** 26: `A-Z` を `a-z` のように変換して比較 +** 29: `A-Z [ \ ]` を `a-z { | }` のように変換して比較 +** 30: `A-Z [ \ ] ^` を `a-z { | } ~` のように変換して比較 [NOTE] 29 と 30 は IRC など一部のプロトコルで使います。 @@ -742,10 +742,10 @@ int weechat_strcmp_ignore_chars (const char *string1, const char *string2, 引数: -* 'string1': 1 番目の比較対象の文字列 -* 'string2': 2 番目の比較対象の文字列 -* 'chars_ignored': 無視する文字 -* 'case_sensitive': 大文字小文字を区別して比較する場合は 1、区別しない場合は 0 +* _string1_: 1 番目の比較対象の文字列 +* _string2_: 2 番目の比較対象の文字列 +* _chars_ignored_: 無視する文字 +* _case_sensitive_: 大文字小文字を区別して比較する場合は 1、区別しない場合は 0 戻り値: @@ -778,13 +778,13 @@ const char *weechat_strcasestr (const char *string, const char *search); 引数: -* 'string': 文字列 -* 'search': 'string' 内を検索する文字 +* _string_: 文字列 +* _search_: _string_ 内を検索する文字 戻り値: * 見つかった文字列へのポインタ、見つからない場合は NULL - (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは 'const char *' であり、'char *' ではありません) + (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは _const char *_ であり、_char *_ ではありません) C 言語での使用例: @@ -813,7 +813,7 @@ int weechat_strlen_screen (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -853,10 +853,10 @@ int weechat_string_match (const char *string, const char *mask, 引数: -* 'string': 文字列 -* 'mask': ワイルドカード ("*") を含むマスク、各ワイルドカードは文字列中の +* _string_: 文字列 +* _mask_: ワイルドカード (`+*+`) を含むマスク、各ワイルドカードは文字列中の 0 個またはそれ以上の文字にマッチします -* 'case_sensitive': 大文字小文字を区別する場合は 1、区別しない場合は 0 +* _case_sensitive_: 大文字小文字を区別する場合は 1、区別しない場合は 0 [NOTE] WeeChat バージョン 1.0 以上の場合、ワイルドカードをマスクの内部で使うことが可能です @@ -896,8 +896,8 @@ match5 = weechat.string_match("abcdef", "*b*d*", 0) # 1 _WeeChat バージョン 0.3.3 以上で利用可。_ -文字列が `~` から始まる場合はこれをホームディレクトリで置換。文字列が -`~` から始まっていない場合は同じ文字列を返す。 +文字列が `+~+` から始まる場合はこれをホームディレクトリで置換。文字列が +`+~+` から始まっていない場合は同じ文字列を返す。 プロトタイプ: @@ -908,11 +908,11 @@ char *weechat_string_expand_home (const char *path); 引数: -* 'path': パス +* _path_: パス 戻り値: -* `~` から始まるパスをホームディレクトリで置換したパス +* `+~+` から始まるパスをホームディレクトリで置換したパス (使用後には必ず "free" を呼び出して領域を開放してください) C 言語での使用例: @@ -935,7 +935,7 @@ _WeeChat バージョン 0.3.3 以上で利用可。_ 3 段階でパスを評価します: . 先頭の `%h` を WeeChat ホームディレクトリで置換し、 -. 先頭の `~` をユーザのホームディレクトリで置換し +. 先頭の `+~+` をユーザのホームディレクトリで置換し (<<_string_expand_home,weechat_string_expand_home>> を実行し)、 . 変数を評価します (<<_string_eval_expression,weechat_string_eval_expression>> を参照してください)。 @@ -952,12 +952,12 @@ char *weechat_string_eval_path_home (const char *path, 引数: -* 'path': パス -* 'pointers': 関数に渡されるハッシュテーブル +* _path_: パス +* _pointers_: 関数に渡されるハッシュテーブル <<_string_eval_expression,weechat_string_eval_expression>> -* 'extra_vars': 関数に渡されるハッシュテーブル +* _extra_vars_: 関数に渡されるハッシュテーブル <<_string_eval_expression,weechat_string_eval_expression>> -* 'options': 関数に渡されるハッシュテーブル +* _options_: 関数に渡されるハッシュテーブル <<_string_eval_expression,weechat_string_eval_expression>> 戻り値: @@ -1000,8 +1000,8 @@ char *weechat_string_remove_quotes (const char *string, const char *quotes); 引数: -* 'string': 文字列 -* 'quotes': 引用符号のリストを含む文字列 +* _string_: 文字列 +* _quotes_: 引用符号のリストを含む文字列 戻り値: @@ -1035,10 +1035,10 @@ char *weechat_string_strip (const char *string, int left, int right, 引数: -* 'string': 文字列 -* 'left': 0 以外の場合は左側の文字を削除 -* 'right': 0 以外の場合は右側の文字を削除 -* 'chars': 削除する文字を含む文字列 +* _string_: 文字列 +* _left_: 0 以外の場合は左側の文字を削除 +* _right_: 0 以外の場合は右側の文字を削除 +* _chars_: 削除する文字を含む文字列 戻り値: @@ -1062,20 +1062,20 @@ _WeeChat バージョン 1.0 以上で利用可。_ エスケープ文字を値に変換: -* `\"`: 二重引用符 -* `\\`: バックスラッシュ -* `\a`: アラート (BEL) -* `\b`: バックスペース -* `\e`: エスケープ -* `\f`: 改ページ -* `\n`: 改行 -* `\r`: キャリッジリターン -* `\t`: 水平タブ -* `\v`: 垂直タブ -* `\0ooo`: 文字の 8 進数表現 (ooo は 0 桁から 3 桁) -* `\xhh`: 文字の 16 進数表現 (hh は 1 桁から 2 桁) -* `\uhhhh`: ユニコード文字の 16 進数表現 (hhhh は 1 桁から 4 桁) -* `\Uhhhhhhhh`: ユニコード文字の 16 進数表現 (hhhhhhhh は 1 桁から 8 桁) +* `+\"+`: 二重引用符 +* `+\\+`: バックスラッシュ +* `+\a+`: アラート (BEL) +* `+\b+`: バックスペース +* `+\e+`: エスケープ +* `+\f+`: 改ページ +* `+\n+`: 改行 +* `+\r+`: キャリッジリターン +* `+\t+`: 水平タブ +* `+\v+`: 垂直タブ +* `+\0ooo+`: 文字の 8 進数表現 (`ooo` は 0 桁から 3 桁) +* `+\xhh+`: 文字の 16 進数表現 (`hh` は 1 桁から 2 桁) +* `+\uhhhh+`: ユニコード文字の 16 進数表現 (`hhhh` は 1 桁から 4 桁) +* `+\Uhhhhhhhh+`: ユニコード文字の 16 進数表現 (`hhhhhhhh` は 1 桁から 8 桁) プロトタイプ: @@ -1086,7 +1086,7 @@ char *weechat_string_convert_escaped_chars (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -1109,7 +1109,7 @@ free (str); ==== string_mask_to_regex マスクから正規表現を作りこれを返す、マスク用の特殊文字は -"`*`" のみ。これ以外の文字はすべてエスケープされます。 +`+*+` のみ。これ以外の文字はすべてエスケープされます。 プロトタイプ: @@ -1120,7 +1120,7 @@ char *weechat_string_mask_to_regex (const char *mask); 引数: -* 'mask': マスク +* _mask_: マスク 戻り値: @@ -1162,13 +1162,13 @@ const char *weechat_string_regex_flags (const char *regex, int default_flags, in 引数: -* 'regex': POSIX 拡張正規表現 -* 'default_flags': 以下の値を組み合わせたもの (`man regcomp` を参照): +* _regex_: POSIX 拡張正規表現 +* _default_flags_: 以下の値を組み合わせたもの (`man regcomp` を参照): ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE ** REG_NOSUB -* 'flags': ポインタ値は正規表現中で指定されたフラグと一緒にセットされます +* _flags_: ポインタ値は正規表現中で指定されたフラグと一緒にセットされます (デフォルトのフラグ + 正規表現中で指定されたフラグ) フラグは必ず正規表現の最初につけてください。書式: @@ -1176,14 +1176,14 @@ const char *weechat_string_regex_flags (const char *regex, int default_flags, in 利用可能なフラグ: -* 'e': POSIX 拡張正規表現 ('REG_EXTENDED') -* 'i': 大文字小文字を区別しない ('REG_ICASE') -* 'n': 任意の文字にマッチする演算子を改行文字にマッチさせない ('REG_NEWLINE') -* 's': マッチした部分文字列の位置を使わない ('REG_NOSUB') +* _e_: POSIX 拡張正規表現 (_REG_EXTENDED_) +* _i_: 大文字小文字を区別しない (_REG_ICASE_) +* _n_: 任意の文字にマッチする演算子を改行文字にマッチさせない (_REG_NEWLINE_) +* _s_: マッチした部分文字列の位置を使わない (_REG_NOSUB_) 戻り値: -* 'regex' からフラグを除いた位置へのポインタ +* _regex_ からフラグを除いた位置へのポインタ C 言語での使用例: @@ -1215,9 +1215,9 @@ int weechat_string_regcomp (void *preg, const char *regex, int default_flags) 引数: -* 'preg': 'regex_t' 構造体へのポインタ -* 'regex': POSIX 拡張正規表現 -* 'default_flags': 以下の値の組み合わせ (`man regcomp` を参照): +* _preg_: _regex_t_ 構造体へのポインタ +* _regex_: POSIX 拡張正規表現 +* _default_flags_: 以下の値の組み合わせ (`man regcomp` を参照): ** REG_EXTENDED ** REG_ICASE ** REG_NEWLINE @@ -1256,8 +1256,8 @@ int weechat_string_has_highlight (const char *string, 引数: -* 'string': 文字列 -* 'highlight_words': ハイライトしたい単語のリスト、コンマ区切り +* _string_: 文字列 +* _highlight_words_: ハイライトしたい単語のリスト、コンマ区切り 戻り値: @@ -1288,7 +1288,7 @@ _WeeChat バージョン 0.3.4 以上で利用可。_ POSIX 拡張正規表現を使って、文字列中から正規表現にマッチする部分が 1 つ以上あるか確認。 + 文字列を正規表現にマッチさせるには、マッチする部分の前後に区切り文字 -(アルファベット、"-"、"_"、"|" 以外) がなければいけません。 +(アルファベット、`+-+`、`+_+`、`+|+` 以外) がなければいけません。 プロトタイプ: @@ -1299,8 +1299,8 @@ int weechat_string_has_highlight_regex (const char *string, const char *regex); 引数: -* 'string': 文字列 -* 'regex': POSIX 拡張正規表現 +* _string_: 文字列 +* _regex_: POSIX 拡張正規表現 戻り値: @@ -1338,13 +1338,13 @@ char *weechat_string_replace (const char *string, const char *search, 引数: -* 'string': 文字列 -* 'search': マッチさせる文字列 -* 'replace': 'search' を置き換える文字列 +* _string_: 文字列 +* _search_: マッチさせる文字列 +* _replace_: _search_ を置き換える文字列 戻り値: -* 'search' を 'replace' で置き換えた文字列 +* _search_ を _replace_ で置き換えた文字列 (使用後には必ず "free" を呼び出して領域を開放してください) C 言語での使用例: @@ -1377,24 +1377,24 @@ char *weechat_string_replace_regex (const char *string, void *regex, 引数: -* 'string': 文字列 -* 'regex': WeeChat 関数 <<_string_regcomp,weechat_string_regcomp>> +* _string_: 文字列 +* _regex_: WeeChat 関数 <<_string_regcomp,weechat_string_regcomp>> または regcomp (`man regcomp` を参照) - でコンパイルした正規表現へのポインタ ('regex_t' 構造体) -* 'replace': 置換先テキスト、以下のリファレンスを使うことができます: -** `$0` から `$99`: 正規表現中の 0 から 99 番目のマッチ部分 (0 + でコンパイルした正規表現へのポインタ (_regex_t_ 構造体) +* _replace_: 置換先テキスト、以下のリファレンスを使うことができます: +** `+$0+` から `+$99+`: 正規表現中の 0 から 99 番目のマッチ部分 (0 はマッチする部分全体、1 から 99 は括弧で括られたグループ) -** `$+`: 最後にマッチした部分 (最大の番号を持つマッチ部分) -** `$.*N`: `*` で全ての文字を置換した `N` 番目 (`+` または `0` から `99` を使うことができます) - のマッチ部分 (`*` 文字は空白 (32) から `~` (126) までの任意の文字を使うことができます) -* 'reference_char': マッチ部分を参照するための文字 (通常は '$') -* 'callback': 'replace' に含まれる各リファレンスに対して呼び出される任意指定可能なコールバック関数 +** `+$++`: 最後にマッチした部分 (最大の番号を持つマッチ部分) +** `+$.*N+`: `+*+` で全ての文字を置換した `+N+` 番目 (`+++` または `+0+` から `+99+` を使うことができます) + のマッチ部分 (`+*+` 文字は空白 (32) から `+~+` (126) までの任意の文字を使うことができます) +* _reference_char_: マッチ部分を参照するための文字 (通常は `+$+`) +* _callback_: _replace_ に含まれる各リファレンスに対して呼び出される任意指定可能なコールバック関数 (マッチ部分を文字で置換する場合を除く); このコールバックは必ず以下の値を返してください: ** 新しく割り当てられた文字列: 文字列を置換先テキストとして使います (文字列は使用後に開放されます) ** NULL: コールバックに渡されたテキストを置換先テキストとして使います (文字列に変更を加えません) -* 'callback_data': 'callback' コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: _callback_ コールバックを呼び出す際にコールバックに渡すポインタ 戻り値: @@ -1437,15 +1437,15 @@ char **weechat_string_split (const char *string, const char *separators, 引数: -* 'string': 分割する文字列 -* 'separators': 分割に使う区切り文字 -* 'keep_eol': +* _string_: 分割する文字列 +* _separators_: 分割に使う区切り文字 +* _keep_eol_: ** 0: 区切り文字ごとの文字列に分割 ** 1: 文字列の最初から区切り文字までの文字列に分割 (下の例を参照) ** 2: 1 と同じだが、文字列の最後から区切り文字を削除しない _(WeeChat バージョン 0.3.6 以上で利用可)_ -* 'num_items_max': 分割回数の上限 (0 = 制限なし) -* 'num_items': 分割回数を返す整数型変数へのポインタ +* _num_items_max_: 分割回数の上限 (0 = 制限なし) +* _num_items_: 分割回数を返す整数型変数へのポインタ 戻り値: @@ -1507,8 +1507,8 @@ char **weechat_string_split_shell (const char *string, int *num_items); 引数: -* 'string': 分割する文字列 -* 'num_items': 分割回数を返す整数型変数へのポインタ +* _string_: 分割する文字列 +* _num_items_: 分割回数を返す整数型変数へのポインタ 戻り値: @@ -1547,7 +1547,7 @@ void weechat_string_free_split (char **split_string); 引数: -* 'split_string': 関数 <<_string_split,weechat_string_split>> +* _split_string_: 関数 <<_string_split,weechat_string_split>> が返した分割文字列の配列 C 言語での使用例: @@ -1578,9 +1578,9 @@ char *weechat_string_build_with_split_string (char **split_string, 引数: -* 'split_string': 関数 <<_string_split,weechat_string_split>> +* _split_string_: 関数 <<_string_split,weechat_string_split>> が返した分割文字列の配列 -* 'separator': 文字列を分割する区切り文字 +* _separator_: 文字列を分割する区切り文字 戻り値: @@ -1604,8 +1604,8 @@ free (str); ==== string_split_command -'separator' でコマンドのリストを分割 -(コマンドに区切り文字を使う場合は "\" でエスケープ)。 +_separator_ でコマンドのリストを分割 +(コマンドに区切り文字を使う場合は `+\+` でエスケープ)。 プロトタイプ: @@ -1616,8 +1616,8 @@ char **weechat_string_split_command (const char *command, char separator); 引数: -* 'command': 分割するコマンド -* 'separator': 区切り文字 +* _command_: 分割するコマンド +* _separator_: 区切り文字 戻り値: @@ -1652,7 +1652,7 @@ void weechat_string_free_split_command (char **split_command); 引数: -* 'split_command': 関数 <<_string_split_command,weechat_string_split_command>> +* _split_command_: 関数 <<_string_split_command,weechat_string_split_command>> が返す分割コマンドの配列 C 言語での使用例: @@ -1680,7 +1680,7 @@ char *weechat_string_format_size (unsigned long long size); 引数: -* 'size': サイズ (バイト単位) +* _size_: サイズ (バイト単位) 戻り値: @@ -1730,8 +1730,8 @@ char *weechat_string_remove_color (const char *string, 引数: -* 'string': 文字列 -* 'replacement': NULL または空文字列でなければ、WeeChat +* _string_: 文字列 +* _replacement_: NULL または空文字列でなければ、WeeChat 色コードを指定した文字列の 1 文字目で置換、そうでなければ WeeChat 色コードとそれに続く (色に関連する) 文字を文字列から削除 @@ -1780,9 +1780,9 @@ void weechat_string_encode_base64 (const char *from, int length, char *to); 引数: -* 'from': エンコード元文字列 -* 'length': エンコードする文字列の長さ (例えば `strlen(from)`) -* 'to': エンコード結果を保存する文字列へのポインタ +* _from_: エンコード元文字列 +* _length_: エンコードする文字列の長さ (例えば `strlen(from)`) +* _to_: エンコード結果を保存する文字列へのポインタ (十分な領域を確保してください、結果はエンコード元文字列よりも長くなります) C 言語での使用例: @@ -1812,13 +1812,13 @@ int weechat_string_decode_base64 (const char *from, char *to); 引数: -* 'from': デコード元文字列 -* 'to': デコード結果を保存する文字列へのポインタ +* _from_: デコード元文字列 +* _to_: デコード結果を保存する文字列へのポインタ (十分な領域を確保してください、結果はデコード元文字列よりも短くなります) 戻り値: -* *to に保存された文字列の長さ (最後の '\0' は数えません) +* _*to_ に保存された文字列の長さ (最後の _\0_ は数えません) C 言語での使用例: @@ -1849,12 +1849,12 @@ char *string_hex_dump (const char *data, int data_size, int bytes_per_line, 引数: -* 'data': ダンプ対象のデータ -* 'data_size': 'data' からダンプ対象にするバイト数 -* 'bytes_per_line': 各行に表示するバイト数 -* 'prefix': 各行の先頭に表示するプレフィックス +* _data_: ダンプ対象のデータ +* _data_size_: _data_ からダンプ対象にするバイト数 +* _bytes_per_line_: 各行に表示するバイト数 +* _prefix_: 各行の先頭に表示するプレフィックス (任意、NULL も可) -* 'suffix': 各行の末尾に表示するサフィックス +* _suffix_: 各行の末尾に表示するサフィックス (任意、NULL も可) 戻り値: @@ -1878,7 +1878,7 @@ char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL); _WeeChat バージョン 0.3.2 以上で利用可。_ -文字列の 1 文字目がコマンド文字か確認 (デフォルトのコマンド文字は '/')。 +文字列の 1 文字目がコマンド文字か確認 (デフォルトのコマンド文字は `+/+`)。 プロトタイプ: @@ -1889,7 +1889,7 @@ int weechat_string_is_command_char (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -1931,7 +1931,7 @@ const char *weechat_string_input_for_buffer (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -1982,28 +1982,28 @@ char *weechat_string_eval_expression (const char *expr, 引数: -* 'expr': 評価する式 (以下の表を参照) -* 'pointers': ポインタを含むハッシュテーブル (キーは文字列、値はポインタ); +* _expr_: 評価する式 (以下の表を参照) +* _pointers_: ポインタを含むハッシュテーブル (キーは文字列、値はポインタ); (現在のウィンドウやバッファへのポインタを持つ) ハッシュテーブルが "window" と "buffer" ポインタを持たない場合はこれらは自動的に追加される (NULL でも可): -** 'regex': WeeChat 関数 <<_string_regcomp,weechat_string_regcomp>> +** _regex_: WeeChat 関数 <<_string_regcomp,weechat_string_regcomp>> または regcomp (`man regcomp` を参照) でコンパイル済みの正規表現へのポインタ - ('regex_t' 構造体); このオプションは (以下の) ハッシュテーブル構造体 'options' - メンバの 'regex' とよく似ていますが、より高速に動作します -* 'extra_vars': 展開される追加変数 (NULL でも可) -* 'options': いくつかのオプションを含むハッシュテーブル (キーと値は必ず文字列) + (_regex_t_ 構造体); このオプションは (以下の) ハッシュテーブル構造体 _options_ + メンバの _regex_ とよく似ていますが、より高速に動作します +* _extra_vars_: 展開される追加変数 (NULL でも可) +* _options_: いくつかのオプションを含むハッシュテーブル (キーと値は必ず文字列) (NULL でも可): -** 'type': +** _type_: デフォルトの挙動では式中の変数をその値で置換するだけです、その他に以下のタイプを使うことができます: -*** 'condition': 条件式として式を評価します: +*** _condition_: 条件式として式を評価します: 演算子と括弧が使われます、結果はブール値 ("0" または "1") です -** 'prefix': 置換する変数のプレフィックス (デフォルト: "${") -** 'suffix': 置換する変数のサフィックス (デフォルト: "}") -** 'regex': 'expr' のテキストを置換する正規表現 - (この場合 'expr' は評価されません) -** 'regex_replace': 'regex' と一緒に使われる置換テキスト、'expr' - に含まれるテキストを置換する ('regex_replace' は、'expr' 内で - 'regex' 引数にマッチする部分が見つからなくなるまで、毎回評価されます) +** _prefix_: 置換する変数のプレフィックス (デフォルト: `+${+`) +** _suffix_: 置換する変数のサフィックス (デフォルト: `+}+`) +** _regex_: _expr_ のテキストを置換する正規表現 + (この場合 _expr_ は評価されません) +** _regex_replace_: _regex_ と一緒に使われる置換テキスト、_expr_ + に含まれるテキストを置換する (_regex_replace_ は、_expr_ 内で + _regex_ 引数にマッチする部分が見つからなくなるまで、毎回評価されます) 戻り値: @@ -2017,7 +2017,7 @@ char *weechat_string_eval_expression (const char *expr, |=== | 書式 | 説明 | 例 | 結果 -| `${name}` | 'extra_vars' の変数 `name` の値に展開 | +| `${name}` | _extra_vars_ の変数 `name` の値に展開 | `${name}` | `value` | `${eval:xxx}` + @@ -2040,8 +2040,8 @@ char *weechat_string_eval_expression (const char *expr, `********` | `${re:N}` | - 正規表現のキャプチャグループ: 0 = マッチするすべての文字列、1 から 99 = - キャプチャされたグループ、`+` = 最後にキャプチャされたグループ | + 正規表現のキャプチャグループ: `0` = マッチするすべての文字列、`1` から `99` = + キャプチャされたグループ、`+++` = 最後にキャプチャされたグループ | `${re:1}` | `test` @@ -2186,7 +2186,7 @@ int weechat_utf8_has_8bits (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -2220,10 +2220,10 @@ int weechat_utf8_is_valid (const char *string, int length, char **error); 引数: -* 'string': 文字列 -* 'length': 確認する UTF-8 文字の最大文字数; これを 0 以下に設定した場合、文字列中のすべての文字を確認します +* _string_: 文字列 +* _length_: 確認する UTF-8 文字の最大文字数; これを 0 以下に設定した場合、文字列中のすべての文字を確認します _(WeeChat バージョン 1.4 以上で利用可)_ -* 'error': NULL でない場合は '*error' +* _error_: NULL でない場合は _*error_ は文字列に含まれる最初の妥当でない UTF-8 文字へのポインタ 戻り値: @@ -2261,8 +2261,8 @@ void weechat_utf8_normalize (char *string, char replacement); 引数: -* 'string': 文字列 -* 'replacement': 非 UTF-8 文字を置き換える文字 +* _string_: 文字列 +* _replacement_: 非 UTF-8 文字を置き換える文字 C 言語での使用例: @@ -2290,14 +2290,14 @@ const char *weechat_utf8_prev_char (const char *string_start, 引数: -* 'string_start': 文字列の開始位置へのポインタ +* _string_start_: 文字列の開始位置へのポインタ (関数はこのポインタよりも前の文字を返しません) -* 'string': 文字列へのポインタ (必ず 'string_start' 以上の値) +* _string_: 文字列へのポインタ (必ず _string_start_ 以上の値) 戻り値: * 1 つ前の UTF-8 文字へのポインタ、見つからなければ (文字列の開始位置に到達した場合は) NULL - (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは 'const char *' であり、'char *' ではありません) + (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは _const char *_ であり、_char *_ ではありません) C 言語での使用例: @@ -2324,12 +2324,12 @@ const char *weechat_utf8_next_char (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: * 1 つ後の UTF-8 文字へのポインタ、見つからなければ (文字列の最後に到達した場合は) NULL - (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは 'const char *' であり、'char *' ではありません) + (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは _const char *_ であり、_char *_ ではありません) C 言語での使用例: @@ -2354,7 +2354,7 @@ int weechat_utf8_char_int (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -2383,7 +2383,7 @@ int weechat_utf8_char_size (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -2412,7 +2412,7 @@ int weechat_utf8_strlen (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -2430,7 +2430,7 @@ int length = weechat_utf8_strlen ("chêne"); /* == 5 */ ==== utf8_strnlen -文字列の 'bytes' バイト目までに含まれる UTF-8 文字列の長さを返す (UTF-8 文字の個数)。 +文字列の _bytes_ バイト目までに含まれる UTF-8 文字列の長さを返す (UTF-8 文字の個数)。 プロトタイプ: @@ -2441,8 +2441,8 @@ int weechat_utf8_strnlen (const char *string, int bytes); 引数: -* 'string': 文字列 -* 'bytes': バイト数の上限 +* _string_: 文字列 +* _bytes_: バイト数の上限 戻り値: @@ -2471,7 +2471,7 @@ int weechat_utf8_strlen_screen (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -2502,8 +2502,8 @@ int weechat_utf8_charcmp (const char *string1, const char *string2); 引数: -* 'string1': 1 番目の比較文字列 -* 'string2': 2 番目の比較文字列 +* _string1_: 1 番目の比較文字列 +* _string2_: 2 番目の比較文字列 戻り値: @@ -2536,8 +2536,8 @@ int weechat_utf8_charcasecmp (const char *string1, const char *string2); 引数: -* 'string1': 1 番目の比較文字列 -* 'string2': 2 番目の比較文字列 +* _string1_: 1 番目の比較文字列 +* _string2_: 2 番目の比較文字列 戻り値: @@ -2568,7 +2568,7 @@ int weechat_utf8_char_size_screen (const char *string); 引数: -* 'string': 文字列 +* _string_: 文字列 戻り値: @@ -2599,13 +2599,13 @@ const char *weechat_utf8_add_offset (const char *string, int offset); 引数: -* 'string': 文字列 -* 'offset': 文字数 +* _string_: 文字列 +* _offset_: 文字数 戻り値: * 文字列の N 文字後に進んだ位置へのポインタ (元文字列の最後より後の位置を指す場合は NULL) - (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは 'const char *' であり、'char *' ではありません) + (_WeeChat バージョン 1.3 以上の場合_: 返されるポインタは _const char *_ であり、_char *_ ではありません) C 言語での使用例: @@ -2631,8 +2631,8 @@ int weechat_utf8_real_pos (const char *string, int pos); 引数: -* 'string': 文字列 -* 'pos': 位置 (文字目) +* _string_: 文字列 +* _pos_: 位置 (文字目) 戻り値: @@ -2661,8 +2661,8 @@ int weechat_utf8_pos (const char *string, int real_pos); 引数: -* 'string': 文字列 -* 'real_pos': 真の位置 (バイト単位) +* _string_: 文字列 +* _real_pos_: 真の位置 (バイト単位) 戻り値: @@ -2680,7 +2680,7 @@ int pos = weechat_utf8_pos ("chêne", 4); /* == 3 */ ==== utf8_strndup -最長 'length' 文字の複製された文字列を返す。 +最長 _length_ 文字の複製された文字列を返す。 プロトタイプ: @@ -2691,8 +2691,8 @@ char *weechat_utf8_strndup (const char *string, int length); 引数: -* 'string': 文字列 -* 'length': 複製する文字数の最大値 +* _string_: 文字列 +* _length_: 複製する文字数の最大値 戻り値: @@ -2728,8 +2728,8 @@ int weechat_mkdir_home (char *directory, int mode); 引数: -* 'directory': 作成するディレクトリの名前 -* 'mode': ディレクトリのモード +* _directory_: 作成するディレクトリの名前 +* _mode_: ディレクトリのモード 戻り値: @@ -2769,8 +2769,8 @@ int weechat_mkdir (char *directory, int mode); 引数: -* 'directory': 作成するディレクトリの名前 -* 'mode': ディレクトリのモード +* _directory_: 作成するディレクトリの名前 +* _mode_: ディレクトリのモード 戻り値: @@ -2810,8 +2810,8 @@ int weechat_mkdir_parents (char *directory, int mode); 引数: -* 'directory': 作成するディレクトリの名前 -* 'mode': ディレクトリのモード +* _directory_: 作成するディレクトリの名前 +* _mode_: ディレクトリのモード 戻り値: @@ -2857,12 +2857,12 @@ void weechat_exec_on_files (const char *directory, 引数: -* 'directory': ファイルを検索するディレクトリ -* 'hidden_files': 検索対象に隠しファイルを含める場合は 1、含めない場合は 0 -* 'callback': 各ファイルに対して呼び出すコールバック関数、引数: -** 'void *data': ポインタ -** 'const char *filename': 見つかったファイルの名前 -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ +* _directory_: ファイルを検索するディレクトリ +* _hidden_files_: 検索対象に隠しファイルを含める場合は 1、含めない場合は 0 +* _callback_: 各ファイルに対して呼び出すコールバック関数、引数: +** _void *data_: ポインタ +** _const char *filename_: 見つかったファイルの名前 +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ C 言語での使用例: @@ -2894,7 +2894,7 @@ char *weechat_file_get_content (const char *filename); 引数: -* 'filename': パスやファイル名 +* _filename_: パスやファイル名 戻り値: @@ -2932,8 +2932,8 @@ int weechat_util_timeval_cmp (struct timeval *tv1, struct timeval *tv2); 引数: -* 'tv1': 1 番目の "timeval" 構造体 -* 'tv2': 2 番目の "timeval" 構造体 +* _tv1_: 1 番目の "timeval" 構造体 +* _tv2_: 2 番目の "timeval" 構造体 戻り値: @@ -2969,8 +2969,8 @@ long long weechat_util_timeval_diff (struct timeval *tv1, struct timeval *tv2); 引数: -* 'tv1': 1 番目の "timeval" 構造体 -* 'tv2': 2 番目の "timeval" 構造体 +* _tv1_: 1 番目の "timeval" 構造体 +* _tv2_: 2 番目の "timeval" 構造体 戻り値: @@ -3004,8 +3004,8 @@ void weechat_util_timeval_add (struct timeval *tv, long long interval); 引数: -* 'tv': timeval 構造体 -* 'interval': 時間間隔 (マイクロ秒単位) +* _tv_: timeval 構造体 +* _interval_: 時間間隔 (マイクロ秒単位) [NOTE] WeeChat バージョン 1.0 以前の場合、時間間隔の単位はミリ秒でした。 @@ -3025,7 +3025,7 @@ weechat_util_timeval_add (&tv, 2000000); /* add 2 seconds */ _WeeChat バージョン 0.3.2 以上で利用可、バージョン 1.3 で更新。_ 日付/時刻を "strftime" で作った文字列として取得します。書式は -'weechat.look.time_format' で定義されています。 +_weechat.look.time_format_ で定義されています。 プロトタイプ: @@ -3036,7 +3036,7 @@ const char *weechat_util_get_time_string (const time_t *date); 引数: -* 'date': 日付へのポインタ +* _date_: 日付へのポインタ 戻り値: @@ -3069,7 +3069,7 @@ int weechat_util_version_number (const char *version); 引数: -* 'version': WeeChat バージョン文字列 (例: "0.3.9" や "0.3.9-dev") +* _version_: WeeChat バージョン文字列 (例: "0.3.9" や "0.3.9-dev") C 言語での使用例: @@ -3138,13 +3138,13 @@ struct t_weelist_item *weechat_list_add (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'data': リストに追加するデータ -* 'where': データを追加する場所: -** 'WEECHAT_LIST_POS_SORT': リストに追加、リストをソートされた状態を保持 -** 'WEECHAT_LIST_POS_BEGINNING': リストの最初に追加 -** 'WEECHAT_LIST_POS_END': リストの最後に追加 -* 'user_data': 任意のポインタ +* _weelist_: リストへのポインタ +* _data_: リストに追加するデータ +* _where_: データを追加する場所: +** _WEECHAT_LIST_POS_SORT_: リストに追加、リストをソートされた状態を保持 +** _WEECHAT_LIST_POS_BEGINNING_: リストの最初に追加 +** _WEECHAT_LIST_POS_END_: リストの最後に追加 +* _user_data_: 任意のポインタ 戻り値: @@ -3183,8 +3183,8 @@ struct t_weelist_item *weechat_list_search (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'data': リストから検索するデータ +* _weelist_: リストへのポインタ +* _data_: リストから検索するデータ 戻り値: @@ -3224,8 +3224,8 @@ int weechat_list_search_pos (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'data': リストから検索するデータ +* _weelist_: リストへのポインタ +* _data_: リストから検索するデータ 戻り値: @@ -3263,8 +3263,8 @@ struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'data': リストから検索するデータ +* _weelist_: リストへのポインタ +* _data_: リストから検索するデータ 戻り値: @@ -3304,8 +3304,8 @@ int weechat_list_casesearch_pos (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'data': リストから検索するデータ +* _weelist_: リストへのポインタ +* _data_: リストから検索するデータ 戻り値: @@ -3343,8 +3343,8 @@ struct t_weelist_item *weechat_list_get (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'position': リスト中の位置 (1 番目の要素は 0) +* _weelist_: リストへのポインタ +* _position_: リスト中の位置 (1 番目の要素は 0) 戻り値: @@ -3381,8 +3381,8 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); 引数: -* 'item': 要素へのポインタ -* 'value': 要素にセットする新しい値 +* _item_: 要素へのポインタ +* _value_: 要素にセットする新しい値 C 言語での使用例: @@ -3415,7 +3415,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); 引数: -* 'item': 要素へのポインタ +* _item_: 要素へのポインタ 戻り値: @@ -3452,7 +3452,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); 引数: -* 'item': 要素へのポインタ +* _item_: 要素へのポインタ 戻り値: @@ -3489,7 +3489,7 @@ const char *weechat_list_string (struct t_weelist_item *item); 引数: -* 'item': 要素へのポインタ +* _item_: 要素へのポインタ 戻り値: @@ -3526,7 +3526,7 @@ char *weechat_list_size (struct t_weelist *weelist); 引数: -* 'weelist': 要素へのポインタ +* _weelist_: 要素へのポインタ 戻り値: @@ -3564,8 +3564,8 @@ void weechat_list_remove (struct t_weelist *weelist, 引数: -* 'weelist': リストへのポインタ -* 'item': 要素へのポインタ +* _weelist_: リストへのポインタ +* _item_: 要素へのポインタ C 言語での使用例: @@ -3598,7 +3598,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); 引数: -* 'weelist': リストへのポインタ +* _weelist_: リストへのポインタ C 言語での使用例: @@ -3631,7 +3631,7 @@ void weechat_list_free (struct t_weelist *weelist); 引数: -* 'weelist': リストへのポインタ +* _weelist_: リストへのポインタ C 言語での使用例: @@ -3678,37 +3678,37 @@ struct t_hashtable *weechat_hashtable_new (int size, 引数: -* 'size': +* _size_: ハッシュキーを保存している内部配列のサイズ、値が大きければ多くのメモリを使う反面パフォーマンスがよくなります (これはハッシュテーブルの要素数の上限を決めるもの*ではありません*) -* 'type_keys': ハッシュテーブルのキーの種類: -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'type_values': ハッシュテーブルの値の種類: -** 'WEECHAT_HASHTABLE_INTEGER' -** 'WEECHAT_HASHTABLE_STRING' -** 'WEECHAT_HASHTABLE_POINTER' -** 'WEECHAT_HASHTABLE_BUFFER' -** 'WEECHAT_HASHTABLE_TIME' -* 'callback_hash_key': キーを「ハッシュ化」する (キーを整数値にする) +* _type_keys_: ハッシュテーブルのキーの種類: +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _type_values_: ハッシュテーブルの値の種類: +** _WEECHAT_HASHTABLE_INTEGER_ +** _WEECHAT_HASHTABLE_STRING_ +** _WEECHAT_HASHTABLE_POINTER_ +** _WEECHAT_HASHTABLE_BUFFER_ +** _WEECHAT_HASHTABLE_TIME_ +* _callback_hash_key_: キーを「ハッシュ化」する (キーを整数値にする) 際のコールバック関数、キーの種類が "buffer" 以外の場合、コールバックは NULL でも可 (デフォルトのハッシュ関数を使います)、引数と戻り値: -** 'struct t_hashtable *hashtable': ハッシュテーブルへのポインタ -** 'const void *key': キー +** _struct t_hashtable *hashtable_: ハッシュテーブルへのポインタ +** _const void *key_: キー ** 戻り値: キーのハッシュ値 -* 'callback_keycmp': 2 つのキーを比較する際のコールバック関数、キーの種類が +* _callback_keycmp_: 2 つのキーを比較する際のコールバック関数、キーの種類が "buffer" 以外の場合、コールバックは NULL でも可 (デフォルトの比較関数を使います)、引数と戻り値: -** 'struct t_hashtable *hashtable': ハッシュテーブルへのポインタ -** 'const void *key1': 1 番目のキー -** 'const void *key2': 2 番目のキー +** _struct t_hashtable *hashtable_: ハッシュテーブルへのポインタ +** _const void *key1_: 1 番目のキー +** _const void *key2_: 2 番目のキー ** 戻り値: -*** 'key1' が 'key2' より小さい場合は負 -*** 'key1' が 'key2' と同じ場合はゼロ -*** 'key1' が 'key2' より大きい場合は正 +*** _key1_ が _key2_ より小さい場合は負 +*** _key1_ が _key2_ と同じ場合はゼロ +*** _key1_ が _key2_ より大きい場合は正 戻り値: @@ -3745,12 +3745,12 @@ struct t_hashtable_item *weechat_hashtable_set_with_size (struct t_hashtable *ha 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'key': キーへのポインタ -* 'key_size': キーのサイズ (バイト単位)、ハッシュテーブルのキーの種類が +* _hashtable_: ハッシュテーブルへのポインタ +* _key_: キーへのポインタ +* _key_size_: キーのサイズ (バイト単位)、ハッシュテーブルのキーの種類が "buffer" の場合のみ使用 -* 'value': 値へのポインタ -* 'value_size': 値のサイズ (バイト単位)、ハッシュテーブルの値の種類が +* _value_: 値へのポインタ +* _value_size_: 値のサイズ (バイト単位)、ハッシュテーブルの値の種類が "buffer" の場合のみ使用 戻り値: @@ -3784,9 +3784,9 @@ struct t_hashtable_item *weechat_hashtable_set (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'key': キーへのポインタ -* 'value': 値へのポインタ +* _hashtable_: ハッシュテーブルへのポインタ +* _key_: キーへのポインタ +* _value_: 値へのポインタ 戻り値: @@ -3817,8 +3817,8 @@ void *weechat_hashtable_get (struct t_hashtable *hashtable, void *key); 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'key': キーへのポインタ +* _hashtable_: ハッシュテーブルへのポインタ +* _key_: キーへのポインタ 戻り値: @@ -3849,8 +3849,8 @@ int weechat_hashtable_has_key (struct t_hashtable *hashtable, void *key); 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'key': キーへのポインタ +* _hashtable_: ハッシュテーブルへのポインタ +* _key_: キーへのポインタ 戻り値: @@ -3890,9 +3890,9 @@ void weechat_hashtable_map (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'callback_map': ハッシュテーブルの各のエントリに対して呼び出すコールバック関数 -* 'callback_map_data': 'callback_map' コールバックを呼び出す際のコールバックの結果保存先へのポインタ +* _hashtable_: ハッシュテーブルへのポインタ +* _callback_map_: ハッシュテーブルの各のエントリに対して呼び出すコールバック関数 +* _callback_map_data_: _callback_map_ コールバックを呼び出す際のコールバックの結果保存先へのポインタ C 言語での使用例: @@ -3934,12 +3934,12 @@ void weechat_hashtable_map_string (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'callback_map': ハッシュテーブルの各のエントリに対して呼び出すコールバック関数 -* 'callback_map_data': 'callback_map' コールバックを呼び出した際のコールバックの結果保存先へのポインタ +* _hashtable_: ハッシュテーブルへのポインタ +* _callback_map_: ハッシュテーブルの各のエントリに対して呼び出すコールバック関数 +* _callback_map_data_: _callback_map_ コールバックを呼び出した際のコールバックの結果保存先へのポインタ [NOTE] -コールバックに渡される文字列 'key' と 'value' +コールバックに渡される文字列 _key_ と _value_ は一時的な文字列で、コールバックの呼び出しが終了したら削除されます。 C 言語での使用例: @@ -3976,7 +3976,7 @@ struct t_hashtable *weechat_hashtable_dup (struct t_hashtable *hashtable); 引数: -* 'hashtable': ハッシュテーブルへのポインタ +* _hashtable_: ハッシュテーブルへのポインタ 戻り値: @@ -4008,10 +4008,10 @@ int weechat_hashtable_get_integer (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'property': プロパティ名: -** 'size': ハッシュテーブルの内部配列 "htable" のサイズ -** 'items_count': ハッシュテーブルに含まれる要素の数 +* _hashtable_: ハッシュテーブルへのポインタ +* _property_: プロパティ名: +** _size_: ハッシュテーブルの内部配列 "htable" のサイズ +** _items_count_: ハッシュテーブルに含まれる要素の数 戻り値: @@ -4043,26 +4043,26 @@ const char *weechat_hashtable_get_string (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'property': プロパティ名: -** 'type_keys': キーの型: -*** 'integer': 整数 -*** 'string': 文字列 -*** 'pointer': ポインタ -*** 'buffer': バッファ -*** 'time': 時間 -** 'type_values': 値の型: -*** 'integer': 整数 -*** 'string': 文字列 -*** 'pointer': ポインタ -*** 'buffer': バッファ -*** 'time': 時間 -** 'keys': キーのリストを含む文字列 (書式: "key1,key2,key3") -** 'keys_sorted': ソートされたキーのリストを含む文字列 (書式: "key1,key2,key3") -** 'values': 値のリストを含む文字列 (書式: "value1,value2,value3") -** 'keys_values': リストのキーと値を含む文字列 +* _hashtable_: ハッシュテーブルへのポインタ +* _property_: プロパティ名: +** _type_keys_: キーの型: +*** _integer_: 整数 +*** _string_: 文字列 +*** _pointer_: ポインタ +*** _buffer_: バッファ +*** _time_: 時間 +** _type_values_: 値の型: +*** _integer_: 整数 +*** _string_: 文字列 +*** _pointer_: ポインタ +*** _buffer_: バッファ +*** _time_: 時間 +** _keys_: キーのリストを含む文字列 (書式: "key1,key2,key3") +** _keys_sorted_: ソートされたキーのリストを含む文字列 (書式: "key1,key2,key3") +** _values_: 値のリストを含む文字列 (書式: "value1,value2,value3") +** _keys_values_: リストのキーと値を含む文字列 (書式: "key1:value1,key2:value2,key3:value3") -** 'keys_values_sorted': リストのキーと値を含む文字列 (キーでソート) +** _keys_values_sorted_: リストのキーと値を含む文字列 (キーでソート) (書式: "key1:value1,key2:value2,key3:value3") 戻り値: @@ -4098,12 +4098,12 @@ void weechat_hashtable_set_pointer (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'property': プロパティ名: -** 'callback_free_key': ハッシュテーブルからキーを開放する際のコールバック関数 +* _hashtable_: ハッシュテーブルへのポインタ +* _property_: プロパティ名: +** _callback_free_key_: ハッシュテーブルからキーを開放する際のコールバック関数 _(WeeChat バージョン 0.4.2 以上で利用可)_ -** 'callback_free_value': ハッシュテーブルから値を開放する際のコールバック関数 -* 'pointer': プロパティの新しいポインタ値 +** _callback_free_value_: ハッシュテーブルから値を開放する際のコールバック関数 +* _pointer_: プロパティの新しいポインタ値 C 言語での使用例: @@ -4145,9 +4145,9 @@ int weechat_hashtable_add_to_infolist (struct t_hashtable *hashtable, 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'infolist_item': インフォリスト要素へのポインタ -* 'prefix': インフォリストで名前のプレフィックスとして使う文字列 +* _hashtable_: ハッシュテーブルへのポインタ +* _infolist_item_: インフォリスト要素へのポインタ +* _prefix_: インフォリストで名前のプレフィックスとして使う文字列 戻り値: @@ -4188,8 +4188,8 @@ void weechat_hashtable_remove (struct t_hashtable *hashtable, const void *key); 引数: -* 'hashtable': ハッシュテーブルへのポインタ -* 'key': キーへのポインタ +* _hashtable_: ハッシュテーブルへのポインタ +* _key_: キーへのポインタ C 言語での使用例: @@ -4216,7 +4216,7 @@ void weechat_hashtable_remove_all (struct t_hashtable *hashtable); 引数: -* 'hashtable': ハッシュテーブルへのポインタ +* _hashtable_: ハッシュテーブルへのポインタ C 言語での使用例: @@ -4243,7 +4243,7 @@ void weechat_hashtable_free (struct t_hashtable *hashtable); 引数: -* 'hashtable': ハッシュテーブルへのポインタ +* _hashtable_: ハッシュテーブルへのポインタ C 言語での使用例: @@ -4280,19 +4280,19 @@ struct t_config_file *weechat_config_new (const char *name, 引数: -* 'name': 設定ファイルの名前 (パスと拡張子は不要) -* 'callback_reload': `/reload` で設定ファイルを再読み込みする際に呼び出すコールバック関数 +* _name_: 設定ファイルの名前 (パスと拡張子は不要) +* _callback_reload_: `/reload` で設定ファイルを再読み込みする際に呼び出すコールバック関数 (任意、NULL でも可)、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_file *config_file': 設定ファイルへのポインタ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_file *config_file_: 設定ファイルへのポインタ ** 戻り値: -*** 'WEECHAT_CONFIG_READ_OK' -*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' -*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' -* 'callback_reload_pointer': WeeChat が 'callback_reload' +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_reload_pointer_: WeeChat が _callback_reload_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_reload_data': WeeChat が 'callback_reload' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_reload_data_: WeeChat が _callback_reload_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成した設定ファイルが開放された時点で自動的に開放されます @@ -4394,96 +4394,96 @@ struct t_config_section *weechat_config_new_section ( 引数: -* 'config_file': 設定ファイルへのポインタ -* 'name': セクションの名前 -* 'user_can_add_options': +* _config_file_: 設定ファイルへのポインタ +* _name_: セクションの名前 +* _user_can_add_options_: ユーザがこのセクションに新しいオプションを作成することを許可する場合は 1、禁止する場合は 0 -* 'user_can_delete_options': +* _user_can_delete_options_: ユーザがこのセクションからオプションを削除することを許可する場合は 1、禁止する場合は 0 -* 'callback_read': このセクションに含まれるオプションがディスクから読まれた際に呼び出すコールバック関数 +* _callback_read_: このセクションに含まれるオプションがディスクから読まれた際に呼び出すコールバック関数 (特別な関数を使ってセクションを読み出す必要がある場合を除いて、殆どの場合は NULL を指定する)、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_file *config_file': 設定ファイルへのポインタ -** 'struct t_config_section *section': セクションへのポインタ -** 'const char *option_name': オプションの名前 -** 'const char *value': 値 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_file *config_file_: 設定ファイルへのポインタ +** _struct t_config_section *section_: セクションへのポインタ +** _const char *option_name_: オプションの名前 +** _const char *value_: 値 ** 戻り値: -*** 'WEECHAT_CONFIG_READ_OK' -*** 'WEECHAT_CONFIG_READ_MEMORY_ERROR' -*** 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' -* 'callback_read_pointer': WeeChat が 'callback_read' +*** _WEECHAT_CONFIG_READ_OK_ +*** _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +*** _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ +* _callback_read_pointer_: WeeChat が _callback_read_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_read_data': WeeChat が 'callback_read' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_read_data_: WeeChat が _callback_read_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したセクションが開放された時点で自動的に開放されます -* 'callback_write': セクションをファイルに書き込む際に呼び出すコールバック関数 +* _callback_write_: セクションをファイルに書き込む際に呼び出すコールバック関数 (特別な関数を使ってセクションを書き込む必要がある場合を除いて、殆どの場合は NULL を指定する)、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_file *config_file': 設定ファイルへのポインタ -** 'const char *section_name': セクションの名前 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_file *config_file_: 設定ファイルへのポインタ +** _const char *section_name_: セクションの名前 ** 戻り値: -*** 'WEECHAT_CONFIG_WRITE_OK' -*** 'WEECHAT_CONFIG_WRITE_ERROR' -*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' -* 'callback_write_pointer': WeeChat が 'callback_write' +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_pointer_: WeeChat が _callback_write_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_write_data': WeeChat が 'callback_write' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_write_data_: WeeChat が _callback_write_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したセクションが開放された時点で自動的に開放されます -* 'callback_write_default': +* _callback_write_default_: セクションのデフォルト値が必ずファイルに書き込まれる際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_file *config_file': 設定ファイルへのポインタ -** 'const char *section_name': セクションの名前 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_file *config_file_: 設定ファイルへのポインタ +** _const char *section_name_: セクションの名前 ** 戻り値: -*** 'WEECHAT_CONFIG_WRITE_OK' -*** 'WEECHAT_CONFIG_WRITE_ERROR' -*** 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' -* 'callback_write_default_pointer': WeeChat が 'callback_write_default' +*** _WEECHAT_CONFIG_WRITE_OK_ +*** _WEECHAT_CONFIG_WRITE_ERROR_ +*** _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* _callback_write_default_pointer_: WeeChat が _callback_write_default_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_write_default_data': WeeChat が 'callback_write_default' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_write_default_data_: WeeChat が _callback_write_default_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したセクションが開放された時点で自動的に開放されます -* 'callback_create_option': セクションに新しいオプションを作成する際に呼び出すコールバック関数 +* _callback_create_option_: セクションに新しいオプションを作成する際に呼び出すコールバック関数 (セクションに新しいオプションを作成することを禁止する場合は NULL)、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_file *config_file': 設定ファイルへのポインタ -** 'struct t_config_section *section': セクションへのポインタ -** 'const char *option_name': オプションの名前 -** 'const char *value': 値 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_file *config_file_: 設定ファイルへのポインタ +** _struct t_config_section *section_: セクションへのポインタ +** _const char *option_name_: オプションの名前 +** _const char *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_pointer': WeeChat が 'callback_create_option' +*** _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_pointer_: WeeChat が _callback_create_option_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_create_option_data': WeeChat が 'callback_create_option' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_create_option_data_: WeeChat が _callback_create_option_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したセクションが開放された時点で自動的に開放されます -* 'callback_delete_option': セクションからオプションを削除する際に呼び出すコールバック関数 +* _callback_delete_option_: セクションからオプションを削除する際に呼び出すコールバック関数 (セクションからオプションを削除することを禁止する場合は NULL)、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_file *config_file': 設定ファイルへのポインタ -** 'struct t_config_section *section': セクションへのポインタ -** 'struct t_config_option *option': オプションへのポインタ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_file *config_file_: 設定ファイルへのポインタ +** _struct t_config_section *section_: セクションへのポインタ +** _struct t_config_option *option_: オプションへのポインタ ** 戻り値: -*** '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_pointer': WeeChat が 'callback_delete_option' +*** _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_pointer_: WeeChat が _callback_delete_option_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_delete_option_data': WeeChat が 'callback_delete_option' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_delete_option_data_: WeeChat が _callback_delete_option_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、ポインタはここで作成したセクションが開放された時点で自動的に開放されます @@ -4641,8 +4641,8 @@ struct t_config_section *weechat_config_search_section ( 引数: -* 'config_file': 設定ファイルへのポインタ -* 'section_name': 検索するセクションの名前 +* _config_file_: 設定ファイルへのポインタ +* _section_name_: 検索するセクションの名前 戻り値: @@ -4709,58 +4709,58 @@ struct t_config_option *weechat_config_new_option ( 引数: -* 'config_file': 設定ファイルへのポインタ -* 'section': セクションへのポインタ -* 'name': オプションの名前; WeeChat バージョン 1.4 以上の場合、名前には親オプションの名前を含めることも可能です +* _config_file_: 設定ファイルへのポインタ +* _section_: セクションへのポインタ +* _name_: オプションの名前; WeeChat バージョン 1.4 以上の場合、名前には親オプションの名前を含めることも可能です (このオプションが "null" の場合、親オプションの値が `/set` コマンドの出力に表示されます)。以下の構文を使ってください: "name << file.section.option" -* 'type': オプションの型: -** 'boolean': ブール値 (on/off) -** 'integer': 整数値 (任意で文字列を受けるようにすることも可) -** 'string': 文字列 -** 'color': 色 -* 'description': オプションの説明 -* 'string_values': 文字列で値を受ける - ("|" で区切る)、'integer' 型の場合に使う (任意) -* 'min': 最小値 ('integer' 型で有効) -* 'max': 最大値 ('integer' 型で有効) -* 'default_value': オプションのデフォルト値 (オプションをリセットした際に使われる) -* 'value': オプションの値 -* 'null_value_allowed': オプションに 'null' (未定義値) +* _type_: オプションの型: +** _boolean_: ブール値 (on/off) +** _integer_: 整数値 (任意で文字列を受けるようにすることも可) +** _string_: 文字列 +** _color_: 色 +* _description_: オプションの説明 +* _string_values_: 文字列で値を受ける + (`+|+` で区切る)、_integer_ 型の場合に使う (任意) +* _min_: 最小値 (_integer_ 型で有効) +* _max_: 最大値 (_integer_ 型で有効) +* _default_value_: オプションのデフォルト値 (オプションをリセットした際に使われる) +* _value_: オプションの値 +* _null_value_allowed_: オプションに _null_ (未定義値) を設定することを許可する場合に 1、禁止する場合は 0 -* 'callback_check_value': オプションの新しい値をチェックする際に呼び出すコールバック関数 +* _callback_check_value_: オプションの新しい値をチェックする際に呼び出すコールバック関数 (任意)、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_option *option': オプションへのポインタ -** 'const char *value': オプションの新しい値 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_option *option_: オプションへのポインタ +** _const char *value_: オプションの新しい値 ** 戻り値: *** 値が有効の場合は 1 *** 値が無効の場合は 0 -* 'callback_check_value_pointer': WeeChat が 'callback_check_value' +* _callback_check_value_pointer_: WeeChat が _callback_check_value_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_check_value_data': WeeChat が 'callback_check_value' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_check_value_data_: WeeChat が _callback_check_value_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したオプションが開放された時点で自動的に開放されます -* 'callback_change': オプションの値を変更した際に呼び出すコールバック関数 +* _callback_change_: オプションの値を変更した際に呼び出すコールバック関数 (任意)、引数: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_option *option': オプションへのポインタ -* 'callback_change_pointer': WeeChat が 'callback_change' +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_option *option_: オプションへのポインタ +* _callback_change_pointer_: WeeChat が _callback_change_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_change_data': WeeChat が 'callback_change' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_change_data_: WeeChat が _callback_change_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したオプションが開放された時点で自動的に開放されます -* 'callback_delete': オプションを削除する前に際に呼び出すコールバック関数 +* _callback_delete_: オプションを削除する前に際に呼び出すコールバック関数 (任意)、引数: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_config_option *option': オプションへのポインタ -* 'callback_delete_pointer': WeeChat が 'callback_delete' +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_config_option *option_: オプションへのポインタ +* _callback_delete_pointer_: WeeChat が _callback_delete_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_delete_data': WeeChat が 'callback_delete' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_delete_data_: WeeChat が _callback_delete_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したオプションが開放された時点で自動的に開放されます @@ -4901,7 +4901,7 @@ option5 = weechat.config_new_option(config_file, section, "option5", "color", [NOTE] Ruby では、3 組のコールバックとデータ (合わせて 6 つの文字列) を渡すために必ず 6 つの文字列をからなる配列を 1 つ渡してください (これは Ruby が 関数に 15 個以上の引数を渡せないことが原因です)、より詳しい内容は -'WeeChat スクリプト作成ガイド' を参照してください _(WeeChat バージョン 0.4.1 で修正済み)_ 。 +_WeeChat スクリプト作成ガイド_ を参照してください _(WeeChat バージョン 0.4.1 で修正済み)_ 。 ==== config_search_option @@ -4919,9 +4919,9 @@ struct t_config_option *weechat_config_search_option ( 引数: -* 'config_file': 設定ファイルへのポインタ -* 'section': セクションへのポインタ -* 'name': 検索するオプションの名前 +* _config_file_: 設定ファイルへのポインタ +* _section_: セクションへのポインタ +* _name_: 検索するオプションの名前 戻り値: @@ -4963,12 +4963,12 @@ void weechat_config_search_section_option (struct t_config_file *config_file, 引数: -* 'config_file': 設定ファイルへのポインタ -* 'section': セクションへのポインタ -* 'option_name': オプション名 -* 'section_found': +* _config_file_: 設定ファイルへのポインタ +* _section_: セクションへのポインタ +* _option_name_: オプション名 +* _section_found_: セクションへのポインタへのポインタ、これは見つかったオプションのセクションになります -* 'option_found': +* _option_found_: オプションへのポインタへのポインタ、これは見つかったオプションのへのポインタになります C 言語での使用例: @@ -5013,14 +5013,14 @@ void weechat_config_search_with_string (const char *option_name, 引数: -* 'option_name': オプションの完全な名前 (書式: "file.section.option") -* 'config_file': +* _option_name_: オプションの完全な名前 (書式: "file.section.option") +* _config_file_: 設定ファイルへのポインタへのポインタ、これは見つかったオプションの設定ファイルへのポインタになります -* 'section': +* _section_: セクションへのポインタのポインタ、これは見つかったオプションのセクションになります -* 'option': +* _option_: オプションへのポインタのポインタ、これは見つかったオプションへのポインタになります -* 'pos_option_name': +* _pos_option_name_: 文字列へのポインタへのポインタ、これはオプション名へのポインタになります C 言語での使用例: @@ -5063,7 +5063,7 @@ int weechat_config_string_to_boolean (const char *text); 引数: -* 'text': チェックするテキスト +* _text_: チェックするテキスト 戻り値: @@ -5110,15 +5110,15 @@ int weechat_config_option_reset (struct t_config_option *option, 引数: -* 'option': オプションへのポインタ -* 'run_callback': オプションを変更する際に、コールバックを呼び出す場合は +* _option_: オプションへのポインタ +* _run_callback_: オプションを変更する際に、コールバックを呼び出す場合は 1、呼び出さない場合は 0 戻り値: -* オプションの値がリセットされた場合は 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' -* 値が変更されなかった場合は 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' -* エラーが起きた場合は 'WEECHAT_CONFIG_OPTION_SET_ERROR' +* オプションの値がリセットされた場合は _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +* 値が変更されなかった場合は _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +* エラーが起きた場合は _WEECHAT_CONFIG_OPTION_SET_ERROR_ C 言語での使用例: @@ -5169,16 +5169,16 @@ int weechat_config_option_set (struct t_config_option *option, 引数: -* 'option': オプションへのポインタ -* 'value': オプションの新しい値 -* 'run_callback': オプションが変更された際に、'callback_change' コールバックを呼び出す場合は +* _option_: オプションへのポインタ +* _value_: オプションの新しい値 +* _run_callback_: オプションが変更された際に、_callback_change_ コールバックを呼び出す場合は 1、呼び出さない場合は 0 戻り値: -* オプションの値が変更された場合は 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' -* 値が変更されなかった場合は 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' -* エラーが起きた場合は 'WEECHAT_CONFIG_OPTION_SET_ERROR' +* オプションの値が変更された場合は _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +* 値が変更されなかった場合は _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +* エラーが起きた場合は _WEECHAT_CONFIG_OPTION_SET_ERROR_ C 言語での使用例: @@ -5229,8 +5229,8 @@ int weechat_config_option_set_null (struct t_config_option *option, 引数: -* 'option': オプションへのポインタ -* 'run_callback': オプションが (null 以外の値に) 変更された際に、'callback_change' +* _option_: オプションへのポインタ +* _run_callback_: オプションが (null 以外の値に) 変更された際に、_callback_change_ コールバックを呼び出す場合は 1、呼び出さない場合は 0 [NOTE] @@ -5239,9 +5239,9 @@ int weechat_config_option_set_null (struct t_config_option *option, 戻り値: -* オプション値が変更された場合は 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' -* 値が変更されなかった場合は 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' -* エラーが起きた場合は 'WEECHAT_CONFIG_OPTION_SET_ERROR' +* オプション値が変更された場合は _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +* 値が変更されなかった場合は _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +* エラーが起きた場合は _WEECHAT_CONFIG_OPTION_SET_ERROR_ C 言語での使用例: @@ -5291,14 +5291,14 @@ int weechat_config_option_unset (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値: -* オプションの値がリセットされなかった場合は 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' -* オプションの値がリセットされた場合は 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' -* オプションが削除された場合は 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' -* エラーが起きた場合は 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' +* オプションの値がリセットされなかった場合は _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ +* オプションの値がリセットされた場合は _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ +* オプションが削除された場合は _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ +* エラーが起きた場合は _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ C 言語での使用例: @@ -5354,8 +5354,8 @@ void weechat_config_option_rename (struct t_config_option *option, 引数: -* 'option': オプションへのポインタ -* 'new_name': オプションの新しい名前 +* _option_: オプションへのポインタ +* _new_name_: オプションの新しい名前 C 言語での使用例: @@ -5389,21 +5389,21 @@ void *weechat_config_option_get_pointer (struct t_config_option *option, 引数: -* 'option': オプションへのポインタ -* 'property': プロパティ名: -** 'config_file': 設定ファイルへのポインタ ('struct t_config_file *') -** 'section': セクションへのポインタ ('struct t_config_section *') -** 'name': オプション名 ('char *') -** 'parent_name': 親オプションの名前 ('char *') _(WeeChat バージョン 1.4 以上で利用可)_ -** 'type': オプションの型 ('int *') -** 'description': オプションの説明 ('char *') -** 'string_values': 文字列値 ('char *') -** 'min': 最大値 ('int *') -** 'max': 最小値 ('int *') -** 'default_value': デフォルト値 (オプションの型に依存) -** 'value': 現在の値 (オプションの型に依存) -** 'prev_option': 1 つ前のオプションへのポインタ ('struct t_config_option *') -** 'next_option': 1 つ後のオプションへのポインタ ('struct t_config_option *') +* _option_: オプションへのポインタ +* _property_: プロパティ名: +** _config_file_: 設定ファイルへのポインタ (_struct t_config_file *_) +** _section_: セクションへのポインタ (_struct t_config_section *_) +** _name_: オプション名 (_char *_) +** _parent_name_: 親オプションの名前 (_char *_) _(WeeChat バージョン 1.4 以上で利用可)_ +** _type_: オプションの型 (_int *_) +** _description_: オプションの説明 (_char *_) +** _string_values_: 文字列値 (_char *_) +** _min_: 最大値 (_int *_) +** _max_: 最小値 (_int *_) +** _default_value_: デフォルト値 (オプションの型に依存) +** _value_: 現在の値 (オプションの型に依存) +** _prev_option_: 1 つ前のオプションへのポインタ (_struct t_config_option *_) +** _next_option_: 1 つ後のオプションへのポインタ (_struct t_config_option *_) 戻り値: @@ -5432,7 +5432,7 @@ int weechat_config_option_is_null (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値: @@ -5478,7 +5478,7 @@ int weechat_config_option_default_is_null (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値: @@ -5524,14 +5524,14 @@ int weechat_config_boolean (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': オプションのブール値 (0 または 1) -* 'integer': 0 -* 'string': 0 -* 'color': 0 +* _boolean_: オプションのブール値 (0 または 1) +* _integer_: 0 +* _string_: 0 +* _color_: 0 C 言語での使用例: @@ -5574,14 +5574,14 @@ int weechat_config_boolean_default (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': オプションのデフォルトブール値 (0 または 1) -* 'integer': 0 -* 'string': 0 -* 'color': 0 +* _boolean_: オプションのデフォルトブール値 (0 または 1) +* _integer_: 0 +* _string_: 0 +* _color_: 0 C 言語での使用例: @@ -5624,14 +5624,14 @@ int weechat_config_integer (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': オプションのブール値 (0 または 1) -* 'integer': オプションの整数値 -* 'string': 0 -* 'color': 色インデックス +* _boolean_: オプションのブール値 (0 または 1) +* _integer_: オプションの整数値 +* _string_: 0 +* _color_: 色インデックス C 言語での使用例: @@ -5666,14 +5666,14 @@ int weechat_config_integer_default (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': オプションのデフォルトブール値 (0 または 1) -* 'integer': オプションのデフォルト整数値 -* 'string': 0 -* 'color': デフォルト色インデックス +* _boolean_: オプションのデフォルトブール値 (0 または 1) +* _integer_: オプションのデフォルト整数値 +* _string_: 0 +* _color_: デフォルト色インデックス C 言語での使用例: @@ -5708,15 +5708,15 @@ const char *weechat_config_string (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': 値が真の場合は "on"、それ以外の場合は "off" -* 'integer': 値が文字列に対応付けられている場合はその文字列値、それ以外の場合は +* _boolean_: 値が真の場合は "on"、それ以外の場合は "off" +* _integer_: 値が文字列に対応付けられている場合はその文字列値、それ以外の場合は NULL -* 'string': オプションの文字列値 -* 'color': 色名 +* _string_: オプションの文字列値 +* _color_: 色名 C 言語での使用例: @@ -5751,15 +5751,15 @@ const char *weechat_config_string_default (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': デフォルト値が真の場合は "on"、それ以外の場合は "off" -* 'integer': デフォルト値が文字列に対応付けられている場合はその文字列値、それ以外の場合は +* _boolean_: デフォルト値が真の場合は "on"、それ以外の場合は "off" +* _integer_: デフォルト値が文字列に対応付けられている場合はその文字列値、それ以外の場合は NULL -* 'string': オプションのデフォルト文字列値 -* 'color': デフォルト色名 +* _string_: オプションのデフォルト文字列値 +* _color_: デフォルト色名 C 言語での使用例: @@ -5794,14 +5794,14 @@ const char *weechat_config_color (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': NULL -* 'integer': NULL -* 'string': NULL -* 'color': 色名 +* _boolean_: NULL +* _integer_: NULL +* _string_: NULL +* _color_: 色名 C 言語での使用例: @@ -5836,14 +5836,14 @@ const char *weechat_config_color_default (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ 戻り値、オプションの型に依存: -* 'boolean': NULL -* 'integer': NULL -* 'string': NULL -* 'color': デフォルト色名 +* _boolean_: NULL +* _integer_: NULL +* _string_: NULL +* _color_: デフォルト色名 C 言語での使用例: @@ -5880,8 +5880,8 @@ void weechat_config_write_option (struct t_config_file *config_file, 引数: -* 'config_file': 設定ファイルへのポインタ -* 'option': オプションへのポインタ +* _config_file_: 設定ファイルへのポインタ +* _option_: オプションへのポインタ C 言語での使用例: @@ -5930,9 +5930,9 @@ void weechat_config_write_line (struct t_config_file *config_file, 引数: -* 'config_file': 設定ファイルへのポインタ -* 'option_name': オプション名 -* 'value': 値 (NULL の場合、セクション名の行を書き込みます。例: +* _config_file_: 設定ファイルへのポインタ +* _option_name_: オプション名 +* _value_: 値 (NULL の場合、セクション名の行を書き込みます。例: "[section]") C 言語での使用例: @@ -5980,13 +5980,13 @@ int weechat_config_write (struct t_config_file *config_file); 引数: -* 'config_file': 設定ファイルへのポインタ +* _config_file_: 設定ファイルへのポインタ 戻り値: -* 設定を書き込んだ場合は 'WEECHAT_CONFIG_WRITE_OK' -* メモリ不足の場合は 'WEECHAT_CONFIG_WRITE_MEMORY_ERROR' -* その他のエラーが起きた場合は 'WEECHAT_CONFIG_WRITE_ERROR' +* 設定を書き込んだ場合は _WEECHAT_CONFIG_WRITE_OK_ +* メモリ不足の場合は _WEECHAT_CONFIG_WRITE_MEMORY_ERROR_ +* その他のエラーが起きた場合は _WEECHAT_CONFIG_WRITE_ERROR_ C 言語での使用例: @@ -6036,13 +6036,13 @@ int weechat_config_read (struct t_config_file *config_file); 引数: -* 'config_file': 設定ファイルへのポインタ +* _config_file_: 設定ファイルへのポインタ 戻り値: -* 設定ファイルを読み込んだ場合は 'WEECHAT_CONFIG_READ_OK' -* メモリ不足の場合は 'WEECHAT_CONFIG_READ_MEMORY_ERROR' -* ファイルが見つからない場合は 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' +* 設定ファイルを読み込んだ場合は _WEECHAT_CONFIG_READ_OK_ +* メモリ不足の場合は _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +* ファイルが見つからない場合は _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ C 言語での使用例: @@ -6092,13 +6092,13 @@ int weechat_config_reload (struct t_config_file *config_file); 引数: -* 'config_file': 設定ファイルへのポインタ +* _config_file_: 設定ファイルへのポインタ 戻り値: -* 設定を再読み込みした場合は 'WEECHAT_CONFIG_READ_OK' -* メモリ不足の合は 'WEECHAT_CONFIG_READ_MEMORY_ERROR' -* ファイルが見つからない場合は 'WEECHAT_CONFIG_READ_FILE_NOT_FOUND' +* 設定を再読み込みした場合は _WEECHAT_CONFIG_READ_OK_ +* メモリ不足の合は _WEECHAT_CONFIG_READ_MEMORY_ERROR_ +* ファイルが見つからない場合は _WEECHAT_CONFIG_READ_FILE_NOT_FOUND_ C 言語での使用例: @@ -6148,7 +6148,7 @@ void weechat_config_option_free (struct t_config_option *option); 引数: -* 'option': オプションへのポインタ +* _option_: オプションへのポインタ C 言語での使用例: @@ -6181,7 +6181,7 @@ void weechat_config_section_free_options (struct t_config_section *section); 引数: -* 'section': セクションへのポインタ +* _section_: セクションへのポインタ C 言語での使用例: @@ -6214,7 +6214,7 @@ void weechat_config_section_free (struct t_config_section *section); 引数: -* 'section': セクションへのポインタ +* _section_: セクションへのポインタ C 言語での使用例: @@ -6247,7 +6247,7 @@ void weechat_config_free (struct t_config_file *config_file); 引数: -* 'config_file': 設定ファイルへのポインタ +* _config_file_: 設定ファイルへのポインタ C 言語での使用例: @@ -6280,7 +6280,7 @@ struct t_config_option *weechat_config_get (const char *option_name); 引数: -* 'option_name': オプションの完全な名前 (書式: "file.section.option") +* _option_name_: オプションの完全な名前 (書式: "file.section.option") 戻り値: @@ -6317,7 +6317,7 @@ const char *weechat_config_get_plugin (const char *option_name); 引数: -* 'option_name': オプション名、プレフィックス "plugins.var.xxx." +* _option_name_: オプション名、プレフィックス "plugins.var.xxx." が自動的に付けられる (ここで "xxx" は現在のプラグイン名)。 戻り値: @@ -6357,7 +6357,7 @@ int weechat_config_is_set_plugin (const char *option_name); 引数: -* 'option_name': オプション名、プレフィックス "plugins.var.xxx." +* _option_name_: オプション名、プレフィックス "plugins.var.xxx." が自動的に付けられる (ここで "xxx" は現在のプラグイン名)。 戻り値: @@ -6407,16 +6407,16 @@ int weechat_config_set_plugin (const char *option_name, const char *value); 引数: -* 'option_name': オプション名、プレフィックス "plugins.var.xxx." +* _option_name_: オプション名、プレフィックス "plugins.var.xxx." が自動的に付けられる (ここで "xxx" は現在のプラグイン名)。 -* 'value': オプションの新しい値 +* _value_: オプションの新しい値 戻り値: -* オプションの値を変更した場合は 'WEECHAT_CONFIG_OPTION_SET_OK_CHANGED' -* 値を変更しなかった場合は 'WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE' -* オプションが見つからない場合は 'WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND' -* その他のエラーが起きた場合は 'WEECHAT_CONFIG_OPTION_SET_ERROR' +* オプションの値を変更した場合は _WEECHAT_CONFIG_OPTION_SET_OK_CHANGED_ +* 値を変更しなかった場合は _WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE_ +* オプションが見つからない場合は _WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND_ +* その他のエラーが起きた場合は _WEECHAT_CONFIG_OPTION_SET_ERROR_ C 言語での使用例: @@ -6474,9 +6474,9 @@ void weechat_config_set_desc_plugin (const char *option_name, 引数: -* 'option_name': オプション名、プレフィックス "plugins.var.xxx." +* _option_name_: オプション名、プレフィックス "plugins.var.xxx." が自動的に付けられる (ここで "xxx" は現在のプラグイン名)。 -* 'description': オプションの説明 +* _description_: オプションの説明 [NOTE] オプション (plugins.var.xxx.option_name) @@ -6515,15 +6515,15 @@ int weechat_config_unset_plugin (const char *option_name); 引数: -* 'option_name': オプション名、プレフィックス "plugins.var.xxx." +* _option_name_: オプション名、プレフィックス "plugins.var.xxx." が自動的に付けられる (ここで "xxx" は現在のプラグイン名)。 戻り値: -* オプションの値をリセットしなかった場合は 'WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET' -* オプションの値をリセットした場合は 'WEECHAT_CONFIG_OPTION_UNSET_OK_RESET' -* オプションを削除した場合は 'WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED' -* エラーが起きた場合は 'WEECHAT_CONFIG_OPTION_UNSET_ERROR' +* オプションの値をリセットしなかった場合は _WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET_ +* オプションの値をリセットした場合は _WEECHAT_CONFIG_OPTION_UNSET_OK_RESET_ +* オプションを削除した場合は _WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED_ +* エラーが起きた場合は _WEECHAT_CONFIG_OPTION_UNSET_ERROR_ C 言語での使用例: @@ -6590,12 +6590,12 @@ int weechat_key_bind (const char *context, struct t_hashtable *keys); 引数: -* 'context': キーのコンテキスト: -** 'default': デフォルトコンテキスト (一般的な動作) -** 'search': 検索コンテキスト (バッファ中のテキストを検索中) -** 'cursor': 画面上のカーソルを自由に移動 -** 'mouse': マウスイベント用のキー -* 'keys': キー割り当てを収めたハッシュテーブル +* _context_: キーのコンテキスト: +** _default_: デフォルトコンテキスト (一般的な動作) +** _search_: 検索コンテキスト (バッファ中のテキストを検索中) +** _cursor_: 画面上のカーソルを自由に移動 +** _mouse_: マウスイベント用のキー +* _keys_: キー割り当てを収めたハッシュテーブル 戻り値: @@ -6652,9 +6652,9 @@ int weechat_key_unbind (const char *context, const char *key); 引数: -* 'context': キーのコンテキスト (<<_key_bind,weechat_key_bind>> を参照) -* 'key': 削除するキーまたは特殊値 "area:XXX" で1 番目または 2 - 番目の領域から 'XXX' をもつすべてのキーを削除する +* _context_: キーのコンテキスト (<<_key_bind,weechat_key_bind>> を参照) +* _key_: 削除するキーまたは特殊値 "area:XXX" で1 番目または 2 + 番目の領域から _XXX_ をもつすべてのキーを削除する 戻り値: @@ -6705,7 +6705,7 @@ const char *weechat_prefix (const char *prefix); 引数: -* 'prefix': プレフィックスの名前 (以下の表を参照) +* _prefix_: プレフィックスの名前 (以下の表を参照) 戻り値: @@ -6714,14 +6714,14 @@ const char *weechat_prefix (const char *prefix); List of prefixes: -[width="70%",cols="^2e,^1,^3,5",options="header"] +[width="70%",cols="^2m,^1,^3,5",options="header"] |=== -| プレフィックス | 値 | 色 | 説明 -| error | `=!=` | yellow | エラーメッセージ -| network | `--` | magenta | ネットワークからのメッセージ -| action | `*` | white | 本人の動作 -| join | `-->` | lightgreen | 誰かが現在のチャットに参加 -| quit | `<--` | lightred | 誰かが現在のチャットから退出 +| プレフィックス | 値 | 色 | 説明 +| error | `+=!=+` | yellow | エラーメッセージ +| network | `+--+` | magenta | ネットワークからのメッセージ +| action | `+*+` | white | 本人の動作 +| join | `+-->+` | lightgreen | 誰かが現在のチャットに参加 +| quit | `+<--+` | lightred | 誰かが現在のチャットから退出 |=== [NOTE] @@ -6758,49 +6758,49 @@ const char *weechat_color (const char *color_name); 引数: -* 'color_name': 色の名前、以下の中から 1 つ: +* _color_name_: 色の名前、以下の中から 1 つ: ** WeeChat 色オプション名 (weechat.color.xxx の xxx)、例えば - 'chat_delimiters' + _chat_delimiters_ ** オプション名 (書式: file.section.option)、例えば - 'irc.color.message_quit' (_WeeChat バージョン 1.2 以上で利用可_) + _irc.color.message_quit_ (_WeeChat バージョン 1.2 以上で利用可_) ** 任意で属性や背景色を指定した色 (以下を参照) ** 属性: -*** 'bold': 太字を有効 -*** '-bold': 太字を無効 -*** 'reverse': 色反転を有効 -*** '-reverse': 色反転を削除 -*** 'italic': イタリックを有効 -*** '-italic': イタリックを無効 -*** 'underline': 下線を有効 -*** '-underline': 下線を無効 -*** 'emphasis': テキストの強調を切り替え (注意: WeeChat +*** _bold_: 太字を有効 +*** _-bold_: 太字を無効 +*** _reverse_: 色反転を有効 +*** _-reverse_: 色反転を削除 +*** _italic_: イタリックを有効 +*** _-italic_: イタリックを無効 +*** _underline_: 下線を有効 +*** _-underline_: 下線を無効 +*** _emphasis_: テキストの強調を切り替え (注意: WeeChat はテキスト強調をバッファテキストを検索する際に使用するため、バー以外でこれを使わないでください。) _(WeeChat バージョン 0.4.2 以上で利用可)_ ** バーの色名: -*** 'bar_fg': バーのテキストの色 -*** 'bar_delim': バーの区切り文字の色 -*** 'bar_bg': バーの背景色 +*** _bar_fg_: バーのテキストの色 +*** _bar_delim_: バーの区切り文字の色 +*** _bar_bg_: バーの背景色 ** リセット: -*** 'reset': 色と属性をリセット -*** 'resetcolor': 色をリセット (属性はリセットしない) _(WeeChat バージョン 0.3.6 以上で利用可)_ +*** _reset_: 色と属性をリセット +*** _resetcolor_: 色をリセット (属性はリセットしない) _(WeeChat バージョン 0.3.6 以上で利用可)_ 色の書式: 属性 (任意) + 色名 + ",background" (任意)。以下の属性を使えます: -* `*` : 太字 -* `!` : 色反転 -* `/` : イタリック -* `_` : 下線 -* `|` : 属性を保存: 色を変更する際に太字/色反転/イタリック/下線の状態をリセットしない +* `+*+` : 太字 +* `+!+` : 色反転 +* `+/+` : イタリック +* `+_+` : 下線 +* `+|+` : 属性を保存: 色を変更する際に太字/色反転/イタリック/下線の状態をリセットしない _(WeeChat バージョン 0.3.6 以上で利用可)_ 例: -* `yellow` : テキストを黄色に -* `_green` : テキストに下線を引き、テキストを緑色に -* `*214` : テキストを太字でオレンジ色に -* `yellow,red` : テキストを黄色に、背景色を赤に -* `|cyan` : テキストをシアンに (これよりも前に設定した属性は変えない) +* `+yellow+` : テキストを黄色に +* `+_green+` : テキストに下線を引き、テキストを緑色に +* `+*214+` : テキストを太字でオレンジ色に +* `+yellow,red+` : テキストを黄色に、背景色を赤に +* `+|cyan+` : テキストをシアンに (これよりも前に設定した属性は変えない) 戻り値: @@ -6841,8 +6841,8 @@ void weechat_printf (struct t_gui_buffer *buffer, const char *message, ...); 引数: -* 'buffer': バッファへのポインタ、NULL の場合は WeeChat バッファにメッセージを表示 -* 'message': 表示するメッセージ +* _buffer_: バッファへのポインタ、NULL の場合は WeeChat バッファにメッセージを表示 +* _message_: 表示するメッセージ [NOTE] メッセージに含まれる最初のタブ文字 ("\t") はメッセージのプレフィックスを分割するために使われます。 + @@ -6900,9 +6900,9 @@ void weechat_printf_date (struct t_gui_buffer *buffer, time_t date, 引数: -* 'buffer': バッファへのポインタ、NULL の場合、メッセージは WeeChat バッファに表示 -* 'date': メッセージの日付 (0 は現在の日付/時間を意味する) -* 'message': 表示するメッセージ +* _buffer_: バッファへのポインタ、NULL の場合、メッセージは WeeChat バッファに表示 +* _date_: メッセージの日付 (0 は現在の日付/時間を意味する) +* _message_: 表示するメッセージ C 言語での使用例: @@ -6928,9 +6928,9 @@ void weechat_printf_tags (struct t_gui_buffer *buffer, const char *tags, 引数: -* 'buffer': バッファへのポインタ、NULL の場合、メッセージは WeeChat バッファに表示 -* 'tags': タグのコンマ区切りリスト -* 'message': 表示するメッセージ +* _buffer_: バッファへのポインタ、NULL の場合、メッセージは WeeChat バッファに表示 +* _tags_: タグのコンマ区切りリスト +* _message_: 表示するメッセージ C 言語での使用例: @@ -6957,10 +6957,10 @@ void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date, 引数: -* 'buffer': バッファへのポインタ、NULL の場合、メッセージは WeeChat バッファに表示 -* 'date': メッセージの日付 (0 は現在の日付/時間を意味する) -* 'tags': タグのコンマ区切りリスト -* 'message': 表示するメッセージ +* _buffer_: バッファへのポインタ、NULL の場合、メッセージは WeeChat バッファに表示 +* _date_: メッセージの日付 (0 は現在の日付/時間を意味する) +* _tags_: タグのコンマ区切りリスト +* _message_: 表示するメッセージ 通常使用するタグ (一部抜粋したリスト): @@ -7026,12 +7026,12 @@ void weechat_printf_y (struct t_gui_buffer *buffer, int y, 引数: -* 'buffer': バッファへのポインタ -* 'y': 行番号 (1 行目は 0); 負数の場合は表示された最後の行の後に行を追加する: - 'y' の絶対値で最後の行の後に追加する行数を指定 (例えば +* _buffer_: バッファへのポインタ +* _y_: 行番号 (1 行目は 0); 負数の場合は表示された最後の行の後に行を追加する: + _y_ の絶対値で最後の行の後に追加する行数を指定 (例えば -1 は最後の行のすぐ後、-2 は 最後の行の 2 行後) _(WeeChat バージョン 1.0 以上で利用可)_ -* 'message': 表示するメッセージ +* _message_: 表示するメッセージ C 言語での使用例: @@ -7067,7 +7067,7 @@ void weechat_log_printf (const char *message, ...); 引数: -* 'message': 書き込むメッセージ +* _message_: 書き込むメッセージ C 言語での使用例: @@ -7146,28 +7146,28 @@ struct t_hook *weechat_hook_command (const char *command, 引数: -* 'command': コマンド名 +* _command_: コマンド名 (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'description': コマンドの説明 (`/help command` で表示されます) -* 'args': コマンドの引数 (`/help command` で表示されます) -* 'args_description': 引数の説明 (`/help command` で表示されます) -* 'completion': コマンドの補完候補テンプレート: 各引数に対する補完候補の空白区切りリスト。1 - つの引数に対して複数の補完候補を設定するには補完候補同士を "|" +* _description_: コマンドの説明 (`/help command` で表示されます) +* _args_: コマンドの引数 (`/help command` で表示されます) +* _args_description_: 引数の説明 (`/help command` で表示されます) +* _completion_: コマンドの補完候補テンプレート: 各引数に対する補完候補の空白区切りリスト。1 + つの引数に対して複数の補完候補を設定するには補完候補同士を `+|+` で区切ってください。1 つのコマンドに対して複数のテンプレートを設定するにはテンプレート同士を - "||" で区切ってください。 -* 'callback': コマンドが使用された際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_gui_buffer *buffer': コマンドを実行するバッファ -** 'int argc': コマンドに渡す引数の個数 -** 'char **argv': コマンドに渡す引数 -** 'char **argv_eol': コマンドに渡す引数 + `+||+` で区切ってください。 +* _callback_: コマンドが使用された際に呼び出すコールバック関数、引数と戻り値: +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_gui_buffer *buffer_: コマンドを実行するバッファ +** _int argc_: コマンドに渡す引数の個数 +** _char **argv_: コマンドに渡す引数 +** _char **argv_eol_: コマンドに渡す引数 (最初の引数から各引数までを収めた文字列) ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -7177,9 +7177,9 @@ include::autogen/plugin_api/completions.asciidoc[] 特殊コード: -* '%%command': コマンド 'command' と同じ補完候補テンプレートを使用 -* '%-': 補完の中止 -* '%*': 最後の補完候補を繰り返す +* `+%%command+`: コマンド _command_ と同じ補完候補テンプレートを使用 +* `+%-+`: 補完の中止 +* `+%*+`: 最後の補完候補を繰り返す 戻り値: @@ -7215,20 +7215,20 @@ struct t_hook *my_command_hook = ---- 例えば、コマンドが `/command abc def ghi` -のように実行された場合、'argv' と 'argv_eol' は以下のようになります: +のように実行された場合、_argv_ と _argv_eol_ は以下のようになります: -* 'argv': -** 'argv[0]' == "/command" -** 'argv[1]' == "abc" -** 'argv[2]' == "def" -** 'argv[3]' == "ghi" -* 'argv_eol': -** 'argv_eol[0]' == "/command abc def ghi" -** 'argv_eol[1]' == "abc def ghi" -** 'argv_eol[2]' == "def ghi" -** 'argv_eol[3]' == "ghi" +* _argv_: +** _argv[0]_ == "/command" +** _argv[1]_ == "abc" +** _argv[2]_ == "def" +** _argv[3]_ == "ghi" +* _argv_eol_: +** _argv_eol[0]_ == "/command abc def ghi" +** _argv_eol[1]_ == "abc def ghi" +** _argv_eol[2]_ == "def ghi" +** _argv_eol[3]_ == "ghi" -スクリプトでは、'args' は "abc def ghi" のようになります。 +スクリプトでは、_args_ は "abc def ghi" のようになります。 スクリプト (Python) での使用例: @@ -7276,24 +7276,24 @@ struct t_hook *weechat_hook_command_run (const char *command, 引数: -* 'command': フックするコマンド (ワイルドカード "*" を使うことができます) +* _command_: フックするコマンド (ワイルドカード `+*+` を使うことができます) (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'callback': コマンドが実行される際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_gui_buffer *buffer': コマンドを実行するバッファ -** 'const char *command': 実行するコマンド、引数付き +* _callback_: コマンドが実行される際に呼び出すコールバック関数、引数と戻り値: +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_gui_buffer *buffer_: コマンドを実行するバッファ +** _const char *command_: 実行するコマンド、引数付き ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_OK_EAT' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます [NOTE] -コールバックは 'WEECHAT_RC_OK' または 'WEECHAT_RC_OK_EAT' +コールバックは _WEECHAT_RC_OK_ または _WEECHAT_RC_OK_EAT_ (コールバックの後にコマンドを実行しない) を返すことができます。 戻り値: @@ -7354,20 +7354,20 @@ struct t_hook *weechat_hook_timer (long interval, 引数: -* 'interval': 2 つの呼び出し間隔 (ミリ秒、1000 = 1 秒) -* 'align_second': 秒の調整。例えば、現在時刻が 09:00、 +* _interval_: 2 つの呼び出し間隔 (ミリ秒、1000 = 1 秒) +* _align_second_: 秒の調整。例えば、現在時刻が 09:00、 interval = 60000 (60 秒)、align_second = 60 の場合、毎分 0 秒時にタイマを呼び出す -* 'max_calls': タイマを呼び出す回数 (0 の場合、タイマを無限に呼び出す) -* 'callback': 時間が来たら呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'int remaining_calls': 呼び出し残り回数 (タイマを無限に呼び出す場合は -1) +* _max_calls_: タイマを呼び出す回数 (0 の場合、タイマを無限に呼び出す) +* _callback_: 時間が来たら呼び出すコールバック関数、引数と戻り値: +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _int remaining_calls_: 呼び出し残り回数 (タイマを無限に呼び出す場合は -1) ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -7430,21 +7430,21 @@ struct t_hook *weechat_hook_fd (int fd, 引数: -* 'fd': ファイルディスクリプタ -* 'flag_read': 1 = 読み込みイベントをキャッチ、0 = 無視 -* 'flag_write': 1 = 書き込みイベントをキャッチ、0 = 無視 -* 'flag_exception': 1 = 例外イベントをキャッチ、0 = 無視 +* _fd_: ファイルディスクリプタ +* _flag_read_: 1 = 読み込みイベントをキャッチ、0 = 無視 +* _flag_write_: 1 = 書き込みイベントをキャッチ、0 = 無視 +* _flag_exception_: 1 = 例外イベントをキャッチ、0 = 無視 (_WeeChat バージョン 1.3 以上の場合_: この引数は無視され、使われません) -* 'callback': ファイル (またはソケット) +* _callback_: ファイル (またはソケット) に対してキャッチしたいイベントが発生した場合に実行するコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'int fd': ファイルディスクリプタ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _int fd_: ファイルディスクリプタ ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -7496,7 +7496,7 @@ WeeChat バージョン 0.3.9.2 以上の場合、コマンドを実行するためにシェルを使わないようになりました。WeeChat が自動的にコマンドと引数を分割します (シェルがやっているように)。 + 分割 (クォートに基づくコマンド分割) -に失敗する場合、またはシェルを使いたい場合は、ハッシュテーブル 'options' +に失敗する場合、またはシェルを使いたい場合は、ハッシュテーブル _options_ に引数を入れて <<_hook_process_hashtable,weechat_hook_process_hashtable>> 関数を使ってください _(WeeChat バージョン 0.4.0 以上で利用可)_ 。 @@ -7519,34 +7519,34 @@ struct t_hook *weechat_hook_process (const char *command, 引数: -* 'command': 子プロセスで実行するコマンド、URL _(WeeChat バージョン 0.3.7 以上で利用可)_ +* _command_: 子プロセスで実行するコマンド、URL _(WeeChat バージョン 0.3.7 以上で利用可)_ または関数 _(WeeChat バージョン 1.5 以上で利用可)_ (下記参照) -* 'timeout': コマンドのタイムアウト (ミリ秒): +* _timeout_: コマンドのタイムアウト (ミリ秒): このタイムアウトを過ぎたら、子プロセスを kill します (タイムアウトさせない場合は 0) -* 'callback': +* _callback_: 子プロセスからのデータが利用可能になるか、子プロセスが終了したら呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *command': 子プロセスが実行するコマンド -** 'int return_code': リターンコード: -*** '>= 0': コマンドを実行した子プロセスのまたは URL に対するリターンコード。URL の場合に取り得る値は: -**** '0': 転送に成功 -**** '1': 無効な URL -**** '2': 転送エラー -**** '3': メモリ不足 -**** '4': ファイルに関するエラー -*** '< 0': -**** 'WEECHAT_HOOK_PROCESS_RUNNING': データは利用可能だが子プロセスは終了していない -**** 'WEECHAT_HOOK_PROCESS_ERROR': コマンドの起動中にエラー -**** 'WEECHAT_HOOK_PROCESS_CHILD': 子プロセスからコールバックが呼び出された -** 'out': コマンドの標準出力 (stdout) -** 'err': コマンドの標準エラー出力 (stderr) +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *command_: 子プロセスが実行するコマンド +** _int return_code_: リターンコード: +*** _>= 0_: コマンドを実行した子プロセスのまたは URL に対するリターンコード。URL の場合に取り得る値は: +**** _0_: 転送に成功 +**** _1_: 無効な URL +**** _2_: 転送エラー +**** _3_: メモリ不足 +**** _4_: ファイルに関するエラー +*** _< 0_: +**** _WEECHAT_HOOK_PROCESS_RUNNING_: データは利用可能だが子プロセスは終了していない +**** _WEECHAT_HOOK_PROCESS_ERROR_: コマンドの起動中にエラー +**** _WEECHAT_HOOK_PROCESS_CHILD_: 子プロセスからコールバックが呼び出された +** _out_: コマンドの標準出力 (stdout) +** _err_: コマンドの標準エラー出力 (stderr) ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -*** 子プロセスのリターンコード ('command' に "func:" を指定して関数を実行した場合) -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +*** 子プロセスのリターンコード (_command_ に "func:" を指定して関数を実行した場合) +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -7561,14 +7561,14 @@ struct t_hook *weechat_hook_process (const char *command, の内容がダウンロードされます _(WeeChat バージョン 0.3.7 以上で利用可)_ 。<<_hook_process_hashtable,weechat_hook_process_hashtable>> 関数を使えば URL に対してオプションを与えることもできます。 -'command' には関数名を指定することも可能です。"name" という関数を実行するには "func:name" -のように指定します _(WeeChat バージョン 1.5 以上で利用可)_ 。ここで指定した関数 "name" は単独の引数 ('data') -を受け取り、文字列を返すものでなければいけません。関数から返された文字列が 'callback' コールバックに送られます。 + -C API の場合、'callback' コールバックが 'return_code' リターンコードに -'WEECHAT_HOOK_PROCESS_CHILD' が設定された状態で呼び出されます。すなわち (フォークの後に) -子プロセスが呼び出すのは関数 "name" ではなく 'callback' コールバックです。 + +_command_ には関数名を指定することも可能です。"name" という関数を実行するには "func:name" +のように指定します _(WeeChat バージョン 1.5 以上で利用可)_ 。ここで指定した関数 "name" は単独の引数 (_data_) +を受け取り、文字列を返すものでなければいけません。関数から返された文字列が _callback_ コールバックに送られます。 + +C API の場合、_callback_ コールバックが _return_code_ リターンコードに +_WEECHAT_HOOK_PROCESS_CHILD_ が設定された状態で呼び出されます。すなわち (フォークの後に) +子プロセスが呼び出すのは関数 "name" ではなく _callback_ コールバックです。 + スクリプト API の場合、子プロセスが呼び出すのは関数 "name" であり、関数 "name" の戻り値 (文字列) が -'callback' コールバックに送られます (関数の戻り値は外部コマンドを実行した場合の出力と同様に取り扱われます)。 +_callback_ コールバックに送られます (関数の戻り値は外部コマンドを実行した場合の出力と同様に取り扱われます)。 [TIP] WeeChat に関する情報 (例えば現在の安定版、最新の git コミット、...) @@ -7738,7 +7738,7 @@ struct t_hook *weechat_hook_process_hashtable (const char *command, 引数は以下の追加引数を除いて <<_hook_process,weechat_hook_process>> 関数と同じです: -* 'options': 実行するコマンドのオプション; +* _options_: 実行するコマンドのオプション; ハッシュテーブルは関数の中で複製されるため、この関数を呼び出した後にハッシュテーブルを安全に開放できます。 一般的なコマンド (最初に "url:" が付かないコマンド) @@ -7753,7 +7753,7 @@ struct t_hook *weechat_hook_process_hashtable (const char *command, 任意の文字列 | コマンドの引数; このオプションを使って引数を渡さない場合、シェルと同じように引数を自動的に分割します - ('command' 引数からコマンド引数を読み込みます) + (_command_ 引数からコマンド引数を読み込みます) | stdin + _(WeeChat バージョン 0.4.3 以上で利用可)_ | @@ -7771,7 +7771,7 @@ struct t_hook *weechat_hook_process_hashtable (const char *command, _(WeeChat バージョン 1.0 以上で利用可)_ | (非使用) | detached モードでプロセスを実行: 標準出力と標準エラー出力を - '/dev/null' にリダイレクトする + _/dev/null_ にリダイレクトする |=== "url:..." 型のコマンドでは、以下のコマンドを使うことができます @@ -7785,8 +7785,8 @@ include::autogen/plugin_api/url_options.asciidoc[] URL では、入力/出力ファイル用に 2 つのオプション (文字列) を使うことができます: -* 'file_in': 読み込んで URL に送信するファイル (ファイルを送信) -* 'file_out': ダウンロードした URL/ファイルをこのファイルに書き込む +* _file_in_: 読み込んで URL に送信するファイル (ファイルを送信) +* _file_out_: ダウンロードした URL/ファイルをこのファイルに書き込む (標準出力を使わない) 戻り値: @@ -7951,51 +7951,51 @@ struct t_hook *weechat_hook_connect (const char *proxy, 引数: -* 'proxy': 接続に使用するプロキシの名前 +* _proxy_: 接続に使用するプロキシの名前 (任意、プロキシを使わない場合は NULL) -* 'address': 接続先のドメイン名または IP アドレス -* 'port': ポート番号 -* 'ipv6': (IPv4 フォールバックを有効にして) IPv6 を使う場合は 1、IPv4 のみを使う場合は 0 -* 'retry': 再試行回数、IPv6 ホストに接続したもののクライアントの受け入れに失敗した際に +* _address_: 接続先のドメイン名または IP アドレス +* _port_: ポート番号 +* _ipv6_: (IPv4 フォールバックを有効にして) IPv6 を使う場合は 1、IPv4 のみを使う場合は 0 +* _retry_: 再試行回数、IPv6 ホストに接続したもののクライアントの受け入れに失敗した際に IPv4 ホストへフォールバックする際に使う -* 'gnutls_sess': GnuTLS セッション (任意) -* 'gnutls_cb': GnuTLS コールバック (任意) -* 'gnutls_dhkey_size': Diffie-Hellman +* _gnutls_sess_: GnuTLS セッション (任意) +* _gnutls_cb_: GnuTLS コールバック (任意) +* _gnutls_dhkey_size_: Diffie-Hellman 鍵交換の際に使う鍵のサイズ (GnuTLS) -* 'gnutls_priorities': gnutls のプロパティ (構文は gnutls マニュアルの - 'gnutls_priority_init' 関数を参照)、基本的な値を以下に示す: -** 'PERFORMANCE' -** 'NORMAL' (デフォルト) -** 'SECURE128' -** 'SECURE256' -** 'EXPORT' -** 'NONE' -* 'local_hostname': 接続に使うローカルのホスト名前 (任意) -* 'callback': +* _gnutls_priorities_: gnutls のプロパティ (構文は gnutls マニュアルの + _gnutls_priority_init_ 関数を参照)、基本的な値を以下に示す: +** _PERFORMANCE_ +** _NORMAL_ (デフォルト) +** _SECURE128_ +** _SECURE256_ +** _EXPORT_ +** _NONE_ +* _local_hostname_: 接続に使うローカルのホスト名前 (任意) +* _callback_: 接続に成功および失敗した際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'int status': 接続状態: -*** 'WEECHAT_HOOK_CONNECT_OK': 接続成功 -*** 'WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND': アドレスが見つかりません -*** 'WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND': IP アドレスが見つかりません -*** 'WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED': 接続が拒否されました -*** 'WEECHAT_HOOK_CONNECT_PROXY_ERROR': プロキシに関するエラー -*** 'WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR': ローカルのホスト名に関するエラー -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR': GnuTLS 初期化エラー -*** 'WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR': GnuTLS ハンドシェイクエラー -*** 'WEECHAT_HOOK_CONNECT_MEMORY_ERROR': メモリ不足 -*** 'WEECHAT_HOOK_CONNECT_TIMEOUT': タイムアウト -*** 'WEECHAT_HOOK_CONNECT_SOCKET_ERROR': ソケットの作成に失敗 -** 'gnutls_rc': 'gnutls_handshake()' の戻り値 -** 'sock': 接続に使うソケット -** 'const char *error': 'gnutls_strerror(gnutls_rc)' の戻り値 -** 'const char *ip_address': 見つかった IP アドレス +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _int status_: 接続状態: +*** _WEECHAT_HOOK_CONNECT_OK_: 接続成功 +*** _WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND_: アドレスが見つかりません +*** _WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND_: IP アドレスが見つかりません +*** _WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED_: 接続が拒否されました +*** _WEECHAT_HOOK_CONNECT_PROXY_ERROR_: プロキシに関するエラー +*** _WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR_: ローカルのホスト名に関するエラー +*** _WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR_: GnuTLS 初期化エラー +*** _WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR_: GnuTLS ハンドシェイクエラー +*** _WEECHAT_HOOK_CONNECT_MEMORY_ERROR_: メモリ不足 +*** _WEECHAT_HOOK_CONNECT_TIMEOUT_: タイムアウト +*** _WEECHAT_HOOK_CONNECT_SOCKET_ERROR_: ソケットの作成に失敗 +** _gnutls_rc_: _gnutls_handshake()_ の戻り値 +** _sock_: 接続に使うソケット +** _const char *error_: _gnutls_strerror(gnutls_rc)_ の戻り値 +** _const char *ip_address_: 見つかった IP アドレス ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -8126,34 +8126,34 @@ struct t_hook *weechat_hook_print (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ、NULL の場合、任意のバッファからのメッセージをキャッチする -* 'tags': このタグが付けられたメッセージだけをキャッチする (任意): +* _buffer_: バッファへのポインタ、NULL の場合、任意のバッファからのメッセージをキャッチする +* _tags_: このタグが付けられたメッセージだけをキャッチする (任意): ** WeeChat バージョン 0.4.3 以上の場合: メッセージに付けられたタグのコンマ区切りリスト (論理 "or"); - 複数の条件を論理 "and" で組み合わせる場合は区切りに "+" を使ってください; - ワイルドカード "*" を使うことができます + 複数の条件を論理 "and" で組み合わせる場合は区切りに `+++` を使ってください; + ワイルドカード `+*+` を使うことができます ** WeeChat バージョン 0.4.2 以下の場合: 論理 "and" で組み合わせたタグのコンマ区切りリスト -* 'message': この文字列を含むメッセージだけをキャッチする +* _message_: この文字列を含むメッセージだけをキャッチする (任意、大文字小文字を区別しない) -* 'strip_colors': 1 +* _strip_colors_: 1 の場合、コールバックを呼ぶ前に、表示されるメッセージから色を削除する -* 'callback': +* _callback_: メッセージが表示される際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_gui_buffer *buffer': バッファへのポインタ -** 'time_t date': 日付 -** 'int tags_count': 行に付けられたタグの個数 -** 'const char **tags': 行に付けられたタグの配列 -** 'int displayed': 行が表示される場合は 1、フィルタされる (隠される) 場合は 0 -** 'int highlight': 行がハイライトされる場合は 1、ハイライトされない場合は 0 -** 'const char *prefix': プレフィックス -** 'const char *message': メッセージ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_gui_buffer *buffer_: バッファへのポインタ +** _time_t date_: 日付 +** _int tags_count_: 行に付けられたタグの個数 +** _const char **tags_: 行に付けられたタグの配列 +** _int displayed_: 行が表示される場合は 1、フィルタされる (隠される) 場合は 0 +** _int highlight_: 行がハイライトされる場合は 1、ハイライトされない場合は 0 +** _const char *prefix_: プレフィックス +** _const char *message_: メッセージ ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -8162,10 +8162,10 @@ struct t_hook *weechat_hook_print (struct t_gui_buffer *buffer, * 新しいフックへのポインタ、エラーが起きた場合は NULL [IMPORTANT] -WeeChat バージョン 1.0 以上では、スクリプトのコールバック引数 'displayed' -と 'highlight' は整数です (WeeChat バージョン 0.4.3 以下では文字列でした)。 + +WeeChat バージョン 1.0 以上では、スクリプトのコールバック引数 _displayed_ +と _highlight_ は整数です (WeeChat バージョン 0.4.3 以下では文字列でした)。 + すべてのバージョンで互換性を持たせるためには、引数を使う前に整数に変換することをお勧めします、Python -を使った例: "`if int(highlight):`"。 +を使った例: `if int(highlight):`。 C 言語での使用例: @@ -8225,26 +8225,26 @@ struct t_hook *weechat_hook_signal (const char *signal, 引数: -* 'signal': キャッチするシグナル、ワイルドカード "*" を使うことができます +* _signal_: キャッチするシグナル、ワイルドカード `+*+` を使うことができます (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) (以下の表を参照) -* 'callback': +* _callback_: シグナルを受信した際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *signal': 受信したシグナル -** 'const char *type_data': シグナルが送信したデータの型 -*** 'WEECHAT_HOOK_SIGNAL_STRING': 文字列 -*** 'WEECHAT_HOOK_SIGNAL_INT': 整数 -*** 'WEECHAT_HOOK_SIGNAL_POINTER': ポインタ -** 'void *signal_data': シグナルが送信したデータ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *signal_: 受信したシグナル +** _const char *type_data_: シグナルが送信したデータの型 +*** _WEECHAT_HOOK_SIGNAL_STRING_: 文字列 +*** _WEECHAT_HOOK_SIGNAL_INT_: 整数 +*** _WEECHAT_HOOK_SIGNAL_POINTER_: ポインタ +** _void *signal_data_: シグナルが送信したデータ ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_OK_EAT' (直ちにシグナルの送信を止める) +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ (直ちにシグナルの送信を止める) _(WeeChat バージョン 0.4.0 以上で利用可)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -8702,17 +8702,17 @@ WeeChat とプラグインが送信するシグナルのリスト: | weechat | key_combo_default + _(WeeChat バージョン 1.0 以上で利用可)_ | String: キーの組み合わせ | - 'default' コンテキスト内のキーの組み合わせ + _default_ コンテキスト内のキーの組み合わせ | weechat | key_combo_search + _(WeeChat バージョン 1.0 以上で利用可)_ | String: キーの組み合わせ | - 'search' コンテキスト内のキーの組み合わせ + _search_ コンテキスト内のキーの組み合わせ | weechat | key_combo_cursor + _(WeeChat バージョン 1.0 以上で利用可)_ | String: キーの組み合わせ | - 'cursor' コンテキスト内のキーの組み合わせ + _cursor_ コンテキスト内のキーの組み合わせ | weechat | mouse_enabled + _(WeeChat バージョン 1.1 以上で利用可)_ | @@ -8890,7 +8890,7 @@ WeeChat とプラグインが送信するシグナルのリスト: |=== [NOTE] -^(1)^ 'xxx' はサーバ名、'yyy' は IRC コマンド名。 +^(1)^ _xxx_ はサーバ名、_yyy_ は IRC コマンド名。 C 言語での使用例: @@ -8941,18 +8941,18 @@ int weechat_hook_signal_send (const char *signal, const char *type_data, 引数: -* 'signal': 送信するシグナル -* 'type_data': シグナルと一緒に送信するデータの型 +* _signal_: 送信するシグナル +* _type_data_: シグナルと一緒に送信するデータの型 (<<_hook_signal,weechat_hook_signal>> を参照) -* 'signal_data': シグナルと一緒に送信するデータ +* _signal_data_: シグナルと一緒に送信するデータ 戻り値 _(WeeChat バージョン 1.0 以上で利用可)_: * 最後に実行したコールバックの戻り値 - (コールバックを実行しなかった場合は 'WEECHAT_RC_OK'): -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' + (コールバックを実行しなかった場合は _WEECHAT_RC_OK_): +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ C 言語での使用例: @@ -8999,22 +8999,22 @@ weechat.hook_signal_send("logger_backlog", weechat.WEECHAT_HOOK_SIGNAL_POINTER, プログラミング言語ごとに、スクリプトをインストールするために送信するシグナルが 5 種類あります: -* 'perl_script_install' -* 'python_script_install' -* 'ruby_script_install' -* 'lua_script_install' -* 'tcl_script_install' -* 'guile_script_install' -* 'javascript_script_install' +* _perl_script_install_ +* _python_script_install_ +* _ruby_script_install_ +* _lua_script_install_ +* _tcl_script_install_ +* _guile_script_install_ +* _javascript_script_install_ シグナルを受け取ったらコールバックは以下のように働きます: . インストール済みスクリプトを再読み込みして削除。 -. 新しいスクリプトをディレクトリ '~/.weechat/xxx/' に移動 ('xxx' はプログラミング言語) -. 新しいスクリプトへのリンクをディレクトリ '~/.weechat/xxx/autoload/' に作成 +. 新しいスクリプトをディレクトリ _~/.weechat/xxx/_ に移動 (_xxx_ はプログラミング言語) +. 新しいスクリプトへのリンクをディレクトリ _~/.weechat/xxx/autoload/_ に作成 . 新しいスクリプトを読み込む -'script' プラグインはスクリプトをインストールする際にこれらのシグナルを使っています。 +_script_ プラグインはスクリプトをインストールする際にこれらのシグナルを使っています。 引数はインストールするスクリプトのパスを収めた文字列です。 @@ -9039,20 +9039,20 @@ weechat.hook_signal_send("python_script_install", WEECHAT_HOOK_SIGNAL_STRING, プログラミング言語ごとに、リスト文字列に含まれるスクリプトを削除するために送信するシグナルが 5 種類あります: -* 'perl_script_remove' -* 'python_script_remove' -* 'ruby_script_remove' -* 'lua_script_remove' -* 'tcl_script_remove' -* 'guile_script_remove' -* 'javascript_script_remove' +* _perl_script_remove_ +* _python_script_remove_ +* _ruby_script_remove_ +* _lua_script_remove_ +* _tcl_script_remove_ +* _guile_script_remove_ +* _javascript_script_remove_ リスト文字列に含まれるそれぞれのスクリプトについて、コールバックはスクリプトを再読み込みして削除します。 -'script' プラグインはスクリプトを削除する際にこれらのシグナルを使っています。 +_script_ プラグインはスクリプトを削除する際にこれらのシグナルを使っています。 引数は削除したいスクリプトのコンマ区切りリスト文字列です -(パスを含まないスクリプトの名前を使います、例えば 'script.py'). +(パスを含まないスクリプトの名前を使います、例えば _script.py_). C 言語での使用例: @@ -9087,11 +9087,11 @@ irc バッファ(サーバ、チャンネル、プライベート) * チャンネル名 (任意) * セミコロン * オプションのコンマ区切りリスト (任意): -** 'priority_high': キューに高い優先度を設定 (ユーザメッセージなど); +** _priority_high_: キューに高い優先度を設定 (ユーザメッセージなど); 特に設定しなければこの優先度が設定されます -** 'priority_low': キューに低い優先度を設定 (WeeChat +** _priority_low_: キューに低い優先度を設定 (WeeChat が自動的に送信するメッセージなど) -** 'user_message': 強制的にユーザメッセージ化 (コマンドを実行しません) +** _user_message_: 強制的にユーザメッセージ化 (コマンドを実行しません) * セミコロン * メッセージを送信する際に使うタグのコンマ区切りリスト (任意) * セミコロン @@ -9144,22 +9144,22 @@ struct t_hook *weechat_hook_hsignal (const char *signal, Arguments: -* 'signal': キャッチするシグナル、ワイルドカード "*" を使うことができます +* _signal_: キャッチするシグナル、ワイルドカード `+*+` を使うことができます (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) (以下の表を参照) -* 'callback': +* _callback_: シグナルを受信した際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *signal': 受信したシグナル -** 'struct t_hashtable *hashtable': ハッシュテーブル +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *signal_: 受信したシグナル +** _struct t_hashtable *hashtable_: ハッシュテーブル ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_OK_EAT' (直ちにシグナルの送信を止める) +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_OK_EAT_ (直ちにシグナルの送信を止める) _(WeeChat バージョン 0.4.0 以上で利用可)_ -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -9180,49 +9180,49 @@ hsignal のリスト: | weechat | nicklist_group_added + _(WeeChat バージョン 0.4.1 以上で利用可)_ | - 'buffer' ('struct t_gui_buffer *'): バッファ + - 'parent_group' ('struct t_gui_nick_group *'): 親グループ + - 'group' ('struct t_gui_nick_group *'): グループ | + _buffer_ (_struct t_gui_buffer *_): バッファ + + _parent_group_ (_struct t_gui_nick_group *_): 親グループ + + _group_ (_struct t_gui_nick_group *_): グループ | ニックネームリストにグループを追加 | weechat | nicklist_nick_added + _(WeeChat バージョン 0.4.1 以上で利用可)_ | - 'buffer' ('struct t_gui_buffer *'): バッファ + - 'parent_group' ('struct t_gui_nick_group *'): 親グループ + - 'nick' ('struct t_gui_nick *'): ニックネーム | + _buffer_ (_struct t_gui_buffer *_): バッファ + + _parent_group_ (_struct t_gui_nick_group *_): 親グループ + + _nick_ (_struct t_gui_nick *_): ニックネーム | ニックネームリストにニックネームを追加 | weechat | nicklist_group_removing + _(WeeChat バージョン 0.4.1 以上で利用可)_ | - 'buffer' ('struct t_gui_buffer *'): バッファ + - 'parent_group' ('struct t_gui_nick_group *'): 親グループ + - 'group' ('struct t_gui_nick_group *'): グループ | + _buffer_ (_struct t_gui_buffer *_): バッファ + + _parent_group_ (_struct t_gui_nick_group *_): 親グループ + + _group_ (_struct t_gui_nick_group *_): グループ | ニックネームリストからグループを削除 | weechat | nicklist_nick_removing + _(WeeChat バージョン 0.4.1 以上で利用可)_ | - 'buffer' ('struct t_gui_buffer *'): バッファ + - 'parent_group' ('struct t_gui_nick_group *'): 親グループ + - 'nick' ('struct t_gui_nick *'): ニックネーム | + _buffer_ (_struct t_gui_buffer *_): バッファ + + _parent_group_ (_struct t_gui_nick_group *_): 親グループ + + _nick_ (_struct t_gui_nick *_): ニックネーム | ニックネームリストからニックネームを削除 | weechat | nicklist_group_changed + _(WeeChat バージョン 0.4.1 以上で利用可)_ | - 'buffer' ('struct t_gui_buffer *'): バッファ + - 'parent_group' ('struct t_gui_nick_group *'): 親グループ + - 'group' ('struct t_gui_nick_group *'): グループ | + _buffer_ (_struct t_gui_buffer *_): バッファ + + _parent_group_ (_struct t_gui_nick_group *_): 親グループ + + _group_ (_struct t_gui_nick_group *_): グループ | ニックネームリストに含まれるグループを変更 | weechat | nicklist_nick_changed + _(WeeChat バージョン 0.4.1 以上で利用可)_ | - 'buffer' ('struct t_gui_buffer *'): バッファ + - 'parent_group' ('struct t_gui_nick_group *'): 親グループ + - 'nick' ('struct t_gui_nick *'): ニックネーム | + _buffer_ (_struct t_gui_buffer *_): バッファ + + _parent_group_ (_struct t_gui_nick_group *_): 親グループ + + _nick_ (_struct t_gui_nick *_): ニックネーム | ニックネームリストに含まれるニックネームを変更 |=== [NOTE] -^(1)^ 'xxx' は転送で送信するシグナル、'yyy' +^(1)^ _xxx_ は転送で送信するシグナル、_yyy_ は転送元のシグナル。 C 言語での使用例: @@ -9271,16 +9271,16 @@ int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable 引数: -* 'signal': 送信するシグナル -* 'hashtable': ハッシュテーブル +* _signal_: 送信するシグナル +* _hashtable_: ハッシュテーブル 戻り値 _(WeeChat バージョン 1.0 以上で利用可)_: * 最後に実行したコールバックの戻り値 - (コールバックを実行しなかった場合は 'WEECHAT_RC_OK'): -** 'WEECHAT_RC_OK' -** 'WEECHAT_RC_OK_EAT' -** 'WEECHAT_RC_ERROR' + (コールバックを実行しなかった場合は _WEECHAT_RC_OK_): +** _WEECHAT_RC_OK_ +** _WEECHAT_RC_OK_EAT_ +** _WEECHAT_RC_ERROR_ C 言語での使用例: @@ -9321,51 +9321,51 @@ hsignal "irc_redirect_command" は irc 引数は以下のエントリを持つハッシュテーブル (キーと値は文字列) です: -* 'server': 内部サーバ名 (必須) -* 'pattern': 転送パターン (必須)、デフォルトパターン (irc プラグインが定義したもの) +* _server_: 内部サーバ名 (必須) +* _pattern_: 転送パターン (必須)、デフォルトパターン (irc プラグインが定義したもの) またはユーザ定義パターン (<<hsignal_irc_redirect_pattern>> を参照) のどちらか一方、デフォルトパターンは以下: -** 'ison' -** 'list' -** 'mode_channel' -** 'mode_channel_ban' ("mode #channel b") -** 'mode_channel_ban_exception' ("mode #channel e") -** 'mode_channel_invite' ("mode #channel I") -** 'mode_user' -** 'monitor' -** 'names' -** 'ping' -** 'time' -** 'topic' -** 'userhost' -** 'who' -** 'whois' -** 'whowas' -* 'signal': シグナル名 (必須) -* 'count': 転送を行う回数 (任意、デフォルトは 1 回) -* 'string': 受信する irc メッセージに含まれる文字列 +** _ison_ +** _list_ +** _mode_channel_ +** _mode_channel_ban_ ("mode #channel b") +** _mode_channel_ban_exception_ ("mode #channel e") +** _mode_channel_invite_ ("mode #channel I") +** _mode_user_ +** _monitor_ +** _names_ +** _ping_ +** _time_ +** _topic_ +** _userhost_ +** _who_ +** _whois_ +** _whowas_ +* _signal_: シグナル名 (必須) +* _count_: 転送を行う回数 (任意、デフォルトは 1 回) +* _string_: 受信する irc メッセージに含まれる文字列 (任意ですが推奨します、この文字列を含むメッセージだけを転送します) -* 'timeout': 転送のタイムアウト、秒単位 (任意、デフォルトは 60) -* 'cmd_filter': フィルタする irc コマンドのコンマ区切りリスト +* _timeout_: 転送のタイムアウト、秒単位 (任意、デフォルトは 60) +* _cmd_filter_: フィルタする irc コマンドのコンマ区切りリスト (これらのコマンドはコールバックに送信されます、これ以外のコマンドは無視されます) (任意) この hsignal を送信したら必ずその直後に irc サーバにコマンドを送信してください、そうすれば送信したコマンドに対する応答が転送されます。 コマンドに対する応答を完全に受信したら、hsignal が送信されます。この -hsignal は 'irc_redirection_xxx_yyy' という名前で、ここで 'xxx' は -'signal' 、'yyy' は 'pattern' で指定したものになります。 +hsignal は _irc_redirection_xxx_yyy_ という名前で、ここで _xxx_ は +_signal_ 、_yyy_ は _pattern_ で指定したものになります。 以下の内容からなるハッシュテーブルが hsignal で送信されます (キーと値は文字列): -* 'output': コマンドの出力 (メッセージは "\n" で区切られています) -* 'output_size': 'output' のバイト数 (文字列) -* 'error': エラー文字列 (エラーが起きた場合): -** 'timeout': タイムアウトで転送を中止 -* 'server': 内部サーバ名 -* 'pattern': 転送パターン -* 'signal': シグナル名 -* 'command': リダイレクトされたコマンド +* _output_: コマンドの出力 (メッセージは "\n" で区切られています) +* _output_size_: _output_ のバイト数 (文字列) +* _error_: エラー文字列 (エラーが起きた場合): +** _timeout_: タイムアウトで転送を中止 +* _server_: 内部サーバ名 +* _pattern_: 転送パターン +* _signal_: シグナル名 +* _command_: リダイレクトされたコマンド C 言語での使用例: @@ -9426,14 +9426,14 @@ hsignal "irc_redirect_pattern" は irc 転送用のパターンを作成する 引数は以下のエントリを持つハッシュテーブルです (キーと値は文字列): -* 'pattern': パターンの名前 (必須) -* 'timeout': パターンのデフォルトタイムアウト、秒単位 (任意、デフォルトは 60) -* 'cmd_start': 転送を開始するコマンドのコンマ区切りリスト (任意) -* 'cmd_stop': 転送を終了するコマンドのコンマ区切りリスト (必須) -* 'cmd_extra': コマンドを停止した後に受信する可能性のあるコマンドのコンマ区切りリスト +* _pattern_: パターンの名前 (必須) +* _timeout_: パターンのデフォルトタイムアウト、秒単位 (任意、デフォルトは 60) +* _cmd_start_: 転送を開始するコマンドのコンマ区切りリスト (任意) +* _cmd_stop_: 転送を終了するコマンドのコンマ区切りリスト (必須) +* _cmd_extra_: コマンドを停止した後に受信する可能性のあるコマンドのコンマ区切りリスト (任意) -'cmd_start' 、'cmd_stop' 、'cmd_extra' +_cmd_start_ 、_cmd_stop_ 、_cmd_extra_ には受け取ったメッセージに必ず含まれていなければいけない "string" の位置を示す整数を与えることが可能、例: @@ -9508,20 +9508,20 @@ struct t_hook *weechat_hook_config (const char *option, 引数: -* 'option': オプション、書式は完全な名前、コマンド `/set` で使うのと同じ - (例: `weechat.look.item_time_format`)、ワイルドカード "*" を使うことができます +* _option_: オプション、書式は完全な名前、コマンド `/set` で使うのと同じ + (例: `weechat.look.item_time_format`)、ワイルドカード `+*+` を使うことができます (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'callback': +* _callback_: 設定オプションが変更されたら呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *option': オプションの名前 -** 'const char *value': オプションの新しい値 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *option_: オプションの名前 +** _const char *value_: オプションの新しい値 ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -9585,24 +9585,24 @@ struct t_hook *weechat_hook_completion (const char *completion_item, 引数: -* 'completion_item': 補完要素の名前、この後フックされたコマンドで - '%(name)' を使うことができます ('completion' 引数) +* _completion_item_: 補完要素の名前、この後フックされたコマンドで + _%(name)_ を使うことができます (_completion_ 引数) (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'description': 補完の説明 -* 'callback': 補完要素 (ユーザはこの要素を使って何かを補完している) +* _description_: 補完の説明 +* _callback_: 補完要素 (ユーザはこの要素を使って何かを補完している) が使われた場合に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *completion_item': 補完要素の名前 -** 'struct t_gui_buffer *buffer': 補完が行われたバッファ -** 'struct t_gui_completion *completion': +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *completion_item_: 補完要素の名前 +** _struct t_gui_buffer *buffer_: 補完が行われたバッファ +** _struct t_gui_completion *completion_: 補完に際して単語を追加するために使われる構造体 (<<_hook_completion_list_add,weechat_hook_completion_list_add>> を参照) ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -9618,7 +9618,7 @@ struct t_hook *weechat_hook_completion (const char *completion_item, key[Tab] が押された時にコマンドラインを更新するためには、関数 <<_hook_command_run,weechat_hook_command_run>> を使ってコマンド "/input complete_next" をフックしてください (コールバックがコマンドラインを更新する場合は必ず -'WEECHAT_RC_OK_EAT' を返してください。そうすれば WeeChat は補完を行いません)。 +_WEECHAT_RC_OK_EAT_ を返してください。そうすれば WeeChat は補完を行いません)。 戻り値: @@ -9678,11 +9678,11 @@ const char *weechat_hook_completion_get_string (struct t_gui_completion *complet 引数: -* 'completion': 補完へのポインタ -* 'property': プロパティ名: -** 'base_command': 補完に使ったコマンド -** 'base_word': 補完された単語 -** 'args': コマンド引数 (元の単語を含む) +* _completion_: 補完へのポインタ +* _property_: プロパティ名: +** _base_command_: 補完に使ったコマンド +** _base_word_: 補完された単語 +** _args_: コマンド引数 (元の単語を含む) C 言語での使用例: @@ -9735,13 +9735,13 @@ void weechat_hook_completion_list_add (struct t_gui_completion *completion, 引数: -* 'completion': 補完へのポインタ -* 'word': 追加する単語 -* 'nick_completion': 単語がニックネームの場合は 1、そうでなければ 0 -* 'where': 単語を追加するリスト上での位置: -** 'WEECHAT_LIST_POS_SORT': リストがソートされた状態になるような位置 -** 'WEECHAT_LIST_POS_BEGINNING': リストの最初 -** 'WEECHAT_LIST_POS_END': リストの最後 +* _completion_: 補完へのポインタ +* _word_: 追加する単語 +* _nick_completion_: 単語がニックネームの場合は 1、そうでなければ 0 +* _where_: 単語を追加するリスト上での位置: +** _WEECHAT_LIST_POS_SORT_: リストがソートされた状態になるような位置 +** _WEECHAT_LIST_POS_BEGINNING_: リストの最初 +** _WEECHAT_LIST_POS_END_: リストの最後 C 言語での使用例: <<_hook_completion,weechat_hook_completion>> を参照。 @@ -9777,18 +9777,18 @@ struct t_hook *weechat_hook_modifier (const char *modifier, 引数: -* 'modifier': 修飾子名、Weechat またはプラグインが使う修飾子のリスト +* _modifier_: 修飾子名、Weechat またはプラグインが使う修飾子のリスト (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) (以下の表を参照) -* 'callback': 修飾子が使われた際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *modifier': 修飾子の名前 -** 'const char *modifier_data': 修飾子に渡すデータ -** 'const char *string': 修飾子に渡す文字列 +* _callback_: 修飾子が使われた際に呼び出すコールバック関数、引数と戻り値: +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *modifier_: 修飾子の名前 +** _const char *modifier_data_: 修飾子に渡すデータ +** _const char *string_: 修飾子に渡す文字列 ** 戻り値: 新しい文字列 -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -9909,8 +9909,8 @@ WeeChat とプラグインが使う修飾子のリスト: |=== [NOTE] -^(1)^ 'xxx' は IRC コマンド名。 + -^(2)^ 'yyy' はバーの名前。 +^(1)^ _xxx_ は IRC コマンド名。 + +^(2)^ _yyy_ はバーの名前。 C 言語での使用例: @@ -9971,9 +9971,9 @@ char *weechat_hook_modifier_exec (const char *modifier, 引数: -* 'modifier': 修飾子の名前 -* 'modifier_data': 修飾子に渡すデータ -* 'string': 修正する文字列 +* _modifier_: 修飾子の名前 +* _modifier_data_: 修飾子に渡すデータ +* _string_: 修正する文字列 戻り値: @@ -10021,18 +10021,18 @@ struct t_hook *weechat_hook_info (const char *info_name, 引数: -* 'info_name': インフォの名前 +* _info_name_: インフォの名前 (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'description': 説明 -* 'args_description': 引数の説明 (任意、NULL にすることも可) -* 'callback': インフォが要求されたら呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *info_name': インフォの名前 -** 'const char *arguments': 追加の引数、インフォに依存 +* _description_: 説明 +* _args_description_: 引数の説明 (任意、NULL にすることも可) +* _callback_: インフォが要求されたら呼び出すコールバック関数、引数と戻り値: +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *info_name_: インフォの名前 +** _const char *arguments_: 追加の引数、インフォに依存 ** 戻り値: 要求されたインフォの値 -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -10098,20 +10098,20 @@ struct t_hook *weechat_hook_info_hashtable (const char *info_name, 引数: -* 'info_name': インフォの名前 +* _info_name_: インフォの名前 (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'description': 説明 -* 'args_description': 引数ハッシュテーブルの説明 (任意、NULL でも可) -* 'output_description': コールバックが返すハッシュテーブルの説明 +* _description_: 説明 +* _args_description_: 引数ハッシュテーブルの説明 (任意、NULL でも可) +* _output_description_: コールバックが返すハッシュテーブルの説明 (任意、NULL でも可) -* 'callback': インフォを要求する際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *info_name': インフォの名前 -** 'struct t_hashtable *hashtable': ハッシュテーブル、インフォに依存 +* _callback_: インフォを要求する際に呼び出すコールバック関数、引数と戻り値: +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *info_name_: インフォの名前 +** _struct t_hashtable *hashtable_: ハッシュテーブル、インフォに依存 ** 戻り値: 要求したハッシュテーブル -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -10182,22 +10182,22 @@ struct t_hook *weechat_hook_infolist (const char *infolist_name, 引数: -* 'infolist_name': インフォリストの名前 +* _infolist_name_: インフォリストの名前 (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'description': 説明 -* 'pointer_description': ポインタの説明 (任意、NULL でも可) -* 'args_description': 引数の説明 (任意、NULL でも可) -* 'callback': +* _description_: 説明 +* _pointer_description_: ポインタの説明 (任意、NULL でも可) +* _args_description_: 引数の説明 (任意、NULL でも可) +* _callback_: インフォリストが要求された際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *infolist_name': インフォリストの名前 -** 'void *pointer': インフォリストが返すオブジェクトへのポインタ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *infolist_name_: インフォリストの名前 +** _void *pointer_: インフォリストが返すオブジェクトへのポインタ (インフォリストの要素を 1 つだけ返す) -** 'const char *arguments': 追加の引数、インフォリストに依存 +** _const char *arguments_: 追加の引数、インフォリストに依存 ** 戻り値: 要求したインフォリスト -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -10269,17 +10269,17 @@ struct t_hook *weechat_hook_hdata (const char *hdata_name, 引数: -* 'hdata_name': hdata の名前 +* _hdata_name_: hdata の名前 (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'description': 説明 -* 'callback': +* _description_: 説明 +* _callback_: hdata が要求された際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'const char *hdata_name': hdata の名前 +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _const char *hdata_name_: hdata の名前 ** 戻り値: 要求された hdata -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -10332,20 +10332,20 @@ struct t_hook *weechat_hook_focus (const char *area, 引数: -* 'area': チャットエリアの場合は "chat"、またはバー要素の名前 +* _area_: チャットエリアの場合は "chat"、またはバー要素の名前 (優先度の設定が可能、<<hook_priority,優先度>>に関する注意を参照) -* 'callback': +* _callback_: フォーカスが当たったら呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_hashtable *info': フォーカスの情報を含むハッシュテーブルと、他の +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_hashtable *info_: フォーカスの情報を含むハッシュテーブルと、他の (より高い優先度を持つ) フォーカスコールバックを呼び出して返された文字列 (以下のテーブルを参照) ** 戻り値: "info" ポインタ (完全なハッシュテーブル) または新しいハッシュテーブル (コールバックが作成、キーと値は "string" 型) へのポインタ、この新しいハッシュテーブルの内容は - 'info' に追加され、他のフォーカスコールバックに渡されます -* 'callback_pointer': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_data': WeeChat が 'callback' コールバックを呼び出す際にコールバックに渡すポインタ; + _info_ に追加され、他のフォーカスコールバックに渡されます +* _callback_pointer_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_data_: WeeChat が _callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したフックが削除された時点で自動的に開放されます @@ -10533,9 +10533,9 @@ void weechat_hook_set (struct t_hook *hook, const char *property, 引数: -* 'hook': "weechat_hook_xxx()" の戻り値 -* 'property': プロパティ名 (以下の表を参照) -* 'value': プロパティの新しい値 +* _hook_: "weechat_hook_xxx()" の戻り値 +* _property_: プロパティ名 (以下の表を参照) +* _value_: プロパティの新しい値 プロパティ: @@ -10544,22 +10544,22 @@ void weechat_hook_set (struct t_hook *hook, const char *property, | 名前 | フック型 | 値 | 説明 | subplugin | 任意の型 | 任意の文字列 | - サブプラグインの名前 (通常は `/help command` で 'command' + サブプラグインの名前 (通常は `/help command` で _command_ をタイプした時のフックで表示されるスクリプト名) | stdin + _(WeeChat バージョン 0.4.3 以上で利用可)_ | - 'process' 、'process_hashtable' | 任意の文字列 | - 子プロセスの標準入力 ('stdin') にデータを送信 + _process_ 、_process_hashtable_ | 任意の文字列 | + 子プロセスの標準入力 (_stdin_) にデータを送信 | stdin_close + _(WeeChat バージョン 0.4.3 以上で利用可)_ | - 'process' 、'process_hashtable' | (非使用) | - 子プロセスの標準入力 ('stdin') にデータを送信するパイプを閉じる + _process_ 、_process_hashtable_ | (非使用) | + 子プロセスの標準入力 (_stdin_) にデータを送信するパイプを閉じる | signal + _(WeeChat バージョン 1.0 以上で利用可)_ | - 'process' 、'process_hashtable' | + _process_ 、_process_hashtable_ | シグナル番号または以下の名前から 1 つ: `hup` 、`int` 、`quit` 、`kill` 、`term` 、`usr1` 、`usr2` | 子プロセスにシグナルを送信 @@ -10607,7 +10607,7 @@ void weechat_unhook (struct t_hook *hook); 引数: -* 'hook': "weechat_hook_xxx()" の戻り値 +* _hook_: "weechat_hook_xxx()" の戻り値 C 言語での使用例: @@ -10644,7 +10644,7 @@ void weechat_unhook_all (const char *subplugin); 引数: -* 'subplugin': これが NULL でない場合、ここで指定した "subplugin" を持つフックだけを解除します +* _subplugin_: これが NULL でない場合、ここで指定した "subplugin" を持つフックだけを解除します (スクリプトから API を使う場合にはこの引数を指定できません) C 言語での使用例: @@ -10696,31 +10696,31 @@ struct t_gui_buffer *weechat_buffer_new (const char *name, 引数: -* 'name': バッファの名前 (プラグインに対して固有) -* 'input_callback': +* _name_: バッファの名前 (プラグインに対して固有) +* _input_callback_: 入力テキストをバッファに挿入する際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_gui_buffer *buffer': バッファポインタ -** 'const char *input_data': 入力データ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_gui_buffer *buffer_: バッファポインタ +** _const char *input_data_: 入力データ ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'input_callback_pointer': WeeChat が 'input_callback' コールバックを呼び出す際にコールバックに渡すポインタ -* 'input_callback_data': WeeChat が 'input_callback' コールバックを呼び出す際にコールバックに渡すポインタ; +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _input_callback_pointer_: WeeChat が _input_callback_ コールバックを呼び出す際にコールバックに渡すポインタ +* _input_callback_data_: WeeChat が _input_callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したバッファが閉じられた時点で自動的に開放されます -* 'close_callback': +* _close_callback_: バッファを閉じる際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_gui_buffer *buffer': バッファポインタ +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_gui_buffer *buffer_: バッファポインタ ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'close_callback_pointer': WeeChat が 'close_callback' +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _close_callback_pointer_: WeeChat が _close_callback_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'close_callback_data': WeeChat が 'close_callback' コールバックを呼び出す際にコールバックに渡すポインタ; +* _close_callback_data_: WeeChat が _close_callback_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したバッファが閉じられた時点で自動的に開放されます @@ -10743,7 +10743,7 @@ my_input_cb (const void *pointer, void *data, int my_close_cb (const void *pointer, void *data, struct t_gui_buffer *buffer) { - weechat_printf (NULL, "Buffer '%s' will be closed!", + weechat_printf (NULL, "Buffer _%s_ will be closed!", weechat_buffer_get_string (buffer, "name")); return WEECHAT_RC_OK; } @@ -10767,7 +10767,7 @@ def my_input_cb(data, buffer, input_data): return weechat.WEECHAT_RC_OK def my_close_cb(data, buffer): - weechat.prnt("", "Buffer '%s' will be closed!" % weechat.buffer_get_string(buffer, "name")) + weechat.prnt("", "Buffer _%s_ will be closed!" % weechat.buffer_get_string(buffer, "name")) return weechat.WEECHAT_RC_OK buffer = weechat.buffer_new("my_buffer", "my_input_cb", "", "my_close_cb", "") @@ -10822,11 +10822,11 @@ struct t_gui_buffer *weechat_buffer_search (const char *plugin, 引数: -* 'plugin': プラグインの名前、以下の特殊値を使うことができます: -** `==`: name 引数でバッファの完全な名前を使う (例: +* _plugin_: プラグインの名前、以下の特殊値を使うことができます: +** `+==+`: name 引数でバッファの完全な名前を使う (例: `freenode.#weechat` ではなく `irc.freenode.#weechat`) _(WeeChat バージョン 1.0 以上で利用可)_ -* 'name': バッファの名前、NULL または空文字列の場合、現在のバッファ +* _name_: バッファの名前、NULL または空文字列の場合、現在のバッファ (現在のウィンドウに表示されているバッファ) を返す; 名前が `(?i)` で始まる場合、検索は大文字小文字を区別せずに検索 _(WeeChat バージョン 1.0 以上で利用可)_ @@ -10855,7 +10855,7 @@ buffer = weechat.buffer_search("my_plugin", "my_buffer") ==== buffer_search_main -WeeChat メインバッファ ('core' バッファ、WeeChat +WeeChat メインバッファ (_core_ バッファ、WeeChat を実行して最初に表示されるバッファ) を検索。 プロトタイプ: @@ -10867,7 +10867,7 @@ struct t_gui_buffer *weechat_buffer_search_main (); 戻り値: -* WeeChat メインバッファ ('core' バッファ) へのポインタ +* WeeChat メインバッファ (_core_ バッファ) へのポインタ C 言語での使用例: @@ -10900,7 +10900,7 @@ void weechat_buffer_clear (struct t_gui_buffer *buffer); 引数: -* 'buffer': バッファへのポインタ +* _buffer_: バッファへのポインタ C 言語での使用例: @@ -10940,7 +10940,7 @@ void weechat_buffer_close (struct t_gui_buffer *buffer); 引数: -* 'buffer': バッファへのポインタ +* _buffer_: バッファへのポインタ C 言語での使用例: @@ -10982,8 +10982,8 @@ void weechat_buffer_merge (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'target_buffer': ターゲットバッファ、マージ先のバッファ +* _buffer_: バッファへのポインタ +* _target_buffer_: ターゲットバッファ、マージ先のバッファ C 言語での使用例: @@ -11020,9 +11020,9 @@ void weechat_buffer_unmerge (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'number': 分離したバッファの宛先番号、1 - より小さい場合、バッファは 'buffer' の番号 + 1 になる +* _buffer_: バッファへのポインタ +* _number_: 分離したバッファの宛先番号、1 + より小さい場合、バッファは _buffer_ の番号 + 1 になる C 言語での使用例: @@ -11056,55 +11056,55 @@ int weechat_buffer_get_integer (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'property': プロパティ名: -** 'number': バッファの番号 (1 以上) -** 'layout_number': レイアウトに保存されたバッファの番号 -** 'layout_number_merge_order': レイアウトのマージをする際の順番 -** 'short_name_is_set': 短い名前が設定されている場合は 1、そうでない場合は 0 -** 'type': バッファタイプ (0: 書式あり、1: 自由内容) -** 'notify': バッファの通知レベル -** 'num_displayed': バッファを表示しているウィンドウの数 -** 'active': バッファがマージされて選択されている場合は 2、バッファが選択されている場合は +* _buffer_: バッファへのポインタ +* _property_: プロパティ名: +** _number_: バッファの番号 (1 以上) +** _layout_number_: レイアウトに保存されたバッファの番号 +** _layout_number_merge_order_: レイアウトのマージをする際の順番 +** _short_name_is_set_: 短い名前が設定されている場合は 1、そうでない場合は 0 +** _type_: バッファタイプ (0: 書式あり、1: 自由内容) +** _notify_: バッファの通知レベル +** _num_displayed_: バッファを表示しているウィンドウの数 +** _active_: バッファがマージされて選択されている場合は 2、バッファが選択されている場合は 1、バッファがマージされ選択されていない場合は 0 -** 'hidden': バッファが隠されている場合は 1、そうでない場合は 0 +** _hidden_: バッファが隠されている場合は 1、そうでない場合は 0 _(WeeChat バージョン 1.0 以上で利用可)_ -** 'zoomed': バッファがマージとズームされている場合は 1、そうでない場合は 0 +** _zoomed_: バッファがマージとズームされている場合は 1、そうでない場合は 0 _(WeeChat バージョン 1.0 以上で利用可)_ -** 'print_hooks_enabled': プリントフックが有効化されている場合は 1、そうでない場合は 0 -** 'day_change': 日付変更メッセージを表示する場合は 1、そうでない場合は 0 +** _print_hooks_enabled_: プリントフックが有効化されている場合は 1、そうでない場合は 0 +** _day_change_: 日付変更メッセージを表示する場合は 1、そうでない場合は 0 _(WeeChat バージョン 0.4.3 以上で利用可)_ -** 'clear': コマンド `/buffer clear` でバッファをクリアできる場合は 1、そうでない場合は 0 +** _clear_: コマンド `/buffer clear` でバッファをクリアできる場合は 1、そうでない場合は 0 _(WeeChat バージョン 1.0 以上で利用可)_ -** 'filter': バッファでフィルタが有効な場合は 1、そうでない場合は 0 +** _filter_: バッファでフィルタが有効な場合は 1、そうでない場合は 0 _(WeeChat バージョン 1.0 以上で利用可)_ -** 'lines_hidden': バッファに非表示 (フィルタされた) メッセージが 1 +** _lines_hidden_: バッファに非表示 (フィルタされた) メッセージが 1 行以上含まれる場合は 1、すべてのメッセージが表示冴えている場合は 0 -** 'prefix_max_length': バッファプレフィックスの最大長 -** 'time_for_each_line': バッファの各行に時間を表示する場合は +** _prefix_max_length_: バッファプレフィックスの最大長 +** _time_for_each_line_: バッファの各行に時間を表示する場合は 1 (デフォルト)、そうでない場合は 0 -** 'nicklist': ニックネームリストが有効化されている場合は 1、そうでない場合は 0 -** 'nicklist_case_sensitive': ニックネームの大文字小文字を区別する場合は 1、そうでない場合は 0 -** 'nicklist_max_length': ニックネームの最大長 -** 'nicklist_display_groups': グループを表示する場合 1、そうでない場合は 0 -** 'nicklist_count': ニックネームリストに含まれるニックネームとグループの数 -** 'nicklist_groups_count': ニックネームリストに含まれるグループの数 -** 'nicklist_nicks_count': ニックネームリストに含まれるニックネームの数 -** 'nicklist_visible_count': 表示されているニックネームとグループの数 -** 'input': 入力可能な場合は 1、そうでない場合は 0 -** 'input_get_unknown_commands': 未定義のコマンドを入力コールバックに送信する場合は +** _nicklist_: ニックネームリストが有効化されている場合は 1、そうでない場合は 0 +** _nicklist_case_sensitive_: ニックネームの大文字小文字を区別する場合は 1、そうでない場合は 0 +** _nicklist_max_length_: ニックネームの最大長 +** _nicklist_display_groups_: グループを表示する場合 1、そうでない場合は 0 +** _nicklist_count_: ニックネームリストに含まれるニックネームとグループの数 +** _nicklist_groups_count_: ニックネームリストに含まれるグループの数 +** _nicklist_nicks_count_: ニックネームリストに含まれるニックネームの数 +** _nicklist_visible_count_: 表示されているニックネームとグループの数 +** _input_: 入力可能な場合は 1、そうでない場合は 0 +** _input_get_unknown_commands_: 未定義のコマンドを入力コールバックに送信する場合は 1、そうでない場合は 0 -** 'input_size': 入力サイズ (バイト単位) -** 'input_length': 入力長 (文字数) -** 'input_pos': バッファ入力におけるカーソル位置 -** 'input_1st_display': バッファ入力における 1 文字目 -** 'num_history': コマンド履歴の数 -** 'text_search': テキスト検索タイプ: +** _input_size_: 入力サイズ (バイト単位) +** _input_length_: 入力長 (文字数) +** _input_pos_: バッファ入力におけるカーソル位置 +** _input_1st_display_: バッファ入力における 1 文字目 +** _num_history_: コマンド履歴の数 +** _text_search_: テキスト検索タイプ: *** 0: 現在検索していない *** 1: 後方検索 (検索方向: 最古のメッセージに向かって検索) *** 2: 前方検索 (検索方向: 最新のメッセージに向かって検索) -** 'text_search_exact': テキスト検索で大文字小文字を区別する場合は 1 -** 'text_search_found': テキストが見つかった場合は 1、そうでない場合は 0 +** _text_search_exact_: テキスト検索で大文字小文字を区別する場合は 1 +** _text_search_found_: テキストが見つかった場合は 1、そうでない場合は 0 戻り値: @@ -11143,24 +11143,24 @@ const char *weechat_buffer_get_string (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'property': プロパティ名: -** 'plugin': バッファを作成したプラグインの名前 +* _buffer_: バッファへのポインタ +* _property_: プロパティ名: +** _plugin_: バッファを作成したプラグインの名前 ("core" は WeeChat メインバッファ) -** 'name': バッファの名前 -** 'full_name': バッファの完全な名前 ("plugin.name") _(WeeChat バージョン 0.3.7 以上で利用可)_ -** 'short_name': バッファの短縮名 (注意: - 表示目的以外に使用するのは禁止、ユーザは書き換えることが可能、バッファを検索する際にこれを使ってはいけない、'name' 、'full_name' 、またはローカル変数 - 'channel' を使うこと) -** 'title': バッファのタイトル -** 'input': 入力テキスト -** 'text_search_input': テキスト検索前に保存した入力テキスト -** 'highlight_words': ハイライトする単語のリスト -** 'highlight_regex': ハイライト用の POSIX 拡張正規表現 -** 'highlight_tags_restrict': これらのタグを付けられたメッセージだけにハイライトを制限する -** 'highlight_tags': これらのタグを付けられたメッセージを強制的にハイライトする -** 'hotlist_max_level_nicks': 一部のニックネームに対するホットリストレベルの最大値 -** 'localvar_xxx': ローカル変数 "xxx" の値 +** _name_: バッファの名前 +** _full_name_: バッファの完全な名前 ("plugin.name") _(WeeChat バージョン 0.3.7 以上で利用可)_ +** _short_name_: バッファの短縮名 (注意: + 表示目的以外に使用するのは禁止、ユーザは書き換えることが可能、バッファを検索する際にこれを使ってはいけない、_name_ 、_full_name_ 、またはローカル変数 + _channel_ を使うこと) +** _title_: バッファのタイトル +** _input_: 入力テキスト +** _text_search_input_: テキスト検索前に保存した入力テキスト +** _highlight_words_: ハイライトする単語のリスト +** _highlight_regex_: ハイライト用の POSIX 拡張正規表現 +** _highlight_tags_restrict_: これらのタグを付けられたメッセージだけにハイライトを制限する +** _highlight_tags_: これらのタグを付けられたメッセージを強制的にハイライトする +** _hotlist_max_level_nicks_: 一部のニックネームに対するホットリストレベルの最大値 +** _localvar_xxx_: ローカル変数 "xxx" の値 ("xxx" は読み出す変数の名前) 戻り値: @@ -11203,11 +11203,11 @@ void *weechat_buffer_pointer (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'property': プロパティ名: -** 'plugin': このバッファを作ったプラグインへのポインタ +* _buffer_: バッファへのポインタ +* _property_: プロパティ名: +** _plugin_: このバッファを作ったプラグインへのポインタ (WeeChat メインバッファの場合は NULL) -** 'highlight_regex_compiled': コンパイル済みの正規表現 'highlight_regex' +** _highlight_regex_compiled_: コンパイル済みの正規表現 _highlight_regex_ 戻り値: @@ -11246,9 +11246,9 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, 引数: -* 'buffer': バッファへのポインタ -* 'property': プロパティ名 (以下の表を参照) -* 'value': プロパティの新しい値 +* _buffer_: バッファへのポインタ +* _property_: プロパティ名 (以下の表を参照) +* _value_: プロパティの新しい値 プロパティ: @@ -11292,7 +11292,7 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, | type | "formatted" または "free" | バッファのタイプを設定: "formatted" (チャットメッセージ用)、または - "free" (自由内容用); 値が "free" の場合、'clear' プロパティは強制的に + "free" (自由内容用); 値が "free" の場合、_clear_ プロパティは強制的に "0" に設定されます _(WeeChat バージョン 1.0 以上で利用可)_ | notify | "0", "1", "2", "3" | @@ -11373,11 +11373,11 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, ホットリストの最大レベルから削除するニックネームのコンマ区切りリスト | key_bind_xxx | 任意の文字列 | - 指定したバッファに対して新しいキー 'xxx' + 指定したバッファに対して新しいキー _xxx_ を割り当てる、値はキーを押して実行するコマンド | key_unbind_xxx | - | - 指定したバッファに対してキー 'xxx' の割り当てを解除する + 指定したバッファに対してキー _xxx_ の割り当てを解除する | input | 任意の文字列 | バッファ入力に新しい値を設定 @@ -11391,11 +11391,11 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property, を入力した場合、バッファはこれを受け入れる (未定義のコマンドに対するエラーを出さない) | localvar_set_xxx | 任意の文字列 | - ローカル変数 'xxx' の新しい値を設定 + ローカル変数 _xxx_ の新しい値を設定 (存在しない変数の場合は変数を作成する) | localvar_del_xxx | - | - ローカル変数 'xxx' を削除 + ローカル変数 _xxx_ を削除 |=== C 言語での使用例: @@ -11457,17 +11457,17 @@ void weechat_buffer_set_pointer (struct t_gui_buffer *buffer, const char *proper 引数: -* 'buffer': バッファへのポインタ -* 'property': プロパティ名: -** 'close_callback': バッファを閉じる際に呼び出すコールバック関数を設定 -** 'close_callback_data': バッファを閉じる際に呼び出すコールバック関数に渡すデータを設定 -** 'input_callback': 入力テキストをバッファに挿入する際に呼び出すコールバック関数を設定 -** 'input_callback_data': 入力テキストをバッファに挿入する際に呼び出すコールバック関数に渡すデータを設定 -** 'nickcmp_callback': ニックネーム比較コールバック関数を設定 +* _buffer_: バッファへのポインタ +* _property_: プロパティ名: +** _close_callback_: バッファを閉じる際に呼び出すコールバック関数を設定 +** _close_callback_data_: バッファを閉じる際に呼び出すコールバック関数に渡すデータを設定 +** _input_callback_: 入力テキストをバッファに挿入する際に呼び出すコールバック関数を設定 +** _input_callback_data_: 入力テキストをバッファに挿入する際に呼び出すコールバック関数に渡すデータを設定 +** _nickcmp_callback_: ニックネーム比較コールバック関数を設定 (ニックネームリストからニックネームを検索する際にこのコールバックを使用) _(WeeChat バージョン 0.3.9 以上で利用可)_ -** 'nickcmp_callback_data': ニックネーム比較コールバック関数に渡すデータを設定 +** _nickcmp_callback_data_: ニックネーム比較コールバック関数に渡すデータを設定 _(WeeChat バージョン 0.3.9 以上で利用可)_ -* 'pointer': プロパティの新しいポインタ値 +* _pointer_: プロパティの新しいポインタ値 コールバックのプロトタイプ: @@ -11515,8 +11515,8 @@ char *weechat_buffer_string_replace_local_var (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'string': テキストおよび書式 "$var" のローカル変数を含む文字列 +* _buffer_: バッファへのポインタ +* _string_: テキストおよび書式 "$var" のローカル変数を含む文字列 戻り値: @@ -11561,11 +11561,11 @@ int weechat_buffer_match_list (struct t_gui_buffer *buffer, const char *string); 引数: -* 'buffer': バッファへのポインタ -* 'string': バッファのコンマ区切りリスト: -** "*" 任意のバッファにマッチ -** 名前の最初に "!" がある場合はその名前を含まない場合にマッチ -** 名前にワイルドカード "*" を使うことができます +* _buffer_: バッファへのポインタ +* _string_: バッファのコンマ区切りリスト: +** `+*+` 任意のバッファにマッチ +** 名前の最初に `+!+` がある場合はその名前を含まない場合にマッチ +** 名前にワイルドカード `+*+` を使うことができます 戻り値: @@ -11654,7 +11654,7 @@ struct t_gui_window *weechat_window_search_with_buffer (struct t_gui_buffer *buf 引数: -* 'buffer': バッファへのポインタ +* _buffer_: バッファへのポインタ 戻り値: @@ -11695,25 +11695,25 @@ int weechat_window_get_integer (struct t_gui_window *window, 引数: -* 'window': ウィンドウへのポインタ -* 'property': プロパティ名: -** 'number': ウィンドウ番号 (1 以上) -** 'win_x': 端末内でのウィンドウの X 座標 (1 列目は 0) -** 'win_y': 端末内でのウィンドウの Y 座標 (1 行目は 0) -** 'win_width': ウィンドウの横幅、文字単位 -** 'win_height': ウィンドウの縦幅、文字単位 -** 'win_width_pct': ウィンドウ横幅の百分率、親ウィンドウに対する割合 +* _window_: ウィンドウへのポインタ +* _property_: プロパティ名: +** _number_: ウィンドウ番号 (1 以上) +** _win_x_: 端末内でのウィンドウの X 座標 (1 列目は 0) +** _win_y_: 端末内でのウィンドウの Y 座標 (1 行目は 0) +** _win_width_: ウィンドウの横幅、文字単位 +** _win_height_: ウィンドウの縦幅、文字単位 +** _win_width_pct_: ウィンドウ横幅の百分率、親ウィンドウに対する割合 (例えば 50 は半分を意味する) -** 'win_height_pct': ウィンドウ縦幅の百分率、親ウィンドウに対する割合 +** _win_height_pct_: ウィンドウ縦幅の百分率、親ウィンドウに対する割合 (例えば 50 は半分を意味する) -** 'win_chat_x': チャットウィンドウの X 座標 (1 列目は 0) -** 'win_chat_y': チャットウィンドウの Y 座標 (1 行目は 0) -** 'win_chat_width': チャットウィンドウの横幅、文字単位 -** 'win_chat_height': チャットウィンドウの縦幅、文字単位 -** 'first_line_displayed': バッファの 1 +** _win_chat_x_: チャットウィンドウの X 座標 (1 列目は 0) +** _win_chat_y_: チャットウィンドウの Y 座標 (1 行目は 0) +** _win_chat_width_: チャットウィンドウの横幅、文字単位 +** _win_chat_height_: チャットウィンドウの縦幅、文字単位 +** _first_line_displayed_: バッファの 1 行目が画面に表示されている場合は 1、そうでなければ 0 -** 'scrolling': ウィンドウでスクロールが有効化されている場合 (最後の行が表示されていない場合) は 1 -** 'lines_after': バッファの最終行を表示した後にバッファに追加された行の数 +** _scrolling_: ウィンドウでスクロールが有効化されている場合 (最後の行が表示されていない場合) は 1 +** _lines_after_: バッファの最終行を表示した後にバッファに追加された行の数 (スクロール中) 戻り値: @@ -11759,8 +11759,8 @@ int weechat_window_get_string (struct t_gui_window *window, 引数: -* 'window': ウィンドウへのポインタ -* 'property': プロパティ名 +* _window_: ウィンドウへのポインタ +* _property_: プロパティ名 戻り値: @@ -11780,10 +11780,10 @@ void *weechat_window_get_pointer (struct t_gui_window *window, 引数: -* 'window': ウィンドウへのポインタ -* 'property': プロパティ名: -** 'current': 現在のウィンドウへのポインタ -** 'buffer': 指定したウィンドウが表示しているバッファへのポインタ +* _window_: ウィンドウへのポインタ +* _property_: プロパティ名: +** _current_: 現在のウィンドウへのポインタ +** _buffer_: 指定したウィンドウが表示しているバッファへのポインタ 戻り値: @@ -11823,7 +11823,7 @@ void weechat_window_set_title (const char *title); 引数: -* 'title': 端末の新しいタイトル (タイトルをリセットする場合は NULL) +* _title_: 端末の新しいタイトル (タイトルをリセットする場合は NULL) C 言語での使用例: @@ -11865,20 +11865,20 @@ struct t_gui_nick_group *weechat_nicklist_add_group (struct t_gui_buffer *buffer 引数: -* 'buffer': バッファへのポインタ -* 'parent_group': グループの親へのポインタ、グループに親がない場合 NULL +* _buffer_: バッファへのポインタ +* _parent_group_: グループの親へのポインタ、グループに親がない場合 NULL (ニックネームリスト) -* 'name': グループ名 -* 'color': 色オプション名: -** WeeChat オプション名、例えば 'weechat.color.nicklist_group' -** 任意で背景色をつけた色、例えば 'yellow' や 'yellow,red' +* _name_: グループ名 +* _color_: 色オプション名: +** WeeChat オプション名、例えば _weechat.color.nicklist_group_ +** 任意で背景色をつけた色、例えば _yellow_ や _yellow,red_ ** バーの色名: -*** 'bar_fg': バーの前景色 -*** 'bar_delim': バーの区切り文字 -*** 'bar_bg': バーの背景色 -* 'visible': -** '1': グループとサブグループおよびニックネームを表示 -** '0': グループとサブグループおよびニックネームを非表示 +*** _bar_fg_: バーの前景色 +*** _bar_delim_: バーの区切り文字 +*** _bar_bg_: バーの背景色 +* _visible_: +** _1_: グループとサブグループおよびニックネームを表示 +** _0_: グループとサブグループおよびニックネームを非表示 [NOTE] グループ名の前に、1 @@ -11929,10 +11929,10 @@ struct t_gui_nick_group *weechat_nicklist_search_group (struct t_gui_buffer *buf 引数: -* 'buffer': バッファへのポインタ -* 'from_group': +* _buffer_: バッファへのポインタ +* _from_group_: このグループのみを検索、全てのニックネームリストから検索する場合は NULL -* 'name': 検索するグループ名 +* _name_: 検索するグループ名 戻り値: @@ -11976,27 +11976,27 @@ struct t_gui_nick_group *weechat_nicklist_add_nick (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': グループへのポインタ -* 'name': ニックネーム -* 'color': 色オプション名: -*** WeeChat オプション名 (weechat.color.xxx のオプション部分)、例えば 'chat_delimiters' -*** 任意で背景色をつけた色、例えば 'yellow' や 'yellow,red' +* _buffer_: バッファへのポインタ +* _group_: グループへのポインタ +* _name_: ニックネーム +* _color_: 色オプション名: +*** WeeChat オプション名 (weechat.color.xxx のオプション部分)、例えば _chat_delimiters_ +*** 任意で背景色をつけた色、例えば _yellow_ や _yellow,red_ *** バーの色名: -**** 'bar_fg': バーの前景色 -**** 'bar_delim': バーの区切り文字 -**** 'bar_bg': バーの背景色 -* 'prefix': ニックネームの前に表示するプレフィックス -* 'prefix_color': 色オプション名: -** WeeChat オプション名 (weechat.color.xxx のオプション部分)、例えば 'chat_delimiters' -** 任意で背景色をつけた色、例えば 'yellow' や 'yellow,red' +**** _bar_fg_: バーの前景色 +**** _bar_delim_: バーの区切り文字 +**** _bar_bg_: バーの背景色 +* _prefix_: ニックネームの前に表示するプレフィックス +* _prefix_color_: 色オプション名: +** WeeChat オプション名 (weechat.color.xxx のオプション部分)、例えば _chat_delimiters_ +** 任意で背景色をつけた色、例えば _yellow_ や _yellow,red_ ** バーの色名: -*** 'bar_fg': バーの前景色 -*** 'bar_delim': バーの区切り文字 -*** 'bar_bg': バーの背景色 -* 'visible': -** '1': ニックネームを表示 -** '0': ニックネームを非表示 +*** _bar_fg_: バーの前景色 +*** _bar_delim_: バーの区切り文字 +*** _bar_bg_: バーの背景色 +* _visible_: +** _1_: ニックネームを表示 +** _0_: ニックネームを非表示 戻り値: @@ -12044,10 +12044,10 @@ struct t_gui_nick *weechat_nicklist_search_nick (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'from_group': +* _buffer_: バッファへのポインタ +* _from_group_: このグループのみを検索、全てのニックネームリストから検索する場合は NULL -* 'name': 検索するニックネーム +* _name_: 検索するニックネーム 戻り値: @@ -12086,8 +12086,8 @@ void weechat_nicklist_remove_group (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': 削除するグループへのポインタ (同時に全てのサブグループおよびニックネームを削除) +* _buffer_: バッファへのポインタ +* _group_: 削除するグループへのポインタ (同時に全てのサブグループおよびニックネームを削除) C 言語での使用例: @@ -12121,8 +12121,8 @@ void weechat_nicklist_remove_nick (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'nick': 削除するニックネームへのポインタ +* _buffer_: バッファへのポインタ +* _nick_: 削除するニックネームへのポインタ C 言語での使用例: @@ -12155,7 +12155,7 @@ void weechat_nicklist_remove_all (struct t_gui_buffer *buffer); 引数: -* 'buffer': バッファへのポインタ +* _buffer_: バッファへのポインタ C 言語での使用例: @@ -12192,9 +12192,9 @@ void weechat_nicklist_get_next_item (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': グループへのポインタへのポインタ -* 'nick': ニックネームへのポインタへのポインタ +* _buffer_: バッファへのポインタ +* _group_: グループへのポインタへのポインタ +* _nick_: ニックネームへのポインタへのポインタ C 言語での使用例: @@ -12242,11 +12242,11 @@ int weechat_nicklist_group_get_integer (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': グループへのポインタ -* 'property': プロパティ名: -** 'visible': グループが表示されている場合は 1、そうでない場合は 0 -** 'level': グループレベル (ルートは 0) +* _buffer_: バッファへのポインタ +* _group_: グループへのポインタ +* _property_: プロパティ名: +** _visible_: グループが表示されている場合は 1、そうでない場合は 0 +** _level_: グループレベル (ルートは 0) 戻り値: @@ -12287,11 +12287,11 @@ const char *weechat_nicklist_group_get_string (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': グループへのポインタ -* 'property': プロパティ名: -** 'name': グループの名前 -** 'color': ニックネームリストのグループ色 +* _buffer_: バッファへのポインタ +* _group_: グループへのポインタ +* _property_: プロパティ名: +** _name_: グループの名前 +** _color_: ニックネームリストのグループ色 戻り値: @@ -12332,10 +12332,10 @@ void *weechat_nicklist_group_get_pointer (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': グループへのポインタ -* 'property': プロパティ名: -** 'parent': 親グループへのポインタ +* _buffer_: バッファへのポインタ +* _group_: グループへのポインタ +* _property_: プロパティ名: +** _parent_: 親グループへのポインタ 戻り値: @@ -12377,10 +12377,10 @@ void weechat_nicklist_group_set (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'group': グループへのポインタ -* 'property': プロパティ名 (以下の表を参照) -* 'value': プロパティの新しい値 +* _buffer_: バッファへのポインタ +* _group_: グループへのポインタ +* _property_: プロパティ名 (以下の表を参照) +* _value_: プロパティの新しい値 プロパティ: @@ -12446,10 +12446,10 @@ int weechat_nicklist_nick_get_integer (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'nick': ニックネームへのポインタ -* 'property': プロパティ名: -** 'visible': 表示状態のニックネームの場合 1、それ以外の場合は 0 +* _buffer_: バッファへのポインタ +* _nick_: ニックネームへのポインタ +* _property_: プロパティ名: +** _visible_: 表示状態のニックネームの場合 1、それ以外の場合は 0 戻り値: @@ -12490,13 +12490,13 @@ const char *weechat_nicklist_nick_get_string (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのプロパティ -* 'nick': ニックネームへのポインタ -* 'property': プロパティ名: -** 'name': ニックネームの名前 -** 'color': ニックネームリスト内でのニックネームの色 -** 'prefix': ニックネームのプレフィックス -** 'prefix_color': ニックネームリスト内でのプレフィックスの色 +* _buffer_: バッファへのプロパティ +* _nick_: ニックネームへのポインタ +* _property_: プロパティ名: +** _name_: ニックネームの名前 +** _color_: ニックネームリスト内でのニックネームの色 +** _prefix_: ニックネームのプレフィックス +** _prefix_color_: ニックネームリスト内でのプレフィックスの色 戻り値: @@ -12537,10 +12537,10 @@ void *weechat_nicklist_nick_get_pointer (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'nick': ニックネームへのポインタ -* 'property': プロパティ名: -** 'group': 指定したニックネームを含むグループへのポインタ +* _buffer_: バッファへのポインタ +* _nick_: ニックネームへのポインタ +* _property_: プロパティ名: +** _group_: 指定したニックネームを含むグループへのポインタ 戻り値: @@ -12582,10 +12582,10 @@ void weechat_nicklist_nick_set (struct t_gui_buffer *buffer, 引数: -* 'buffer': バッファへのポインタ -* 'nick': ニックネームへのポインタ -* 'property': プロパティ名 (以下の表を参照) -* 'value': プロパティの新しい値 +* _buffer_: バッファへのポインタ +* _nick_: ニックネームへのポインタ +* _property_: プロパティ名 (以下の表を参照) +* _value_: プロパティの新しい値 プロパティ: @@ -12665,7 +12665,7 @@ struct t_gui_bar_item *weechat_bar_item_search (const char *name); 引数: -* 'name': バー要素の名前 +* _name_: バー要素の名前 戻り値: @@ -12712,23 +12712,23 @@ struct t_gui_bar_item *weechat_bar_item_new (const char *name, 引数: -* 'name': バー要素の名前 -* 'build_callback': +* _name_: バー要素の名前 +* _build_callback_: バー要素を作成する際に呼び出すコールバック関数、引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_gui_bar_item *item': 要素へのポインタ -** 'struct t_gui_window *window': +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_gui_bar_item *item_: 要素へのポインタ +** _struct t_gui_window *window_: ウィンドウへのポインタ (ルートバーの場合は NULL) -** 'struct t_gui_buffer *buffer': ウィンドウに表示されているバッファ +** _struct t_gui_buffer *buffer_: ウィンドウに表示されているバッファ (ウィンドウが NULL の場合、現在のバッファ) または以下の構文で指定したバー要素に含まれるバッファ: "@buffer:item" _(WeeChat バージョン 0.4.2 以上で利用可)_ -** 'struct t_hashtable *extra_info': 常に NULL +** _struct t_hashtable *extra_info_: 常に NULL (この引数は将来のバージョン用に予約されています) _(WeeChat バージョン 0.4.2 以上で利用可)_ ** 戻り値: バー要素の内容 -* 'build_callback_pointer': WeeChat が 'build_callback' +* _build_callback_pointer_: WeeChat が _build_callback_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'build_callback_data': WeeChat が 'build_callback' コールバックを呼び出す際にコールバックに渡すポインタ +* _build_callback_data_: WeeChat が _build_callback_ コールバックを呼び出す際にコールバックに渡すポインタ このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはここで作成したバー要素が削除された時点で自動的に開放されます @@ -12759,7 +12759,7 @@ struct t_gui_bar_item *my_item = weechat_bar_item_new ("myitem", [IMPORTANT] WeeChat バージョン 0.4.1 以下に対する互換性のために、デフォルトのコールバックに渡す引数の個数は -3 個です: 'data' 、'item' 、'window' ('buffer' と 'extra_info' は渡されません)。 + +3 個です: _data_ 、_item_ 、_window_ (_buffer_ と _extra_info_ は渡されません)。 + 全ての引数を受け取るコールバックを使う場合は、名前の前に "(extra)" をつけてください、以下の例を参照 (WeeChat バージョン 0.4.2 以上で利用可)。 @@ -12783,7 +12783,7 @@ bar_item2 = weechat.bar_item_new("(extra)myitem2", "my_build_callback2", "") # ==== bar_item_update -'build_callback' コールバックを呼び出してバー要素の内容を更新。 +_build_callback_ コールバックを呼び出してバー要素の内容を更新。 プロトタイプ: @@ -12794,7 +12794,7 @@ void weechat_bar_item_update (const char *name); 引数: -* 'name': バー要素の名前 +* _name_: バー要素の名前 C 言語での使用例: @@ -12827,7 +12827,7 @@ void weechat_bar_item_remove (struct t_gui_bar_item *item); 引数: -* 'item': バー要素へのポインタ +* _item_: バー要素へのポインタ C 言語での使用例: @@ -12860,7 +12860,7 @@ struct t_gui_bar *weechat_bar_search (const char *name); 引数: -* 'name': バーの名前 +* _name_: バーの名前 戻り値: @@ -12911,39 +12911,39 @@ struct t_gui_bar *weechat_bar_new (const char *name, 引数: -* 'name': バーの名前 -* 'hidden': -** 'on': バーを非表示 -** 'off': バーを表示 -* 'priority': バーの優先度 (整数) -* 'type': -** 'root': ウィンドウの外に 1 回だけ表示されたバー -** 'window': 各ウィンドウに表示されたバー -* 'condition': バーの表示位置: -** 'active': アクティブウィンドウのみに表示されているバー -** 'inactive': 非アクティブウィンドウのみに表示されているバー -** 'nicklist': ニックネームリストを持つウィンドウに表示されているバー -** 評価された式: 'WeeChat ユーザガイド' のバーに関する章を参照 -* 'position': 'top' 、'bottom' 、'left' 、'right' -* 'filling_top_bottom': -** 'horizontal': 要素は水平方向に詰め込まれている (各要素の後に間隔) -** 'vertical': 要素は垂直方向に詰め込まれている (各要素の後に行) -** 'columns_horizontal': 要素は水平方向に詰め込まれている、列と一緒に表示 -** 'columns_vertical': 要素は垂直方向に詰め込まれている、列と一緒に表示 -* 'filling_left_right': -** 'horizontal': 要素は水平方向に詰め込まれている (各要素の後に間隔) -** 'vertical': 要素は垂直方向に詰め込まれている (各要素の後に行) -** 'columns_horizontal': 要素は水平方向に詰め込まれている、列と一緒に表示 -** 'columns_vertical': 要素は垂直方向に詰め込まれている、列と一緒に表示 -* 'size': バーのサイズ、文字単位 (0 は自動サイズ) -* 'size_max': バーの最大サイズ (0 は最大サイズが指定されていない) -* 'color_fg': バーのテキスト色 -* 'color_delim': バーの区切り文字の色 -* 'color_bg': バーの背景色 -* 'separator': -** 'on': バーには他のウィンドウおよびバーとの区切り行がある -** 'off': 区切り無し -* 'items': バーの要素のリスト、コンマ (要素の間に間隔)、または +* _name_: バーの名前 +* _hidden_: +** _on_: バーを非表示 +** _off_: バーを表示 +* _priority_: バーの優先度 (整数) +* _type_: +** _root_: ウィンドウの外に 1 回だけ表示されたバー +** _window_: 各ウィンドウに表示されたバー +* _condition_: バーの表示位置: +** _active_: アクティブウィンドウのみに表示されているバー +** _inactive_: 非アクティブウィンドウのみに表示されているバー +** _nicklist_: ニックネームリストを持つウィンドウに表示されているバー +** 評価された式: _WeeChat ユーザガイド_ のバーに関する章を参照 +* _position_: _top_ 、_bottom_ 、_left_ 、_right_ +* _filling_top_bottom_: +** _horizontal_: 要素は水平方向に詰め込まれている (各要素の後に間隔) +** _vertical_: 要素は垂直方向に詰め込まれている (各要素の後に行) +** _columns_horizontal_: 要素は水平方向に詰め込まれている、列と一緒に表示 +** _columns_vertical_: 要素は垂直方向に詰め込まれている、列と一緒に表示 +* _filling_left_right_: +** _horizontal_: 要素は水平方向に詰め込まれている (各要素の後に間隔) +** _vertical_: 要素は垂直方向に詰め込まれている (各要素の後に行) +** _columns_horizontal_: 要素は水平方向に詰め込まれている、列と一緒に表示 +** _columns_vertical_: 要素は垂直方向に詰め込まれている、列と一緒に表示 +* _size_: バーのサイズ、文字単位 (0 は自動サイズ) +* _size_max_: バーの最大サイズ (0 は最大サイズが指定されていない) +* _color_fg_: バーのテキスト色 +* _color_delim_: バーの区切り文字の色 +* _color_bg_: バーの背景色 +* _separator_: +** _on_: バーには他のウィンドウおよびバーとの区切り行がある +** _off_: 区切り無し +* _items_: バーの要素のリスト、コンマ (要素の間に間隔)、または "+" (要素の間に間隔を開けない) 区切り 戻り値: @@ -12999,11 +12999,11 @@ int weechat_bar_set (struct t_gui_bar *bar, const char *property, 引数: -* 'bar': バーへのポインタ -* 'property': name、hidden、priority、conditions、position、filling_top_bottom、filling_left_right、size、size_max、color_fg、color_delim、color_bg、separator、items +* _bar_: バーへのポインタ +* _property_: name、hidden、priority、conditions、position、filling_top_bottom、filling_left_right、size、size_max、color_fg、color_delim、color_bg、separator、items (<<_bar_new,weechat_bar_new>> を参照) -* 'value': プロパティの新しい値 +* _value_: プロパティの新しい値 戻り値: @@ -13040,7 +13040,7 @@ void weechat_bar_update (const char *name); 引数: -* 'name': バーの名前 +* _name_: バーの名前 C 言語での使用例: @@ -13073,7 +13073,7 @@ void weechat_bar_remove (struct t_gui_bar *bar); 引数: -* 'bar': バーへのポインタ +* _bar_: バーへのポインタ C 言語での使用例: @@ -13113,15 +13113,15 @@ int weechat_command (struct t_gui_buffer *buffer, const char *command); 引数: -* 'buffer': バッファへのポインタ +* _buffer_: バッファへのポインタ (コマンドは指定したバッファで実行されます、現在のバッファで実行するには NULL を指定してください) -* 'command': 実行するコマンド ("/" +* _command_: 実行するコマンド ("/" で始まっている場合)、またはバッファに送信するテキスト 戻り値: (_WeeChat バージョン 1.1 以上で利用可_) -* 'WEECHAT_RC_OK' 成功した場合 -* 'WEECHAT_RC_ERROR' エラーが起きた場合 +* _WEECHAT_RC_OK_ 成功した場合 +* _WEECHAT_RC_ERROR_ エラーが起きた場合 C 言語での使用例: @@ -13168,10 +13168,10 @@ int weechat_network_pass_proxy (const char *proxy, 引数: -* 'proxy': 使用するプロキシ名 -* 'sock': 使用するソケット -* 'address': アドレス (ホスト名または IP アドレス) -* 'port': ポート番号 +* _proxy_: 使用するプロキシ名 +* _sock_: 使用するソケット +* _address_: アドレス (ホスト名または IP アドレス) +* _port_: ポート番号 戻り値: @@ -13215,9 +13215,9 @@ int weechat_network_connect_to (const char *proxy, 引数: -* 'proxy': 使用するプロキシ名 -* 'address': 接続先のアドレス (ポート番号を含む) -* 'address_length': 引数 'address' の長さ +* _proxy_: 使用するプロキシ名 +* _address_: 接続先のアドレス (ポート番号を含む) +* _address_length_: 引数 _address_ の長さ 戻り値: @@ -13231,7 +13231,7 @@ struct sockaddr *addr; socklen_t length; int sock; -/* allocate/set address and port in 'addr', set 'length' */ +/* allocate/set address and port in _addr_, set _length_ */ /* ... */ sock = weechat_network_connect_to (NULL, addr, length); @@ -13266,8 +13266,8 @@ const char *weechat_info_get (const char *info_name, const char *arguments); 引数: -* 'info_name': 読み出すインフォの名前 (以下の表を参照) -* 'arguments': 指定したインフォに対する引数 +* _info_name_: 読み出すインフォの名前 (以下の表を参照) +* _arguments_: 指定したインフォに対する引数 (任意、引数を指定しない場合は NULL) 戻り値: @@ -13318,8 +13318,8 @@ struct t_hashtable *weechat_info_get_hashtable (const char *info_name, 引数: -* 'info_name': 読み出すインフォの名前 (以下の表を参照) -* 'hashtable': 引数を含むハッシュテーブル (指定したインフォに依存) +* _info_name_: 読み出すインフォの名前 (以下の表を参照) +* _hashtable_: 引数を含むハッシュテーブル (指定したインフォに依存) (任意、引数を指定しない場合は NULL) 戻り値: @@ -13371,7 +13371,7 @@ if (hashtable_in) [NOTE] "irc_message_parse" の出力に関するより詳しい内容を得るには -'WeeChat スクリプト作成ガイド' をご覧ください。 +_WeeChat スクリプト作成ガイド_ をご覧ください。 スクリプト (Python) での使用例: @@ -13397,11 +13397,11 @@ weechat.prnt("", "message parsed: %s" 各要素には型と値があり、以下の型を使うことができます: -* 'integer': 任意の整数値 -* 'string': 任意の文字列値 -* 'pointer': 任意のポインタ -* 'buffer': 任意のデータを含む固定長のバッファ -* 'time': 時刻値 +* _integer_: 任意の整数値 +* _string_: 任意の文字列値 +* _pointer_: 任意のポインタ +* _buffer_: 任意のデータを含む固定長のバッファ +* _time_: 時刻値 ==== infolist_new @@ -13449,7 +13449,7 @@ struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); 引数: -* 'infolist': インフォリストへのポインタ +* _infolist_: インフォリストへのポインタ 戻り値: @@ -13488,9 +13488,9 @@ struct t_infolist_var *weechat_infolist_new_var_integer (struct t_infolist_item 引数: -* 'item': インフォリストの要素へのポインタ -* 'name': 変数名 -* 'value': 整数値 +* _item_: インフォリストの要素へのポインタ +* _name_: 変数名 +* _value_: 整数値 戻り値: @@ -13531,9 +13531,9 @@ struct t_infolist_var *weechat_infolist_new_var_string (struct t_infolist_item * 引数: -* 'item': インフォリストの要素へのポインタ -* 'name': 変数名 -* 'value': 文字列値 +* _item_: インフォリストの要素へのポインタ +* _name_: 変数名 +* _value_: 文字列値 戻り値: @@ -13574,9 +13574,9 @@ struct t_infolist_var *weechat_infolist_new_var_pointer (struct t_infolist_item 引数: -* 'item': インフォリストの要素へのポインタ -* 'name': 変数名 -* 'pointer': ポインタ +* _item_: インフォリストの要素へのポインタ +* _name_: 変数名 +* _pointer_: ポインタ 戻り値: @@ -13618,10 +13618,10 @@ struct t_infolist_var *weechat_infolist_new_var_buffer (struct t_infolist_item * 引数: -* 'item': インフォリストの要素へのポインタ -* 'name': 変数名 -* 'pointer': バッファへのポインタ -* 'size': バッファのサイズ +* _item_: インフォリストの要素へのポインタ +* _name_: 変数名 +* _pointer_: バッファへのポインタ +* _size_: バッファのサイズ 戻り値: @@ -13657,9 +13657,9 @@ struct t_infolist_var *weechat_infolist_new_var_time (struct t_infolist_item *it 引数: -* 'item': インフォリストの要素へのポインタ -* 'name': 変数名 -* 'time': 時刻値 +* _item_: インフォリストの要素へのポインタ +* _name_: 変数名 +* _time_: 時刻値 戻り値: @@ -13707,10 +13707,10 @@ struct t_infolist *weechat_infolist_get (const char *infolist_name, 引数: -* 'infolist_name': 読み出すインフォリストの名前 (以下の表を参照) -* 'pointer': 要素へのポインタ、インフォリストからこの要素のみを取得する場合に指定 +* _infolist_name_: 読み出すインフォリストの名前 (以下の表を参照) +* _pointer_: 要素へのポインタ、インフォリストからこの要素のみを取得する場合に指定 (任意、NULL でも可) -* 'arguments': 指定したインフォリストに対する引数 +* _arguments_: 指定したインフォリストに対する引数 (任意、引数が不要の場合は NULL) 戻り値: @@ -13753,7 +13753,7 @@ int weechat_infolist_next (struct t_infolist *infolist); 引数: -* 'infolist': インフォリストへのポインタ +* _infolist_: インフォリストへのポインタ 戻り値: @@ -13802,7 +13802,7 @@ int weechat_infolist_prev (struct t_infolist *infolist); 引数: -* 'infolist': インフォリストへのポインタ +* _infolist_: インフォリストへのポインタ 戻り値: @@ -13851,7 +13851,7 @@ void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); 引数: -* 'infolist': インフォリストへのポインタ +* _infolist_: インフォリストへのポインタ C 言語での使用例: @@ -13887,8 +13887,8 @@ struct t_infolist_var *weechat_infolist_search_var (struct t_infolist *infolist, 引数: -* 'infolist': インフォリストへのポインタ -* 'name': 変数名 +* _infolist_: インフォリストへのポインタ +* _name_: 変数名 戻り値: @@ -13931,7 +13931,7 @@ const char *weechat_infolist_fields (struct t_infolist *infolist); 引数: -* 'infolist': インフォリストへのポインタ +* _infolist_: インフォリストへのポインタ 戻り値: @@ -13974,8 +13974,8 @@ int weechat_infolist_integer (struct t_infolist *infolist, const char *var); 引数: -* 'infolist': インフォリストへのポインタ -* 'var': 変数名 (必ず「整数」型) +* _infolist_: インフォリストへのポインタ +* _var_: 変数名 (必ず「整数」型) 戻り値: @@ -14013,8 +14013,8 @@ const char *weechat_infolist_string (struct t_infolist *infolist, const char *va 引数: -* 'infolist': インフォリストへのポインタ -* 'var': 変数名 (必ず「文字列」型) +* _infolist_: インフォリストへのポインタ +* _var_: 変数名 (必ず「文字列」型) 戻り値: @@ -14052,8 +14052,8 @@ void *weechat_infolist_pointer (struct t_infolist *infolist, const char *var); 引数: -* 'infolist': インフォリストへのポインタ -* 'var': 変数名 (必ず「ポインタ」型) +* _infolist_: インフォリストへのポインタ +* _var_: 変数名 (必ず「ポインタ」型) 戻り値: @@ -14092,9 +14092,9 @@ void *weechat_infolist_buffer (struct t_infolist *infolist, const char *var, 引数: -* 'infolist': インフォリストへのポインタ -* 'var': 変数名 (必ず「バッファ」型) -* 'size': 整数変数へのポインタ、バッファサイズを返す +* _infolist_: インフォリストへのポインタ +* _var_: 変数名 (必ず「バッファ」型) +* _size_: 整数変数へのポインタ、バッファサイズを返す 戻り値: @@ -14126,8 +14126,8 @@ time_t weechat_infolist_time (struct t_infolist *infolist, const char *var); 引数: -* 'infolist': インフォリストへのポインタ -* 'var': 変数名 (必ず「時刻」型) +* _infolist_: インフォリストへのポインタ +* _var_: 変数名 (必ず「時刻」型) 戻り値: @@ -14165,7 +14165,7 @@ void weechat_infolist_free (struct t_infolist *infolist); 引数: -* 'infolist': インフォリストへのポインタ +* _infolist_: インフォリストへのポインタ C 言語での使用例: @@ -14228,23 +14228,23 @@ struct t_hdata *weechat_hdata_new (const char *hdata_name, const char *var_prev, 引数: -* 'hdata_name': hdata の名前 -* 'var_prev': 構造体に含まれる変数名。構造体は配列の 1 つ前の要素へのポインタ +* _hdata_name_: hdata の名前 +* _var_prev_: 構造体に含まれる変数名。構造体は配列の 1 つ前の要素へのポインタ (変数が利用不可能な場合は NULL でも可) -* 'var_next': 構造体に含まれる変数名。構造体は配列の 1 つ後の要素へのポインタ +* _var_next_: 構造体に含まれる変数名。構造体は配列の 1 つ後の要素へのポインタ (変数が利用不可能な場合は NULL でも可) -* 'create_allowed': 構造体の作成を許可する場合は 1、それ以外の場合は 0 +* _create_allowed_: 構造体の作成を許可する場合は 1、それ以外の場合は 0 _(WeeChat バージョン 0.4.0 以上で利用可)_ -* 'delete_allowed': 構造体の削除を許可する場合は 1、それ以外の場合は 0 +* _delete_allowed_: 構造体の削除を許可する場合は 1、それ以外の場合は 0 _(WeeChat バージョン 0.3.9 以上で利用可)_ -* 'callback_update': hdata 内のデータを更新する際のコールバック関数、データの更新を禁止する場合は NULL +* _callback_update_: hdata 内のデータを更新する際のコールバック関数、データの更新を禁止する場合は NULL _(WeeChat バージョン 0.3.9 以上で利用可)_ 、引数と戻り値: -** 'void *data': ポインタ -** 'struct t_hdata *hdata': hdata へのポインタ -** 'struct t_hashtable *hashtable': 更新する変数を含むハッシュテーブル +** _void *data_: ポインタ +** _struct t_hdata *hdata_: hdata へのポインタ +** _struct t_hashtable *hashtable_: 更新する変数を含むハッシュテーブル (<<_hdata_update,weechat_hdata_update>> を参照) ** return value: 更新された変数の数 -* 'callback_update_data': WeeChat が 'callback_update' コールバックを呼び出す際にコールバックに渡すポインタ +* _callback_update_data_: WeeChat が _callback_update_ コールバックを呼び出す際にコールバックに渡すポインタ _(WeeChat バージョン 0.3.9 以上で利用可)_ 戻り値: @@ -14277,10 +14277,10 @@ void weechat_hdata_new_var (struct t_hdata *hdata, const char *name, int offset, 引数: -* 'hdata': hdata へのポインタ -* 'name': 変数名 -* 'offset': 構造体における変数のオフセット -* 'type': 変数型、以下の 1 つ: +* _hdata_: hdata へのポインタ +* _name_: 変数名 +* _offset_: 構造体における変数のオフセット +* _type_: 変数型、以下の 1 つ: ** WEECHAT_HDATA_CHAR ** WEECHAT_HDATA_INTEGER ** WEECHAT_HDATA_LONG @@ -14290,16 +14290,16 @@ void weechat_hdata_new_var (struct t_hdata *hdata, const char *name, int offset, ** WEECHAT_HDATA_TIME ** WEECHAT_HDATA_HASHTABLE ** WEECHAT_HDATA_OTHER -* 'update_allowed': 変数の更新を許可する場合は 1、禁止する場合は 0 +* _update_allowed_: 変数の更新を許可する場合は 1、禁止する場合は 0 _(WeeChat バージョン 0.3.9 以上で利用可)_ -* 'array_size': 配列でない場合は必ず NULL、配列の場合の値は: +* _array_size_: 配列でない場合は必ず NULL、配列の場合の値は: _(WeeChat バージョン 0.3.9 以上で利用可)_ ** hdata に含まれる変数の名前: 配列のサイズはこの名前の変数に収められている (配列サイズは動的に変化) ** 整数 (文字列): 配列のサイズは固定 -** '*': 自動サイズ: 配列のサイズは値の中に見つかる最初の NULL を元に計算されます +** _*_: 自動サイズ: 配列のサイズは値の中に見つかる最初の NULL を元に計算されます (文字列、ポインタ、ハッシュテーブル型以外では使えません) -* 'hdata_name': hdata の名前 (変数が hdata を含む構造体へのポインタの場合) +* _hdata_name_: hdata の名前 (変数が hdata を含む構造体へのポインタの場合) C 言語での使用例: @@ -14359,11 +14359,11 @@ void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *poin 引数: -* 'hdata': hdata へのポインタ -* 'name': 変数名 -* 'pointer': リストへのポインタ -* 'flags': 以下の値の組み合わせ: _(WeeChat バージョン 1.0 以上)_ -** 'WEECHAT_HDATA_LIST_CHECK_POINTERS': ポインタをチェックする際に使うリスト +* _hdata_: hdata へのポインタ +* _name_: 変数名 +* _pointer_: リストへのポインタ +* _flags_: 以下の値の組み合わせ: _(WeeChat バージョン 1.0 以上)_ +** _WEECHAT_HDATA_LIST_CHECK_POINTERS_: ポインタをチェックする際に使うリスト C 言語での使用例: @@ -14426,7 +14426,7 @@ struct t_hdata *weechat_hdata_get (const char *hdata_name); 引数: -* 'hdata_name': hdata の名前 +* _hdata_name_: hdata の名前 戻り値: @@ -14469,8 +14469,8 @@ int weechat_hdata_get_var_offset (struct t_hdata *hdata, const char *name); 引数: -* 'hdata': hdata へのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _name_: 変数名 戻り値: @@ -14509,8 +14509,8 @@ int weechat_hdata_get_var_type (struct t_hdata *hdata, const char *name); 引数: -* 'hdata': hdata へのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _name_: 変数名 戻り値: @@ -14574,8 +14574,8 @@ const char *weechat_hdata_get_var_type_string (struct t_hdata *hdata, const char 引数: -* 'hdata': hdata へのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _name_: 変数名 戻り値: @@ -14614,9 +14614,9 @@ int weechat_hdata_get_var_array_size (struct t_hdata *hdata, void *pointer, cons 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 戻り値: @@ -14656,9 +14656,9 @@ const char *weechat_hdata_get_var_array_size_string (struct t_hdata *hdata, void 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 戻り値: @@ -14698,8 +14698,8 @@ const char *weechat_hdata_get_var_hdata (struct t_hdata *hdata, const char *name 引数: -* 'hdata': hdata へのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _name_: 変数名 戻り値: @@ -14738,9 +14738,9 @@ void *weechat_hdata_get_var (struct t_hdata *hdata, void *pointer, const char *n 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 戻り値: @@ -14773,9 +14773,9 @@ void *weechat_hdata_get_var_at_offset (struct t_hdata *hdata, void *pointer, int 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 戻り値: @@ -14809,8 +14809,8 @@ void *weechat_hdata_get_list (struct t_hdata *hdata, const char *name); 引数: -* 'hdata': hdata へのポインタ -* 'name': リスト名 +* _hdata_: hdata へのポインタ +* _name_: リスト名 戻り値: @@ -14851,12 +14851,12 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe 引数: -* 'hdata': hdata へのポインタ -* 'list': リストポインタ; NULL の場合 _(WeeChat バージョン 1.0 以上)_ 、ポインタは +* _hdata_: hdata へのポインタ +* _list_: リストポインタ; NULL の場合 _(WeeChat バージョン 1.0 以上)_ 、ポインタは hdata に含まれる "check pointers" フラグを持つリストでチェックされます (<<_hdata_new_list,weechat_hdata_new_list>> を参照)、このフラグを持つリストがない場合、ポインタは妥当とされます。 -* 'pointer': 確認するポインタ +* _pointer_: 確認するポインタ 戻り値: @@ -14912,9 +14912,9 @@ void *weechat_hdata_move (struct t_hdata *hdata, void *pointer, int count); 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'count': 移動を実行する回数 +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _count_: 移動を実行する回数 (負および正の整数、ゼロは禁止) 戻り値: @@ -14959,7 +14959,7 @@ if buffer: _WeeChat バージョン 0.4.1 以上で利用可。_ -リストから要素を検索: リスト内の各要素に対して 'search' +リストから要素を検索: リスト内の各要素に対して _search_ の内容を評価し、マッチする要素が見つかるかリストの最後に到達するまでこれを続ける。 プロトタイプ: @@ -14971,12 +14971,12 @@ void *weechat_hdata_search (struct t_hdata *hdata, void *pointer, const char *se 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'search': 評価する式、式中のデフォルトポインタは hdata の名前 +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _search_: 評価する式、式中のデフォルトポインタは hdata の名前 (デフォルトポインタはリストに含まれる各要素で置換される); 式に関する詳細は - 'WeeChat ユーザガイド' のコマンド `/eval` を参照 -* 'move': 検索に失敗した後に移動を実行する回数 + _WeeChat ユーザガイド_ のコマンド `/eval` を参照 +* _move_: 検索に失敗した後に移動を実行する回数 (負および正の整数、ゼロは禁止) 戻り値: @@ -15030,9 +15030,9 @@ char weechat_hdata_char (struct t_hdata *hdata, void *pointer, const char *name) 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「文字型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「文字型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15072,9 +15072,9 @@ int weechat_hdata_integer (struct t_hdata *hdata, void *pointer, const char *nam 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「整数型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「整数型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15118,9 +15118,9 @@ long weechat_hdata_long (struct t_hdata *hdata, void *pointer, const char *name) 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「long 型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「long 型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15160,9 +15160,9 @@ const char *weechat_hdata_string (struct t_hdata *hdata, void *pointer, const ch 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「文字列型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「文字列型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15206,9 +15206,9 @@ void *weechat_hdata_pointer (struct t_hdata *hdata, void *pointer, const char *n 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「ポインタ型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「ポインタ型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15252,9 +15252,9 @@ time_t weechat_hdata_time (struct t_hdata *hdata, void *pointer, const char *nam 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「時刻型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「時刻型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15320,9 +15320,9 @@ struct t_hashtable *weechat_hdata_hashtable (struct t_hdata *hdata, void *pointe 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (必ず「ハッシュテーブル型」であること); 配列の場合、"N|name" +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (必ず「ハッシュテーブル型」であること); 配列の場合、"N|name" のように名前を指定することが可能。ここで N は配列のインデックス (1 番目は 0)、例: "2|name" 戻り値: @@ -15376,11 +15376,11 @@ int weechat_hdata_set (struct t_hdata *hdata, void *pointer, const char *name, c 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'name': 変数名 (許可されている型: 文字型、整数型、long +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _name_: 変数名 (許可されている型: 文字型、整数型、long 型、文字列型、ポインタ型、時刻型) -* 'value': 変数の新しい値 +* _value_: 変数の新しい値 戻り値: @@ -15411,9 +15411,9 @@ int weechat_hdata_update (struct t_hdata *hdata, void *pointer, struct t_hashtab 引数: -* 'hdata': hdata へのポインタ -* 'pointer': WeeChat および plugin オブジェクトへのポインタ -* 'hashtable': 更新する変数: +* _hdata_: hdata へのポインタ +* _pointer_: WeeChat および plugin オブジェクトへのポインタ +* _hashtable_: 更新する変数: キーは変数の名前、値は変数の新しい値 (キーと値は文字列)、以下の特別なキーを使うことができます: ** キー `__create_allowed` (値は任意): 構造体の作製を許可する場合は @@ -15497,23 +15497,23 @@ const char *weechat_hdata_get_string (struct t_hdata *hdata, const char *propert 引数: -* 'hdata': hdata へのポインタ -* 'property': プロパティ名: -** 'var_keys': hdata に含まれる変数のキーのリストを含む文字列 +* _hdata_: hdata へのポインタ +* _property_: プロパティ名: +** _var_keys_: hdata に含まれる変数のキーのリストを含む文字列 (書式: "key1,key2,key3") -** 'var_values': hdata に含まれる変数の値のリストを含む文字列 +** _var_values_: hdata に含まれる変数の値のリストを含む文字列 (書式: "value1,value2,value3") -** 'var_keys_values': hdata に含まれる変数のキーと値のリストを含む文字列 +** _var_keys_values_: hdata に含まれる変数のキーと値のリストを含む文字列 (書式: "key1:value1,key2:value2,key3:value3") -** 'var_prev': +** _var_prev_: 構造体に含まれる変数の名前、構造体はリスト内の 1 つ前の要素へのポインタ -** 'var_next': +** _var_next_: 構造体に含まれる変数の名前、構造体はリスト内の 1 つ後の要素へのポインタ -** 'list_keys': hdata に含まれるリストのキーのリストを含む文字列 +** _list_keys_: hdata に含まれるリストのキーのリストを含む文字列 (書式: "key1,key2,key3") -** 'list_values': hdata に含まれるリストの値のリストを含む文字列 +** _list_values_: hdata に含まれるリストの値のリストを含む文字列 (書式: "value1,value2,value3") -** 'list_keys_values': hdata に含まれるリストのキーと値のリストを含む文字列 +** _list_keys_values_: hdata に含まれるリストのキーと値のリストを含む文字列 (書式: "key1:value1,key2:value2,key3:value3") 戻り値: @@ -15567,21 +15567,21 @@ struct t_upgrade_file *upgrade_file_new (const char *filename, 引数: -* 'filename': ファイルの名前 (WeeChat +* _filename_: ファイルの名前 (WeeChat はこの名前に拡張子 ".upgrade" を追加します) -* 'callback_read': アップグレードファイル内の各オブジェクトを読み込む際に呼び出すコールバック関数 +* _callback_read_: アップグレードファイル内の各オブジェクトを読み込む際に呼び出すコールバック関数 引数と戻り値: -** 'const void *pointer': ポインタ -** 'void *data': ポインタ -** 'struct t_upgrade_file *upgrade_file': アップグレードファイルへのポインタ -** 'int object_id': オブジェクトの識別番号 -** 'struct t_infolist *infolist': オブジェクトの内容を含むインフォリスト +** _const void *pointer_: ポインタ +** _void *data_: ポインタ +** _struct t_upgrade_file *upgrade_file_: アップグレードファイルへのポインタ +** _int object_id_: オブジェクトの識別番号 +** _struct t_infolist *infolist_: オブジェクトの内容を含むインフォリスト ** 戻り値: -*** 'WEECHAT_RC_OK' -*** 'WEECHAT_RC_ERROR' -* 'callback_read_pointer': WeeChat が 'callback_read' +*** _WEECHAT_RC_OK_ +*** _WEECHAT_RC_ERROR_ +* _callback_read_pointer_: WeeChat が _callback_read_ コールバックを呼び出す際にコールバックに渡すポインタ -* 'callback_read_data': WeeChat が 'callback_read' コールバックを呼び出す際にコールバックに渡すポインタ; +* _callback_read_data_: WeeChat が _callback_read_ コールバックを呼び出す際にコールバックに渡すポインタ; このポインタが NULL でない場合、このポインタは malloc (または類似の関数) によって割り当てられたものでなければいけません。さらに、このポインタはアップグレードファイルが閉じられた時点で自動的に開放されます @@ -15623,9 +15623,9 @@ int weechat_upgrade_write_object (struct t_upgrade_file *upgrade_file, 引数: -* 'upgrade_file': アップグレードファイルへのポインタ -* 'object_id': オブジェクトの識別番号 -* 'infolist': ファイルに書き込むインフォリスト +* _upgrade_file_: アップグレードファイルへのポインタ +* _object_id_: オブジェクトの識別番号 +* _infolist_: ファイルに書き込むインフォリスト 戻り値: @@ -15671,7 +15671,7 @@ int weechat_upgrade_read (struct t_upgrade_file *upgrade_file); 引数: -* 'upgrade_file': アップグレードファイルへのポインタ +* _upgrade_file_: アップグレードファイルへのポインタ 戻り値: @@ -15708,7 +15708,7 @@ void weechat_upgrade_close (struct t_upgrade_file *upgrade_file); 引数: -* 'upgrade_file': アップグレードファイルへのポインタ +* _upgrade_file_: アップグレードファイルへのポインタ C 言語での使用例: |