/usr/include/libpurple/prefs.h is in libpurple-dev 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 | /**
* @file prefs.h Prefs API
* @ingroup core
*/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*
*/
#ifndef _PURPLE_PREFS_H_
#define _PURPLE_PREFS_H_
#include <glib.h>
/**
* Preference data types.
*/
typedef enum _PurplePrefType
{
PURPLE_PREF_NONE, /**< No type. */
PURPLE_PREF_BOOLEAN, /**< Boolean. */
PURPLE_PREF_INT, /**< Integer. */
PURPLE_PREF_STRING, /**< String. */
PURPLE_PREF_STRING_LIST, /**< List of strings. */
PURPLE_PREF_PATH, /**< Path. */
PURPLE_PREF_PATH_LIST /**< List of paths. */
} PurplePrefType;
/**
* The type of callbacks for preference changes.
*
* @param name the name of the preference which has changed.
* @param type the type of the preferenced named @a name
* @param val the new value of the preferencs; should be cast to the correct
* type. For instance, to recover the value of a #PURPLE_PREF_INT
* preference, use <tt>GPOINTER_TO_INT(val)</tt>. Alternatively,
* just call purple_prefs_get_int(), purple_prefs_get_string_list()
* etc.
* @param data Arbitrary data specified when the callback was connected with
* purple_prefs_connect_callback().
*
* @see purple_prefs_connect_callback()
*/
typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type,
gconstpointer val, gpointer data);
/**
* Opaque type to carry callback information
*
* @since 2.11.0
*/
typedef struct _PurplePrefCallbackData PurplePrefCallbackData;
/** @copydoc _PurplePrefsUiOps */
typedef struct _PurplePrefsUiOps PurplePrefsUiOps;
/**
* Prefs UI operations. This allows overriding the prefs.xml storage with
* anything else.
*
* Unless specified otherwise, each entry provides an implementation for the
* corresponding purple_prefs_* method, and disables the prefs.xml code for it.
* This means that to do anything useful, all the methods must be implemented.
*
* @since 2.11.0
*/
struct _PurplePrefsUiOps
{
void (*add_none)(const char *name);
void (*add_bool)(const char *name, gboolean value);
void (*add_int)(const char *name, int value);
void (*add_string)(const char *name, const char *value);
void (*add_string_list)(const char *name, GList *value);
void (*set_bool)(const char *name, gboolean value);
void (*set_int)(const char *name, int value);
void (*set_string)(const char *name, const char *value);
void (*set_string_list)(const char *name, GList *value);
gboolean (*get_bool)(const char *name);
int (*get_int)(const char *name);
const char *(*get_string)(const char *name);
GList *(*get_string_list)(const char *name);
PurplePrefType (*get_type)(const char *name);
GList *(*get_children_names)(const char *name);
gboolean (*exists)(const char *name);
void (*remove)(const char *name);
void (*rename)(const char *oldname, const char *newname);
void (*rename_boolean_toggle)(const char *oldname, const char *newname);
gboolean (*load)(void);
void (*save)(void);
void (*schedule_save)(void);
/**
* Called when a callback is added to a preference. The UI must keep
* track of it and call #purple_prefs_trigger_callback_object with the
* data attribute.
*
* @param name The preference name.
* @param data The object to be passed when triggering the callback
* @return A pointer to a ui_data object.
* */
void *(*connect_callback)(const char *name, PurplePrefCallbackData *data);
/**
* Called when a callback is removed from a preference. The ui_data
* object is the one returned from connect_callback.
*
* @param name The preference name
* @param ui_data The object that was returned from the
* connect_callback UI OP.
* */
void (*disconnect_callback)(const char *name, void *ui_data);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
void (*_purple_reserved5)(void);
};
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name UI Registration Functions */
/**************************************************************************/
/*@{*/
/**
* Sets the UI operations structure to be used for preferences.
*
* @param ops The UI operations structure.
* @since 2.11.0
*/
void purple_prefs_set_ui_ops(PurplePrefsUiOps *ops);
/**
* Returns the UI operations structure used for preferences.
*
* @return The UI operations structure in use.
* @since 2.11.0
*/
PurplePrefsUiOps *purple_prefs_get_ui_ops(void);
/*@}*/
/**************************************************************************/
/** @name Prefs API
Preferences are named according to a directory-like structure.
Example: "/plugins/core/potato/is_from_idaho" (probably a boolean) */
/**************************************************************************/
/*@{*/
/**
* Returns the prefs subsystem handle.
*
* @return The prefs subsystem handle.
*/
void *purple_prefs_get_handle(void);
/**
* Initialize core prefs
*/
void purple_prefs_init(void);
/**
* Uninitializes the prefs subsystem.
*/
void purple_prefs_uninit(void);
/**
* Add a new typeless pref.
*
* @param name The name of the pref
*/
void purple_prefs_add_none(const char *name);
/**
* Add a new boolean pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void purple_prefs_add_bool(const char *name, gboolean value);
/**
* Add a new integer pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void purple_prefs_add_int(const char *name, int value);
/**
* Add a new string pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void purple_prefs_add_string(const char *name, const char *value);
/**
* Add a new string list pref.
*
* @param name The name of the pref
* @param value The initial value to set
* @note This function takes a copy of the strings in the value list. The list
* itself and original copies of the strings are up to the caller to
* free.
*/
void purple_prefs_add_string_list(const char *name, GList *value);
/**
* Add a new path pref.
*
* @param name The name of the pref
* @param value The initial value to set
*/
void purple_prefs_add_path(const char *name, const char *value);
/**
* Add a new path list pref.
*
* @param name The name of the pref
* @param value The initial value to set
* @note This function takes a copy of the strings in the value list. The list
* itself and original copies of the strings are up to the caller to
* free.
*/
void purple_prefs_add_path_list(const char *name, GList *value);
/**
* Remove a pref.
*
* @param name The name of the pref
*/
void purple_prefs_remove(const char *name);
/**
* Rename a pref
*
* @param oldname The old name of the pref
* @param newname The new name for the pref
*/
void purple_prefs_rename(const char *oldname, const char *newname);
/**
* Rename a boolean pref, toggling it's value
*
* @param oldname The old name of the pref
* @param newname The new name for the pref
*/
void purple_prefs_rename_boolean_toggle(const char *oldname, const char *newname);
/**
* Remove all prefs.
*/
void purple_prefs_destroy(void);
/**
* Set raw pref value
*
* @param name The name of the pref
* @param value The value to set
*
* @deprecated We're not really sure what purpose this function serves, so it
* will be removed in 3.0.0. Preferences values set using this
* function aren't serialized to prefs.xml, which could be
* misleading. There is also no purple_prefs_get_generic, which
* means that if you can't really get the value (other in a
* connected callback). If you think you have a use for this then
* please let us know.
*/
/* TODO: When this is removed, also remove struct purple_pref->value.generic */
void purple_prefs_set_generic(const char *name, gpointer value);
/**
* Set boolean pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void purple_prefs_set_bool(const char *name, gboolean value);
/**
* Set integer pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void purple_prefs_set_int(const char *name, int value);
/**
* Set string pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void purple_prefs_set_string(const char *name, const char *value);
/**
* Set string list pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void purple_prefs_set_string_list(const char *name, GList *value);
/**
* Set path pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void purple_prefs_set_path(const char *name, const char *value);
/**
* Set path list pref value
*
* @param name The name of the pref
* @param value The value to set
*/
void purple_prefs_set_path_list(const char *name, GList *value);
/**
* Check if a pref exists
*
* @param name The name of the pref
* @return TRUE if the pref exists. Otherwise FALSE.
*/
gboolean purple_prefs_exists(const char *name);
/**
* Get pref type
*
* @param name The name of the pref
* @return The type of the pref
*/
PurplePrefType purple_prefs_get_type(const char *name);
/**
* Get boolean pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
gboolean purple_prefs_get_bool(const char *name);
/**
* Get integer pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
int purple_prefs_get_int(const char *name);
/**
* Get string pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
const char *purple_prefs_get_string(const char *name);
/**
* Get string list pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
GList *purple_prefs_get_string_list(const char *name);
/**
* Get path pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
const char *purple_prefs_get_path(const char *name);
/**
* Get path list pref value
*
* @param name The name of the pref
* @return The value of the pref
*/
GList *purple_prefs_get_path_list(const char *name);
/**
* Returns a list of children for a pref
*
* @param name The parent pref
* @return A list of newly allocated strings denoting the names of the children.
* Returns @c NULL if there are no children or if pref doesn't exist.
* The caller must free all the strings and the list.
*
* @since 2.1.0
*/
GList *purple_prefs_get_children_names(const char *name);
/**
* Add a callback to a pref (and its children)
*
* @param handle The handle of the receiver.
* @param name The name of the preference
* @param cb The callback function
* @param data The data to pass to the callback function.
*
* @return An id to disconnect the callback
*
* @see purple_prefs_disconnect_callback
*/
guint purple_prefs_connect_callback(void *handle, const char *name, PurplePrefCallback cb,
gpointer data);
/**
* Remove a callback to a pref
*/
void purple_prefs_disconnect_callback(guint callback_id);
/**
* Remove all pref callbacks by handle
*/
void purple_prefs_disconnect_by_handle(void *handle);
/**
* Trigger callbacks as if the pref changed
*/
void purple_prefs_trigger_callback(const char *name);
/**
* Trigger callbacks as if the pref changed, taking a #PurplePrefCallbackData
* instead of a name
*
* @since 2.11.0
*/
void purple_prefs_trigger_callback_object(PurplePrefCallbackData *data);
/**
* Read preferences
*/
gboolean purple_prefs_load(void);
/**
* Rename legacy prefs and delete some that no longer exist.
*/
void purple_prefs_update_old(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_PREFS_H_ */
|