summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2014-05-24 18:03:14 +0200
committerSébastien Helleu <flashcode@flashtux.org>2014-05-24 18:03:14 +0200
commit7aaf3be15bdb3ff2bd9815cc35bd1699c20ce7a6 (patch)
treedb50043debf82a51dbab4c73f27342dec36d2fee /doc
parent3092c09bc96438afb005c6ce11b07309a945ebc7 (diff)
downloadweechat-7aaf3be15bdb3ff2bd9815cc35bd1699c20ce7a6.zip
api: add argument "flags" in function hdata_new_list
Diffstat (limited to 'doc')
-rw-r--r--doc/en/weechat_plugin_api.en.txt21
-rw-r--r--doc/fr/weechat_plugin_api.fr.txt23
-rw-r--r--doc/it/weechat_plugin_api.it.txt25
-rw-r--r--doc/ja/weechat_plugin_api.ja.txt25
4 files changed, 62 insertions, 32 deletions
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index c28f3aa78..1e322c51d 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -13547,7 +13547,7 @@ This function is not available in scripting API.
==== weechat_hdata_new_list
-_WeeChat ≥ 0.3.6._
+_WeeChat ≥ 0.3.6, updated in 1.0._
Create a new list pointer in hdata.
@@ -13555,7 +13555,7 @@ Prototype:
[source,C]
----
-void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer);
+void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer, int flags);
----
Arguments:
@@ -13563,6 +13563,8 @@ 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
C example:
@@ -13590,16 +13592,16 @@ weechat_hdata_new_var (hdata, "string_split", offsetof (struct t_myplugin_list,
weechat_hdata_new_var (hdata, "prev", offsetof (struct t_myplugin_list, prev), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
weechat_hdata_new_var (hdata, "next", offsetof (struct t_myplugin_list, next), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
-weechat_hdata_new_list (hdata, "buffers", &buffers);
-weechat_hdata_new_list (hdata, "last_buffer", &last_buffer);
+weechat_hdata_new_list (hdata, "buffers", &buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+weechat_hdata_new_list (hdata, "last_buffer", &last_buffer, 0);
----
The macro "WEECHAT_HDATA_LIST" can be used to shorten code:
[source,C]
----
-WEECHAT_HDATA_LIST(buffers);
-WEECHAT_HDATA_LIST(last_buffer);
+WEECHAT_HDATA_LIST(buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+WEECHAT_HDATA_LIST(last_buffer, 0);
----
[NOTE]
@@ -14037,7 +14039,7 @@ buffers = weechat.hdata_get_list(hdata, "gui_buffers")
==== weechat_hdata_check_pointer
-_WeeChat ≥ 0.3.7._
+_WeeChat ≥ 0.3.7, updated in 1.0._
Check if a pointer is valid for a hdata and a list pointer.
@@ -14051,7 +14053,10 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe
Arguments:
* 'hdata': hdata pointer
-* 'list': list pointer
+* 'list': list pointer; if NULL _(WeeChat ≥ 1.0)_, the pointer is checked with
+ the lists in hdata that have flag "check pointers" (see
+ <<_weechat_hdata_new_list,weechat_hdata_new_list>>), and if no such list
+ exists, the pointer is considered as valid
* 'pointer': pointer to check
Return value:
diff --git a/doc/fr/weechat_plugin_api.fr.txt b/doc/fr/weechat_plugin_api.fr.txt
index 4dd6b7925..48fc2245a 100644
--- a/doc/fr/weechat_plugin_api.fr.txt
+++ b/doc/fr/weechat_plugin_api.fr.txt
@@ -13811,7 +13811,7 @@ Cette fonction n'est pas disponible dans l'API script.
==== weechat_hdata_new_list
-_WeeChat ≥ 0.3.6._
+_WeeChat ≥ 0.3.6, mis à jour dans la 1.0._
Créer un nouveau pointer vers une liste dans le hdata.
@@ -13819,7 +13819,7 @@ Prototype :
[source,C]
----
-void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer);
+void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer, int flags);
----
Paramètres :
@@ -13827,6 +13827,9 @@ 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
+ pointeurs
Exemple en C :
@@ -13854,16 +13857,16 @@ weechat_hdata_new_var (hdata, "string_split", offsetof (struct t_myplugin_list,
weechat_hdata_new_var (hdata, "prev", offsetof (struct t_myplugin_list, prev), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
weechat_hdata_new_var (hdata, "next", offsetof (struct t_myplugin_list, next), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
-weechat_hdata_new_list (hdata, "buffers", &buffers);
-weechat_hdata_new_list (hdata, "last_buffer", &last_buffer);
+weechat_hdata_new_list (hdata, "buffers", &buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+weechat_hdata_new_list (hdata, "last_buffer", &last_buffer, 0);
----
La macro "WEECHAT_HDATA_LIST" peut être utilisée pour raccourcir le code :
[source,C]
----
-WEECHAT_HDATA_LIST(buffers);
-WEECHAT_HDATA_LIST(last_buffer);
+WEECHAT_HDATA_LIST(buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+WEECHAT_HDATA_LIST(last_buffer, 0);
----
[NOTE]
@@ -14305,7 +14308,7 @@ buffers = weechat.hdata_get_list(hdata, "gui_buffers")
==== weechat_hdata_check_pointer
-_WeeChat ≥ 0.3.7._
+_WeeChat ≥ 0.3.7, mis à jour dans la 1.0._
Vérifier si un pointeur est valide pour un hdata et un pointeur de liste.
@@ -14319,7 +14322,11 @@ 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
+* '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
+ <<_weechat_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
Valeur de retour :
diff --git a/doc/it/weechat_plugin_api.it.txt b/doc/it/weechat_plugin_api.it.txt
index 9e8798678..b14b0cfc7 100644
--- a/doc/it/weechat_plugin_api.it.txt
+++ b/doc/it/weechat_plugin_api.it.txt
@@ -13931,7 +13931,8 @@ Questa funzione non è disponibile nelle API per lo scripting.
==== weechat_hdata_new_list
-_WeeChat ≥ 0.3.6._
+// TRANSLATION MISSING
+_WeeChat ≥ 0.3.6, updated in 1.0._
Crea una nuovo puntatore alla lista in hdata.
@@ -13939,7 +13940,7 @@ Prototipo:
[source,C]
----
-void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer);
+void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer, int flags);
----
Argomenti:
@@ -13947,6 +13948,9 @@ Argomenti:
* '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
Esempio in C:
@@ -13974,16 +13978,16 @@ weechat_hdata_new_var (hdata, "string_split", offsetof (struct t_myplugin_list,
weechat_hdata_new_var (hdata, "prev", offsetof (struct t_myplugin_list, prev), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
weechat_hdata_new_var (hdata, "next", offsetof (struct t_myplugin_list, next), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
-weechat_hdata_new_list (hdata, "buffers", &buffers);
-weechat_hdata_new_list (hdata, "last_buffer", &last_buffer);
+weechat_hdata_new_list (hdata, "buffers", &buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+weechat_hdata_new_list (hdata, "last_buffer", &last_buffer, 0);
----
La macro "WEECHAT_HDATA_LIST" può essere usata per accorciare il codice:
[source,C]
----
-WEECHAT_HDATA_LIST(buffers);
-WEECHAT_HDATA_LIST(last_buffer);
+WEECHAT_HDATA_LIST(buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+WEECHAT_HDATA_LIST(last_buffer, 0);
----
[NOTE]
@@ -14428,7 +14432,8 @@ buffers = weechat.hdata_get_list(hdata, "gui_buffers")
==== weechat_hdata_check_pointer
-_WeeChat ≥ 0.3.7._
+// TRANSLATION MISSING
+_WeeChat ≥ 0.3.7, updated in 1.0._
Verifica se un puntatore è valido per un hdata e un puntatore della lista.
@@ -14442,7 +14447,11 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe
Argomenti:
* 'hdata': puntatore hdata
-* 'list': puntatore alla lista
+// TRANSLATION MISSING
+* 'list': puntatore alla lista; if NULL _(WeeChat ≥ 1.0)_, the pointer is
+ checked with the lists in hdata that have flag "check pointers" (see
+ <<_weechat_hdata_new_list,weechat_hdata_new_list>>), and if no such list
+ exists, the pointer is considered as valid
* 'pointer': puntatore da verificare
Valore restituito:
diff --git a/doc/ja/weechat_plugin_api.ja.txt b/doc/ja/weechat_plugin_api.ja.txt
index a42236ff7..f9875e64d 100644
--- a/doc/ja/weechat_plugin_api.ja.txt
+++ b/doc/ja/weechat_plugin_api.ja.txt
@@ -13538,7 +13538,8 @@ WEECHAT_HDATA_VAR(struct t_myplugin_list, next, POINTER, 0, NULL, "myplugin_list
==== weechat_hdata_new_list
-_WeeChat バージョン 0.3.6 以上で利用可。_
+// TRANSLATION MISSING
+_WeeChat ≥ 0.3.6, updated in 1.0._
hdata に新しいリストへのポインタを作成。
@@ -13546,7 +13547,7 @@ hdata に新しいリストへのポインタを作成。
[source,C]
----
-void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer);
+void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *pointer, int flags);
----
引数:
@@ -13554,6 +13555,9 @@ void weechat_hdata_new_list (struct t_hdata *hdata, const char *name, void *poin
* 'hdata': hdata へのポインタ
* 'name': 変数名
* 'pointer': リストへのポインタ
+// TRANSLATION MISSING
+* 'flags': combination of following values: _(WeeChat ≥ 1.0)_
+** 'WEECHAT_HDATA_LIST_CHECK_POINTERS': list used to check pointers
C 言語での使用例:
@@ -13581,16 +13585,16 @@ weechat_hdata_new_var (hdata, "string_split", offsetof (struct t_myplugin_list,
weechat_hdata_new_var (hdata, "prev", offsetof (struct t_myplugin_list, prev), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
weechat_hdata_new_var (hdata, "next", offsetof (struct t_myplugin_list, next), WEECHAT_HDATA_POINTER, NULL, "myplugin_list");
-weechat_hdata_new_list (hdata, "buffers", &buffers);
-weechat_hdata_new_list (hdata, "last_buffer", &last_buffer);
+weechat_hdata_new_list (hdata, "buffers", &buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+weechat_hdata_new_list (hdata, "last_buffer", &last_buffer, 0);
----
コードを短くするためにはマクロ "WEECHAT_HDATA_LIST" を使います。
[source,C]
----
-WEECHAT_HDATA_LIST(buffers);
-WEECHAT_HDATA_LIST(last_buffer);
+WEECHAT_HDATA_LIST(buffers, WEECHAT_HDATA_LIST_CHECK_POINTERS);
+WEECHAT_HDATA_LIST(last_buffer, 0);
----
[NOTE]
@@ -14028,7 +14032,8 @@ buffers = weechat.hdata_get_list(hdata, "gui_buffers")
==== weechat_hdata_check_pointer
-_WeeChat バージョン 0.3.7 以上で利用可。_
+// TRANSLATION MISSING
+_WeeChat ≥ 0.3.7, updated in 1.0._
hdata とリストへのポインタを使ってポインタの妥当性を確認する。
@@ -14042,7 +14047,11 @@ int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointe
引数:
* 'hdata': hdata へのポインタ
-* 'list': リストへのポインタ
+// TRANSLATION MISSING
+* 'list': list pointer; if NULL _(WeeChat ≥ 1.0)_, the pointer is checked with
+ the lists in hdata that have flag "check pointers" (see
+ <<_weechat_hdata_new_list,weechat_hdata_new_list>>), and if no such list
+ exists, the pointer is considered as valid
* 'pointer': 確認するポインタ
戻り値: