IPluginDocHyperlink Struct Reference
Universal Document Shell Plugin Document Hyperlink interafce. Through IPluginDocDictionary, UDS may be able to get explaination for certain word. More...
#include <plugin_doc_hyperlink.h>
Data Fields | |
| PluginBool(* | is_hyperlink )(IPluginUnknown *thiz, const PluginRange *range) |
| Check whether a range is a hyperlink. | |
| PluginStatus(* | get_target_from_hyperlink )(IPluginUnknown *thiz, const PluginRange *range, UDSString *anchor) |
| Get the anchor pointed by the hyperlink. | |
| IPluginUnknown *(* | get_hyperlinks_in_range )(IPluginUnknown *thiz, const PluginRange *range) |
| Retrieve hyper links inside specified range. | |
Detailed Description
Universal Document Shell Plugin Document Hyperlink interafce. Through IPluginDocDictionary, UDS may be able to get explaination for certain word.
Copyright (C) 2008 iRex Technologies B.V. All rights reserved.
Definition at line 43 of file plugin_doc_hyperlink.h.
Field Documentation
| IPluginUnknown*(* IPluginDocHyperlink::get_hyperlinks_in_range)(IPluginUnknown *thiz, const PluginRange *range) |
Retrieve hyper links inside specified range.
- Parameters:
-
thiz IPluginUnknown pointer of document object. range The range that caller wants to retrieve hyper links.
- Returns:
- This function returns IPluginUnknown pointer of collection object. The collection object contains all hyper links' range that inside the page specified by the page_anchor. It returns NULL when the specified page does not contain any hyper links.
Referenced by pdf::PluginDocImpl::PluginDocImpl().
| PluginStatus(* IPluginDocHyperlink::get_target_from_hyperlink)(IPluginUnknown *thiz, const PluginRange *range, UDSString *anchor) |
Get the anchor pointed by the hyperlink.
- Parameters:
-
thiz IPluginUnknown pointer of the document object. range The object range containing the hyperlink. anchor The anchor of the target position pointed by the hyperlink.
- Returns:
- TODO. Add return code here.
Referenced by text::PluginDocImpl::PluginDocImpl(), pdf::PluginDocImpl::PluginDocImpl(), and images::PluginDocImpl::PluginDocImpl().
| PluginBool(* IPluginDocHyperlink::is_hyperlink)(IPluginUnknown *thiz, const PluginRange *range) |
Check whether a range is a hyperlink.
- Parameters:
-
thiz IPluginUnknown pointer of a document object. range The range of the object.
- Returns:
- PLUGIN_TRUE if range contains exactly a hyperlink; otherwise return PLUGIN_FALSE.
Referenced by text::PluginDocImpl::PluginDocImpl(), pdf::PluginDocImpl::PluginDocImpl(), and images::PluginDocImpl::PluginDocImpl().
The documentation for this struct was generated from the following file:
