comparison libpurple/plugin.h @ 32672:3828a61c44da

A boring and large patch so I can merge heads.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Fri, 23 Dec 2011 08:21:58 +0000
parents 552b5292f36f
children
comparison
equal deleted inserted replaced
32671:0e69949b3e61 32672:3828a61c44da
315 * 315 *
316 * This function adds the plugin to a list of plugins to "disable at the next 316 * This function adds the plugin to a list of plugins to "disable at the next
317 * startup" by excluding said plugins from the list of plugins to save. The 317 * startup" by excluding said plugins from the list of plugins to save. The
318 * UI needs to call purple_plugins_save_loaded() after calling this for it 318 * UI needs to call purple_plugins_save_loaded() after calling this for it
319 * to have any effect. 319 * to have any effect.
320 *
321 * @since 2.3.0
322 */ 320 */
323 void purple_plugin_disable(PurplePlugin *plugin); 321 void purple_plugin_disable(PurplePlugin *plugin);
324 322
325 /** 323 /**
326 * Reloads a plugin. 324 * Reloads a plugin.
513 511
514 /** 512 /**
515 * Returns a list of plugin search paths. 513 * Returns a list of plugin search paths.
516 * 514 *
517 * @constreturn A list of searched paths. 515 * @constreturn A list of searched paths.
518 *
519 * @since 2.6.0
520 */ 516 */
521 GList *purple_plugins_get_search_paths(void); 517 GList *purple_plugins_get_search_paths(void);
522 518
523 /** 519 /**
524 * Unloads all loaded plugins. 520 * Unloads all loaded plugins.
563 * Returns whether or not plugin support is enabled. 559 * Returns whether or not plugin support is enabled.
564 * 560 *
565 * @return TRUE if plugin support is enabled, or FALSE otherwise. 561 * @return TRUE if plugin support is enabled, or FALSE otherwise.
566 */ 562 */
567 gboolean purple_plugins_enabled(void); 563 gboolean purple_plugins_enabled(void);
568
569 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PLUGIN_C_)
570 /**
571 * Registers a function that will be called when probing is finished.
572 *
573 * @param func The callback function.
574 * @param data Data to pass to the callback.
575 * @deprecated If you need this, ask for a plugin-probe signal to be added.
576 */
577 void purple_plugins_register_probe_notify_cb(void (*func)(void *), void *data);
578 #endif
579
580 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PLUGIN_C_)
581 /**
582 * Unregisters a function that would be called when probing is finished.
583 *
584 * @param func The callback function.
585 * @deprecated If you need this, ask for a plugin-probe signal to be added.
586 */
587 void purple_plugins_unregister_probe_notify_cb(void (*func)(void *));
588 #endif
589
590 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PLUGIN_C_)
591 /**
592 * Registers a function that will be called when a plugin is loaded.
593 *
594 * @param func The callback function.
595 * @param data Data to pass to the callback.
596 * @deprecated Use the plugin-load signal instead.
597 */
598 void purple_plugins_register_load_notify_cb(void (*func)(PurplePlugin *, void *),
599 void *data);
600 #endif
601
602 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PLUGIN_C_)
603 /**
604 * Unregisters a function that would be called when a plugin is loaded.
605 *
606 * @param func The callback function.
607 * @deprecated Use the plugin-load signal instead.
608 */
609 void purple_plugins_unregister_load_notify_cb(void (*func)(PurplePlugin *, void *));
610 #endif
611
612 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PLUGIN_C_)
613 /**
614 * Registers a function that will be called when a plugin is unloaded.
615 *
616 * @param func The callback function.
617 * @param data Data to pass to the callback.
618 * @deprecated Use the plugin-unload signal instead.
619 */
620 void purple_plugins_register_unload_notify_cb(void (*func)(PurplePlugin *, void *),
621 void *data);
622 #endif
623
624 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PLUGIN_C_)
625 /**
626 * Unregisters a function that would be called when a plugin is unloaded.
627 *
628 * @param func The callback function.
629 * @deprecated Use the plugin-unload signal instead.
630 */
631 void purple_plugins_unregister_unload_notify_cb(void (*func)(PurplePlugin *,
632 void *));
633 #endif
634 564
635 /** 565 /**
636 * Finds a plugin with the specified name. 566 * Finds a plugin with the specified name.
637 * 567 *
638 * @param name The plugin name. 568 * @param name The plugin name.