IPluginDocMarker Struct Reference

Universal Document Shell Plugin Marker Interface. Through IPluginDocMarker, caller can request marker tree of document to plugin, and get plugin-supported marker types. More...

#include <plugin_doc_marker.h>

Inheritance diagram for IPluginDocMarker:

[legend]

Collaboration diagram for IPluginDocMarker:

[legend]

Data Fields
IPluginUnknown *(*	get_supported_marker_types )(IPluginUnknown *thiz)
	Retrieve all supported marker types.
PluginBool(*	has_toc )(IPluginUnknown *thiz)
	Check the document contains table of content or not.
PluginStatus(*	request_marker_trees )(IPluginUnknown *thiz, const unsigned int uds_private_size)
	Request the marker trees. The marker tree won't be returned immediately after calling this function, but returned asynchronously by some callback functions of UDS.

---

Detailed Description

Universal Document Shell Plugin Marker Interface. Through IPluginDocMarker, caller can request marker tree of document to plugin, and get plugin-supported marker types.

Definition at line 66 of file plugin_doc_marker.h.

---

Field Documentation

IPluginUnknown*(* IPluginDocMarker::get_supported_marker_types)(IPluginUnknown *thiz)

Retrieve all supported marker types.

Parameters:

thiz

IPluginUnknown pointer of document object.

Returns:

Returns IPluginUnknown pointer of collection object that contains all supported marker types if the document object contains any markers. Otherwise this function returns NULL.

Referenced by pdf::PluginDocImpl::PluginDocImpl(), and images::PluginDocImpl::PluginDocImpl().

PluginBool(* IPluginDocMarker::has_toc)(IPluginUnknown *thiz)

Check the document contains table of content or not.

Parameters:

thiz

IPluginUnknown pointer of document object.

Returns:

Returns PLUGIN_TRUE if the document contains the table of content. Otherwise this function returns PLUGIN_FALSE.

Referenced by pdf::PluginDocImpl::PluginDocImpl().

PluginStatus(* IPluginDocMarker::request_marker_trees)(IPluginUnknown *thiz, const unsigned int uds_private_size)

Request the marker trees. The marker tree won't be returned immediately after calling this function, but returned asynchronously by some callback functions of UDS.

Parameters:

	thiz	IPluginUnknown pointer of document object.
	uds_private_size	The size of extra data buffer that plugin has to allocate for every marker tree node.

Returns:

TODO. Add return code here.

Referenced by text::PluginDocImpl::PluginDocImpl(), pdf::PluginDocImpl::PluginDocImpl(), and images::PluginDocImpl::PluginDocImpl().

---

The documentation for this struct was generated from the following file:

• plugin_doc_marker.h