summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2010-12-20 10:13:37 +0100
committerSebastien Helleu <flashcode@flashtux.org>2010-12-20 10:13:37 +0100
commitcd7a02bec5ce87e8e1aa26b9fffc3caa0cda8ae8 (patch)
tree3b662ba9fec186745e48b24b4663555320f93575 /doc/en
parente80d6b93a557446a42bf5eb5826798be12c046f0 (diff)
downloadweechat-cd7a02bec5ce87e8e1aa26b9fffc3caa0cda8ae8.zip
Add 256 colors support
Changes: - new section "palette" in weechat.conf - new API functions: list_search_pos and list_casesearch_pos
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_plugin_api.en.txt84
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index 129ce8ff7..27535032b 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -2474,6 +2474,48 @@ item = weechat.list_search(list, data)
item = weechat.list_search(list, "my data")
----------------------------------------
+weechat_list_search_pos
+^^^^^^^^^^^^^^^^^^^^^^^
+
+_New in version 0.3.4._
+
+Search an item position in a list.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+int weechat_list_search_pos (struct t_weelist *weelist,
+ const char *data);
+----------------------------------------
+
+Arguments:
+
+* 'weelist': list pointer
+* 'data': data to search in list
+
+Return value:
+
+* position of item found, -1 if item was not found
+
+C example:
+
+[source,C]
+----------------------------------------
+int pos_item = weechat_list_search_pos (list, "my data");
+----------------------------------------
+
+Script (Python):
+
+[source,python]
+----------------------------------------
+# prototype
+pos_item = weechat.list_search_pos(list, data)
+
+# example
+pos_item = weechat.list_search_pos(list, "my data")
+----------------------------------------
+
weechat_list_casesearch
^^^^^^^^^^^^^^^^^^^^^^^
@@ -2514,6 +2556,48 @@ item = weechat.list_casesearch(list, data)
item = weechat.list_casesearch(list, "my data")
----------------------------------------
+weechat_list_casesearch_pos
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+_New in version 0.3.4._
+
+Search an item position in a list, ignoring case.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+int weechat_list_casesearch_pos (struct t_weelist *weelist,
+ const char *data);
+----------------------------------------
+
+Arguments:
+
+* 'weelist': list pointer
+* 'data': data to search in list
+
+Return value:
+
+* position of item found, -1 if item was not found
+
+C example:
+
+[source,C]
+----------------------------------------
+int pos_item = weechat_list_casesearch_pos (list, "my data");
+----------------------------------------
+
+Script (Python):
+
+[source,python]
+----------------------------------------
+# prototype
+pos_item = weechat.list_casesearch_pos(list, data)
+
+# example
+pos_item = weechat.list_casesearch_pos(list, "my data")
+----------------------------------------
+
weechat_list_get
^^^^^^^^^^^^^^^^