summaryrefslogtreecommitdiff
path: root/doc/en/weechat_plugin_api.en.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/weechat_plugin_api.en.asciidoc')
-rw-r--r--doc/en/weechat_plugin_api.en.asciidoc38
1 files changed, 33 insertions, 5 deletions
diff --git a/doc/en/weechat_plugin_api.en.asciidoc b/doc/en/weechat_plugin_api.en.asciidoc
index 4bf87734b..2b4ef5155 100644
--- a/doc/en/weechat_plugin_api.en.asciidoc
+++ b/doc/en/weechat_plugin_api.en.asciidoc
@@ -7087,6 +7087,8 @@ config, completion, modifier, info, info_hashtable, infolist, hdata, focus.
==== hook_command
+_Updated in 1.5._
+
Hook a command.
Prototype:
@@ -7221,6 +7223,8 @@ hook = weechat.hook_command("myfilter", "description of myfilter",
==== hook_command_run
+_Updated in 1.5._
+
Hook a command when WeeChat runs it.
Prototype:
@@ -7296,6 +7300,8 @@ hook = weechat.hook_command_run("/input complete*", "my_command_run_cb", "")
==== hook_timer
+_Updated in 1.5._
+
Hook a timer.
Prototype:
@@ -7369,7 +7375,7 @@ hook = weechat.hook_timer(20 * 1000, 0, 0, "my_timer_cb", "")
==== hook_fd
-_Updated in 1.3._
+_Updated in 1.3, 1.5._
Hook a file descriptor (file or socket).
@@ -7447,6 +7453,8 @@ hook = weechat.hook_fd(sock, 1, 0, 0, "my_fd_cb", "")
==== hook_process
+_Updated in 1.5._
+
Hook a process (launched with fork), and catch output.
[NOTE]
@@ -7592,7 +7600,7 @@ hook = weechat.hook_process("ls", 5000, "my_process_cb", "")
==== hook_process_hashtable
-_WeeChat ≥ 0.3.7._
+_WeeChat ≥ 0.3.7, updated in 1.5._
Hook a process (launched with fork) using options in a hashtable, and catch
output.
@@ -7799,6 +7807,8 @@ hook3 = weechat.hook_process_hashtable("sh",
==== hook_connect
+_Updated in 1.5._
+
Hook a connection (background connection to a remote host).
Prototype:
@@ -7975,7 +7985,7 @@ hook = weechat.hook_connect("", "my.server.org", 1234, 1, 0, "",
==== hook_print
-_Updated in 0.4.3 and 1.0._
+_Updated in 0.4.3, 1.0, 1.5._
Hook a message printed.
@@ -8082,6 +8092,8 @@ hook = weechat.hook_print("", "", "", 1, "my_print_cb", "")
==== hook_signal
+_Updated in 1.5._
+
Hook a signal.
Prototype:
@@ -9000,7 +9012,7 @@ weechat.hook_signal_send("irc_input_send", weechat.WEECHAT_HOOK_SIGNAL_STRING,
==== hook_hsignal
-_WeeChat ≥ 0.3.4._
+_WeeChat ≥ 0.3.4, updated in 1.5._
Hook a hsignal (signal with hashtable).
@@ -9365,6 +9377,8 @@ weechat.hook_hsignal_send("irc_redirect_pattern",
==== hook_config
+_Updated in 1.5._
+
Hook a configuration option.
Prototype:
@@ -9438,6 +9452,8 @@ hook = weechat.hook_config("weechat.look.item_time_format", "my_config_cb", "")
==== hook_completion
+_Updated in 1.5._
+
Hook a completion.
Prototype:
@@ -9629,6 +9645,8 @@ weechat.hook_completion_list_add(completion, word, nick_completion, where)
==== hook_modifier
+_Updated in 1.5._
+
Hook a modifier.
Prototype:
@@ -9870,6 +9888,8 @@ weechat.hook_modifier_exec("my_modifier", my_data, my_string)
==== hook_info
+_Updated in 1.5._
+
Hook an information (callback takes and returns a string).
Prototype:
@@ -9944,7 +9964,7 @@ hook = weechat.hook_info("my_info", "Some info", "Info about arguments",
==== hook_info_hashtable
-_WeeChat ≥ 0.3.4._
+_WeeChat ≥ 0.3.4, updated in 1.5._
Hook an information (callback takes and returns a hashtable).
@@ -10027,6 +10047,8 @@ hook = weechat.hook_info_hashtable("my_info_hashtable", "Some info",
==== hook_infolist
+_Updated in 1.5._
+
Hook an infolist: callback will return pointer to infolist asked.
Prototype:
@@ -10116,6 +10138,8 @@ hook = weechat.hook_infolist("my_infolist", "Infolist with some data",
==== hook_hdata
+_Updated in 1.5._
+
Hook a hdata: callback will return pointer to hdata asked.
Prototype:
@@ -10177,6 +10201,8 @@ This function is not available in scripting API.
==== hook_focus
+_Updated in 1.5._
+
Hook a focus: mouse event or key pressed in cursor mode (free movement of
cursor).
@@ -10493,6 +10519,8 @@ weechat.unhook(my_hook)
==== unhook_all
+_Updated in 1.5._
+
Unhook everything that has been hooked by current plugin.
Prototype: