summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/dev/plugin_c_api.en.xml71
1 files changed, 54 insertions, 17 deletions
diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml
index 9dedc5718..caa5c8f02 100644
--- a/doc/en/dev/plugin_c_api.en.xml
+++ b/doc/en/dev/plugin_c_api.en.xml
@@ -4545,6 +4545,43 @@ char *value = weechat_config_get_plugin ("option");
</para>
</section>
+ <section id="secPluginCApi_weechat_config_is_set_plugin">
+ <title>weechat_config_is_set_plugin</title>
+
+ <para>
+ Prototype:
+<programlisting>
+int weechat_config_is_set_plugin (const char *option_name);
+</programlisting>
+ </para>
+ <para>
+ Check if option is set in plugins configuration file (plugins.conf).
+ </para>
+ <para>
+ Arguments:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <option>option_name</option>: option name, WeeChat will add
+ prefix "plugins.var.xxxx." (where xxxx is current plugin name).
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Return value: 1 if option is set, 0 if option does not exist.
+ </para>
+ <para>
+ Example:
+<screen>
+if (weechat_config_is_set_plugin ("option"))
+{
+ /* ... */
+}
+</screen>
+ </para>
+ </section>
+
<section id="secPluginCApi_weechat_config_set_plugin">
<title>weechat_config_set_plugin</title>
@@ -5137,7 +5174,7 @@ struct t_hook *weechat_hook_command (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -5249,7 +5286,7 @@ struct t_hook *weechat_hook_command_run (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -5348,7 +5385,7 @@ struct t_hook *weechat_hook_timer (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -5449,7 +5486,7 @@ struct t_hook *weechat_hook_fd (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -5554,7 +5591,7 @@ struct t_hook *weechat_hook_process (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -5717,7 +5754,7 @@ struct t_hook *weechat_hook_connect (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -5892,7 +5929,7 @@ struct t_hook *weechat_hook_print (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -6349,7 +6386,7 @@ struct t_hook *weechat_hook_signal (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -6483,7 +6520,7 @@ struct t_hook *weechat_hook_config (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -6585,7 +6622,7 @@ struct t_hook *weechat_hook_completion (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -6835,7 +6872,7 @@ struct t_hook *weechat_hook_modifier (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -6991,7 +7028,7 @@ struct t_hook *weechat_hook_info (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -7094,7 +7131,7 @@ struct t_hook *weechat_hook_infolist (
<listitem>
<para>
<option>callback_data</option>: pointer given to callback when it
- is called by WeeeChat
+ is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -7249,7 +7286,7 @@ struct t_gui_buffer *weechat_buffer_new (
<listitem>
<para>
<option>input_callback_data</option>: pointer given to input
- callback when it is called by WeeeChat
+ callback when it is called by WeeChat
</para>
</listitem>
<listitem>
@@ -7284,7 +7321,7 @@ struct t_gui_buffer *weechat_buffer_new (
<listitem>
<para>
<option>close_callback_data</option>: pointer given to close
- callback when it is called by WeeeChat
+ callback when it is called by WeeChat
</para>
</listitem>
</itemizedlist>
@@ -7748,7 +7785,7 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property,
<entry>display</entry>
<entry>"1", "auto"</entry>
<entry>
- swtich to this buffer in current window (if value is
+ switch to this buffer in current window (if value is
"auto", then it's considered as auto-switch and read
marker is not reset for current buffer)
</entry>
@@ -7822,7 +7859,7 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property,
<entry>"-" or comma separated list of words</entry>
<entry>
"-" is a special value to disable any highlight on this
- buffer, or comma separated list of words to higlkight
+ buffer, or comma separated list of words to highlight
in this buffer, for example: "abc,def,ghi"
</entry>
</row>