From 4942dc667f3ff40601b7afd2efd91dff1f73789a Mon Sep 17 00:00:00 2001 From: Berke Viktor Date: Sun, 15 Jan 2012 19:07:48 +0100 Subject: refactor plugin config API and add skeleton for xchat_pluginpref_list --- plugins/plugin20.html | 61 +++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 45 insertions(+), 16 deletions(-) (limited to 'plugins/plugin20.html') diff --git a/plugins/plugin20.html b/plugins/plugin20.html index a9aaaace..6323cd80 100644 --- a/plugins/plugin20.html +++ b/plugins/plugin20.html @@ -81,10 +81,12 @@ margin-right: 32px;
xchat_strip
xchat_free
-
xchat_set_pluginpref_str -
xchat_get_pluginpref_str -
xchat_set_pluginpref_int -
xchat_get_pluginpref_int +
xchat_pluginpref_set_str +
xchat_pluginpref_get_str +
xchat_pluginpref_set_int +
xchat_pluginpref_get_int +
xchat_pluginpref_delete +
xchat_pluginpref_list

xchat_list_get
xchat_list_free @@ -1003,8 +1005,8 @@ A newly allocated string or NULL for failure. You must free this string with xch

-

 xchat_set_pluginpref_str() (new for 2.8.10)

-Prototype: int xchat_set_pluginpref_str (xchat_plugin *ph, const char *var, const char *value); +

 xchat_pluginpref_set_str() (new for 2.8.10)

+Prototype: int xchat_pluginpref_set_str (xchat_plugin *ph, const char *var, const char *value);

Description: Saves a plugin-specific setting with string value to a plugin-specific config file.
@@ -1028,8 +1030,8 @@ A newly allocated string or NULL for failure. You must free this string with xch *plugin_desc = "Testing stuff"; *plugin_version = "1.0"; - xchat_set_pluginpref_str (ph, "myvar1", "I want to save this string!"); - xchat_set_pluginpref_str (ph, "myvar2", "This is important, too."); + xchat_pluginpref_set_str (ph, "myvar1", "I want to save this string!"); + xchat_pluginpref_set_str (ph, "myvar2", "This is important, too."); return 1; /* return 1 for success */ } @@ -1042,8 +1044,8 @@ myvar2 = This is important, too. You should never need to edit this file manually.


-

 xchat_get_pluginpref_str() (new for 2.8.10)

-Prototype: int xchat_get_pluginpref_str (xchat_plugin *ph, const char *var, char *dest); +

 xchat_pluginpref_get_str() (new for 2.8.10)

+Prototype: int xchat_pluginpref_get_str (xchat_plugin *ph, const char *var, char *dest);

Description: Loads a plugin-specific setting with string value from a plugin-specific config file.
@@ -1056,8 +1058,8 @@ You should never need to edit this file manually. Returns: 1 for success, 0 for failure.


-

 xchat_set_pluginpref_int() (new for 2.8.10)

-Prototype: int xchat_set_pluginpref_int (xchat_plugin *ph, const char *var, int value); +

 xchat_pluginpref_set_int() (new for 2.8.10)

+Prototype: int xchat_pluginpref_set_int (xchat_plugin *ph, const char *var, int value);

Description: Saves a plugin-specific setting with decimal value to a plugin-specific config file.
@@ -1076,7 +1078,7 @@ You should never need to edit this file manually. if (buffer > 0 && buffer < INT_MAX) { - if (xchat_set_pluginpref_int (ph, "myint1", buffer)) + if (xchat_pluginpref_set_int (ph, "myint1", buffer)) { xchat_printf (ph, "Setting successfully saved!\n"); } @@ -1093,10 +1095,11 @@ You should never need to edit this file manually. return XCHAT_EAT_XCHAT; } -

+You only need these kind of complex checks if you're saving user input, which can be non-numeric. +


-

 xchat_get_pluginpref_int() (new for 2.8.10)

-Prototype: int xchat_get_pluginpref_int (xchat_plugin *ph, const char *var); +

 xchat_pluginpref_get_int() (new for 2.8.10)

+Prototype: int xchat_pluginpref_get_int (xchat_plugin *ph, const char *var);

Description: Loads a plugin-specific setting with decimal value from a plugin-specific config file.
@@ -1108,5 +1111,31 @@ You should never need to edit this file manually. Returns: The decimal value of the requested setting upon success, -1 for failure.


+

 xchat_pluginpref_delete() (new for 2.8.10)

+Prototype: int xchat_pluginpref_delete (xchat_plugin *ph, const char *var); +
+
Description: Deletes a plugin-specific setting from a plugin-specific config file. +
+
Arguments: +
ph: Plugin handle (as given to xchat_plugin_init). +
var: Name of the setting to delete. +
+
+Returns: 1 for success, 0 for failure. If the given setting didn't exist, it also returns 1, so 1 only indicates that the setting won't exist after the call. +


+ +

 xchat_pluginpref_list() (new for 2.8.10)

+Prototype: int xchat_pluginpref_list (xchat_plugin *ph, const char *dest); +
+
Description: Builds a comma-separated list of the currently saved settings from a plugin-specific config file. +
+
Arguments: +
ph: Plugin handle (as given to xchat_plugin_init). +
dest: Array to save the list to. +
+
+Returns: 1 for success, 0 for failure. +


+ -- cgit 1.4.1