IPluginEventBroadcaster Struct Reference
Universal Document Shell Plugin Document Event Broadcaster interface. Through IPluginEventBroadcaster, listeners can receive notification from plugin. More...
#include <plugin_event.h>
Data Fields | |
| PluginStatus(* | add_event_receiver )(IPluginUnknown *thiz, const PluginEvent plugin_event, EventFunc callback, void *user_data, unsigned long *handler_id) |
| Register call back function for specified event. | |
| PluginStatus(* | remove_event_receiver )(IPluginUnknown *thiz, unsigned long handler_id) |
| Remove a listener by specified ID. | |
Detailed Description
Universal Document Shell Plugin Document Event Broadcaster interface. Through IPluginEventBroadcaster, listeners can receive notification from plugin.
Definition at line 145 of file plugin_event.h.
Field Documentation
| PluginStatus(* IPluginEventBroadcaster::add_event_receiver)(IPluginUnknown *thiz, const PluginEvent plugin_event, EventFunc callback, void *user_data, unsigned long *handler_id) |
Register call back function for specified event.
- Parameters:
-
thiz The object identifier which implements the IPluginEventBroadcaster interface. event The event on which the listener needs to register. callback Callback function defined by caller. user_data User specified data, plugin puts this variable to callback function as a parameter. handler_id The identifier ID of this registration.
- Returns:
- TODO. Add return code here.
Referenced by text::PluginDocImpl::PluginDocImpl(), pdf::PluginDocImpl::PluginDocImpl(), images::PluginDocImpl::PluginDocImpl(), text::PluginViewImpl::PluginViewImpl(), pdf::PluginViewImpl::PluginViewImpl(), and images::PluginViewImpl::PluginViewImpl().
| PluginStatus(* IPluginEventBroadcaster::remove_event_receiver)(IPluginUnknown *thiz, unsigned long handler_id) |
Remove a listener by specified ID.
- Parameters:
-
thiz The object identifier which implements the IPluginEventBroadcaster interface. handler_id The unique identifier of the registration, it is always generated by plugin while caller registers a callback function for specified event.
- Returns:
- TODO. Add return code here.
Referenced by text::PluginDocImpl::PluginDocImpl(), pdf::PluginDocImpl::PluginDocImpl(), images::PluginDocImpl::PluginDocImpl(), text::PluginViewImpl::PluginViewImpl(), pdf::PluginViewImpl::PluginViewImpl(), and images::PluginViewImpl::PluginViewImpl().
The documentation for this struct was generated from the following file:
