IPluginRenderResult Struct Reference

Render result interface, for querying bitmap inside render result get bounding rectangles for a specified range, and get the anchor for a specified point. More...

#include <plugin_render_result.h>

Inheritance diagram for IPluginRenderResult:
Inheritance graph
[legend]
Collaboration diagram for IPluginRenderResult:
Collaboration graph
[legend]

Data Fields

PluginStatus(* get_bitmap_attributes )(IPluginUnknown *thiz, PluginBitmapAttributes *attributes)
 Query bitmap attributes from render result.
PluginStatus(* get_anchor_from_coordinates )(IPluginUnknown *thiz, const int x, const int y, UDSString *anchor)
 Query content location for a specified point.
IPluginUnknown *(* get_bounding_rectangles_from_range )(IPluginUnknown *thiz, const PluginRange *range)
 Get bounding rectangles for a specified range.
PluginStatus(* get_rendered_range )(IPluginUnknown *thiz, PluginRange *range)
 Retrieve range from render result.

Detailed Description

Render result interface, for querying bitmap inside render result get bounding rectangles for a specified range, and get the anchor for a specified point.

Definition at line 56 of file plugin_render_result.h.


Field Documentation

Query content location for a specified point.

Parameters:
thiz IPluginUnknown interface pointer of the render result object
x x coordinate of the point
y y coordinate of the point
anchor output anchor
Returns:
TODO. Add return code here.

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

Query bitmap attributes from render result.

Parameters:
thiz IPluginUnknown interface pointer of the render result object
attributes output attributes
Returns:
TODO. Add return code here.

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

Get bounding rectangles for a specified range.

Parameters:
thiz IPluginUnknown interface pointer of the render result object
range user specified range
Returns:
IPluginUnknown interface of the collection object containing the array of bounding rectangles

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

Retrieve range from render result.

Parameters:
thiz The IPluginUnknown interface pointer of the render result object.
range The range of the render result.
Returns:
This function returns PLUGIN_OK if it can retrieve the range of the render result. Otherwise it returns the PLUGIN_FAIL.

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


The documentation for this struct was generated from the following file:
Generated by  doxygen 1.6.2-20100208