IPluginView Struct Reference

Universal Document Shell Plugin View interface. More...

#include <plugin_view.h>

Inheritance diagram for IPluginView:

[legend]

Data Fields

int(* get_page_number )(IPluginUnknown *thiz, const UDSString *anchor)

Get page number by a specified anchor.

. Otherwise it returns false.

Retrieve page name by a specified anchor.

Parameters:

	thiz	IPluginUnknown pointer of the view object.
	page_start_anchor	The start anchor of the page.
	name	It serves as output parameter. The returned page name is stored in the name.

Returns:: This function returns PLUGIN_OK if plugin can store the page name into the This function is useful for image plugin when UDS works in thumbnail mode. UDS can display the file name instead of page number.

PluginStatus(* get_page_name )(IPluginUnknown *thiz, const UDSString *page_start_anchor, UDSString *name)

PluginStatus(* get_rendered_page_start )(IPluginUnknown *thiz, const UDSString *anchor, UDSString *start_anchor)

Returns an anchor pointing to the start of the rendered page.

PluginStatus(* get_physical_page_start )(IPluginUnknown *thiz, const UDSString *anchor, UDSString *start_anchor)

Returns an anchor poiting to the start of the physical page.

int(* get_number_of_pages )(IPluginUnknown *thiz)

Get the total number of the pages rendered by this view object.

PluginStatus(* get_anchor_by_page )(IPluginUnknown *thiz, unsigned int page, UDSString *start_of_page_anchor)

Get anchor position corresponding to the specified page.

PluginStatus(* get_prev_page )(IPluginUnknown *thiz, UDSString *start_of_page_anchor)

Get the anchor for the beginning position of the previous page.

PluginStatus(* get_next_page )(IPluginUnknown *thiz, UDSString *start_of_page_anchor)

Get the anchor for the beginning position of the next page.

PluginStatus(* get_cover_page )(IPluginUnknown *thiz, const int width, const int height, PluginBitmapAttributes *cover_page)

Get the cover page of document.

Detailed Description

Universal Document Shell Plugin View interface.

Definition at line 41 of file plugin_view.h.

Field Documentation

PluginStatus(* IPluginView::get_anchor_by_page)(IPluginUnknown *thiz, unsigned int page, UDSString *start_of_page_anchor)

Get anchor position corresponding to the specified page.

Parameters:

	thiz	IPluginUnknown pointer of the view object.
	page	The specified page number.
	start_of_page_anchor	The returned anchor position.

Returns:: TODO. Add return code here.

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

PluginStatus(* IPluginView::get_cover_page)(IPluginUnknown *thiz, const int width, const int height, PluginBitmapAttributes *cover_page)

Get the cover page of document.

Parameters:

	thiz	IPluginUnknown pointer of the view object.
	width	The desired cover page width.
	height	The desired cover page height.
	cover_page	The result image of cover page.

Returns:: This function returns PLUGIN_OK if view object is able to render the cover page successfully, otherwise it returns PLUGIN_FAIL.

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

PluginStatus(* IPluginView::get_next_page)(IPluginUnknown *thiz, UDSString *start_of_page_anchor)

Get the anchor for the beginning position of the next page.

Parameters:

	thiz	IPluginUnknown pointer of the view object.
	start_of_page_anchor	The returned anchor position.

Returns:: TODO. Add return code here.

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

int(* IPluginView::get_number_of_pages)(IPluginUnknown *thiz)

Get the total number of the pages rendered by this view object.

Parameters:

thiz

IPluginUnknown pointer of the view object.

Returns:: The number of total pages rendered by this view object.

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

PluginStatus(* IPluginView::get_page_name)(IPluginUnknown *thiz, const UDSString *page_start_anchor, UDSString *name)

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

int(* IPluginView::get_page_number)(IPluginUnknown *thiz, const UDSString *anchor)

Get page number by a specified anchor.

Parameters:

	thiz	IPluginUnknown pointer of the view object.
	anchor	Location of user specified content.

Returns:: The page location of the specified anchor. The location is represented by number.

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

PluginStatus(* IPluginView::get_physical_page_start)(IPluginUnknown *thiz, const UDSString *anchor, UDSString *start_anchor)

Returns an anchor poiting to the start of the physical page.

When the plugin renders only physical pages, this function doesn't have to be implementated. The default implementation willcall get_rendered_page_start()

Parameters:

	thiz	IPluginUnknown pointer of view object.
	start_anchor	[out] Anchor pointing to the start of the physical page

Returns:: PLUGIN_OK Iff plugin can find the page that contain the object specified by range. It returns other values if something wrong with

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

PluginStatus(* IPluginView::get_prev_page)(IPluginUnknown *thiz, UDSString *start_of_page_anchor)

Get the anchor for the beginning position of the previous page.

Parameters:

	thiz	IPluginUnknown pointer of the view object.
	start_of_page_anchor	The returned anchor position.

Returns:: TODO. Add return code here.

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

PluginStatus(* IPluginView::get_rendered_page_start)(IPluginUnknown *thiz, const UDSString *anchor, UDSString *start_anchor)

Returns an anchor pointing to the start of the rendered page.

Parameters:

	thiz	[in] IPluginUnknown pointer of view object.
	anchor	[in] The anchor of the requested page
	start_anchor	[out] Anchor pointing to the start of the rendered page

Returns:: PLUGIN_OK If plugin can find the page that contain the object specified by range. It returns other values if something wrong with

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

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

plugin_view.h