summaryrefslogtreecommitdiff
path: root/doc/it
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2011-08-16 09:41:02 +0200
committerSebastien Helleu <flashcode@flashtux.org>2011-08-16 09:41:02 +0200
commit832d30b665604d856cd6abab431cc785ed0e7dd6 (patch)
tree0be5a9fc0f5bd9312212b5071f4a2910f343b4fb /doc/it
parenta234bc90ad2384f1efb067bbf7db801f5233c365 (diff)
downloadweechat-832d30b665604d856cd6abab431cc785ed0e7dd6.zip
core: add local variables of buffer in focus hashtable, remove irc_server/irc_channel from focus hashtable for nicklist
Diffstat (limited to 'doc/it')
-rw-r--r--doc/it/weechat_plugin_api.it.txt66
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/it/weechat_plugin_api.it.txt b/doc/it/weechat_plugin_api.it.txt
index feaf0ce95..0148f89ca 100644
--- a/doc/it/weechat_plugin_api.it.txt
+++ b/doc/it/weechat_plugin_api.it.txt
@@ -8331,43 +8331,45 @@ Content of hashtable sent to callback (keys and values are of type "string"):
[width="100%",cols="5m,5,8,3",options="header"]
|========================================
-| Key ^(1)^ | Description | Value examples | Value if N/A
-| _x | column on screen 2+| "0" ... "n"
-| _y | line on screen 2+| "0" ... "n"
-| _key | key or mouse event 2+| "button1", "button2-gesture-left", ...
-| _window | pointer to window | "0x12345678" | ""
-| _window_number | number of window | "1" ... "n" | "*"
-| _buffer | pointer to buffer | "0x12345678" | ""
-| _buffer_number | number of buffer | "1" ... "n" | "-1"
-| _buffer_plugin | plugin name of buffer | "core", "irc", ... | ""
-| _buffer_name | name of buffer | "weechat", "freenode.#weechat", ... | ""
-| _chat | chat area indicator | "0" or "1" | "0"
-| _chat_line_x | column in line ^(2)^ | "0" ... "n" | "-1"
-| _chat_line_y | line number ^(2)^ | "0" ... "n" | "-1"
-| _chat_line_date | line date | "1313237175" | "0"
-| _chat_line_date_printed | line date ^(3)^ | "1313237175" | "0"
-| _chat_line_time | time displayed | "14:06:15" | ""
-| _chat_line_tags | tags of line | "irc_privmsg,notify_message,nick_FlashCode,log1" | ""
-| _chat_line_nick | nick of line | "FlashCode" | ""
-| _chat_line_prefix | prefix of line | "@FlashCode" | ""
-| _chat_line_message | message of line | "Hello world!" | ""
-| _chat_word | word at (x,y) | "Hello" | ""
-| _chat_bol | beginning of line ⇒ (x-1,y) | "He" | ""
-| _chat_eol | (x,y) ⇒ end of line | "llo world!" | ""
-| _bar_name | name of bar | "title", "nicklist", ... | ""
-| _bar_filling | filling of bar | "horizontal", "vertical", ... | ""
-| _bar_item_name | name of bar item | "buffer_nicklist", "hotlist", ... | ""
-| _bar_item_line | line in bar item | "0" ... "n" | "-1"
-| _bar_item_col | column in bar item | "0" ... "n" | "-1"
+| Key ^(1)^ | Description | Value examples | Value if N/A
+| _x | column on screen 2+| "0" ... "n"
+| _y | line on screen 2+| "0" ... "n"
+| _key | key or mouse event 2+| "button1", "button2-gesture-left", ...
+| _window | pointer to window | "0x12345678" | ""
+| _window_number | number of window | "1" ... "n" | "*"
+| _buffer | pointer to buffer | "0x12345678" | ""
+| _buffer_number | number of buffer | "1" ... "n" | "-1"
+| _buffer_plugin | plugin name of buffer | "core", "irc", ... | ""
+| _buffer_name | name of buffer | "weechat", "freenode.#weechat", ... | ""
+| _buffer_localvar_XXX ^(2)^ | local variables of buffer | any value | not set
+| _chat | chat area indicator | "0" or "1" | "0"
+| _chat_line_x | column in line ^(3)^ | "0" ... "n" | "-1"
+| _chat_line_y | line number ^(3)^ | "0" ... "n" | "-1"
+| _chat_line_date | line date | "1313237175" | "0"
+| _chat_line_date_printed | line date ^(4)^ | "1313237175" | "0"
+| _chat_line_time | time displayed | "14:06:15" | ""
+| _chat_line_tags | tags of line | "irc_privmsg,notify_message,nick_FlashCode,log1" | ""
+| _chat_line_nick | nick of line | "FlashCode" | ""
+| _chat_line_prefix | prefix of line | "@FlashCode" | ""
+| _chat_line_message | message of line | "Hello world!" | ""
+| _chat_word | word at (x,y) | "Hello" | ""
+| _chat_bol | beginning of line ⇒ (x-1,y) | "He" | ""
+| _chat_eol | (x,y) ⇒ end of line | "llo world!" | ""
+| _bar_name | name of bar | "title", "nicklist", ... | ""
+| _bar_filling | filling of bar | "horizontal", "vertical", ... | ""
+| _bar_item_name | name of bar item | "buffer_nicklist", "hotlist", ... | ""
+| _bar_item_line | line in bar item | "0" ... "n" | "-1"
+| _bar_item_col | column in bar item | "0" ... "n" | "-1"
|========================================
[NOTE]
^(1)^ There are same keys suffixed with "2" (ie: "_x2", "_y2", "_window2", ...)
with info on second point (useful only for mouse gestures, to know where mouse
button has been released). +
-^(2)^ It is set only for buffers with free content. +
-^(3)^ It is date when WeeChat adds line in buffer (greater or equal to
-"chat_line_date").
+^(2)^ `XXX` is name of local variable in buffer. +
+^(3)^ It is set only for buffers with free content. +
+^(4)^ It is date when WeeChat adds line in buffer (greater or equal to
+"_chat_line_date").
Extra info for bar item "buffer_nicklist":
@@ -8378,8 +8380,6 @@ Extra info for bar item "buffer_nicklist":
| prefix | core | prefix for nick
| group | core | group name
| irc_host | irc | host for nick (if known)
-| irc_server | irc | internal name of server
-| irc_channel | irc | channel name
|========================================
[NOTE]