comparison: libpurple/plugins.h
libpurple/plugins.h
- branch
- soc.2013.gobjectification.plugins
- changeset 36642
- b8ba53daa445
- parent 36611
- 07d5c0892315
- child 36653
- 4084c34c051d
equal
deleted
inserted
replaced
| 36641:9207558f0ad3 | 36642:b8ba53daa445 |
|---|---|
| 378 * "name" (string) The translated name of the plugin. \n | 378 * "name" (string) The translated name of the plugin. \n |
| 379 * "version" (string) Version of the plugin. \n | 379 * "version" (string) Version of the plugin. \n |
| 380 * "category" (string) Primary category of the plugin. \n | 380 * "category" (string) Primary category of the plugin. \n |
| 381 * "summary" (string) Brief summary of the plugin. \n | 381 * "summary" (string) Brief summary of the plugin. \n |
| 382 * "description" (string) Full description of the plugin. \n | 382 * "description" (string) Full description of the plugin. \n |
| 383 * "author" (string) Name and e-mail address of the author. | 383 * "authors" (const gchar * const *) A NULL-terminated list of |
| 384 * plugin authors. | |
| 384 * format: First Last <user@domain.com> \n | 385 * format: First Last <user@domain.com> \n |
| 385 * "website" (string) Website of the plugin. \n | 386 * "website" (string) Website of the plugin. \n |
| 386 * "icon" (string) Path to a plugin's icon. \n | 387 * "icon" (string) Path to a plugin's icon. \n |
| 387 * "license" (string) Short name of the plugin's license. This | 388 * "license-id" (string) Short name of the plugin's license. This |
| 388 * should either be an identifier of the | 389 * should either be an identifier of the license from |
| 389 * license from http://spdx.org/licenses/ or | 390 * http://dep.debian.net/deps/dep5/#license-specification |
| 390 * "Other" for custom licenses. \n | 391 * or "Other" for custom licenses. \n |
| 391 * "license-text" (string) The text of the plugin's license, if | 392 * "license-text" (string) The text of the plugin's license, if |
| 392 * unlisted on SPDX. \n | 393 * unlisted on DEP5. \n |
| 393 * "license-url" (string) The plugin's license URL, if unlisted on | 394 * "license-url" (string) The plugin's license URL, if unlisted on |
| 394 * SPDX. \n | 395 * DEP5. \n |
| 395 * "dependencies" (string) Comma-seperated list of plugin IDs required | 396 * "dependencies" (const gchar * const *) A NULL-terminated list of |
| 396 * by the plugin. \n | 397 * plugin IDs required by the plugin. \n |
| 397 * "abi-version" (guint32) The ABI version required by the plugin. \n | 398 * "abi-version" (guint32) The ABI version required by the plugin. \n |
| 398 * "get-actions" (PurplePluginGetActionsCallback) Callback that | 399 * "get-actions" (PurplePluginGetActionsCallback) Callback that |
| 399 * returns a list of actions the plugin can | 400 * returns a list of actions the plugin can |
| 400 * perform. \n | 401 * perform. \n |
| 401 * "preferences-frame" (PurplePluginPrefFrameCallback) Callback that returns | 402 * "preferences-frame" (PurplePluginPrefFrameCallback) Callback that returns |
| 472 * @return The description of the plugin, or @c NULL. | 473 * @return The description of the plugin, or @c NULL. |
| 473 */ | 474 */ |
| 474 const gchar *purple_plugin_info_get_description(const PurplePluginInfo *info); | 475 const gchar *purple_plugin_info_get_description(const PurplePluginInfo *info); |
| 475 | 476 |
| 476 /** | 477 /** |
| 477 * Returns a plugin's author. | 478 * Returns a NULL-terminated list of the plugin's authors. |
| 478 * | 479 * |
| 479 * @param info The plugin's info instance. | 480 * @param info The plugin's info instance. |
| 480 * | 481 * |
| 481 * @return The author of the plugin, or @c NULL. | 482 * @return The authors of the plugin, or @c NULL. |
| 482 */ | 483 */ |
| 483 const gchar *purple_plugin_info_get_author(const PurplePluginInfo *info); | 484 const gchar * const * |
| 485 purple_plugin_info_get_authors(const PurplePluginInfo *info); | |
| 484 | 486 |
| 485 /** | 487 /** |
| 486 * Returns a plugin's website. | 488 * Returns a plugin's website. |
| 487 * | 489 * |
| 488 * @param info The plugin's info instance. | 490 * @param info The plugin's info instance. |
| 505 * | 507 * |
| 506 * @param info The plugin's info instance. | 508 * @param info The plugin's info instance. |
| 507 * | 509 * |
| 508 * @return The license name of the plugin, or @c NULL. | 510 * @return The license name of the plugin, or @c NULL. |
| 509 */ | 511 */ |
| 510 const gchar *purple_plugin_info_get_license(const PurplePluginInfo *info); | 512 const gchar *purple_plugin_info_get_license_id(const PurplePluginInfo *info); |
| 511 | 513 |
| 512 /** | 514 /** |
| 513 * Returns the text of a plugin's license. | 515 * Returns the text of a plugin's license. |
| 514 * | 516 * |
| 515 * @param info The plugin's info instance. | 517 * @param info The plugin's info instance. |
| 524 * @param info The plugin's info instance. | 526 * @param info The plugin's info instance. |
| 525 * | 527 * |
| 526 * @return The license URL of the plugin, or @c NULL. | 528 * @return The license URL of the plugin, or @c NULL. |
| 527 */ | 529 */ |
| 528 const gchar *purple_plugin_info_get_license_url(const PurplePluginInfo *info); | 530 const gchar *purple_plugin_info_get_license_url(const PurplePluginInfo *info); |
| 531 | |
| 532 /** | |
| 533 * Returns a NULL-terminated list of IDs of plugins required by a plugin. | |
| 534 * | |
| 535 * @param info The plugin's info instance. | |
| 536 * | |
| 537 * @return The dependencies of the plugin, or @c NULL. | |
| 538 */ | |
| 539 const gchar * const * | |
| 540 purple_plugin_info_get_dependencies(const PurplePluginInfo *info); | |
| 529 | 541 |
| 530 /** | 542 /** |
| 531 * Returns the required purple ABI version for a plugin. | 543 * Returns the required purple ABI version for a plugin. |
| 532 * | 544 * |
| 533 * @param info The plugin's info instance. | 545 * @param info The plugin's info instance. |
