IPluginDocSearch Struct Reference
Universal Document Shell Document Search interafce. Through IPluginDocumentSearch, caller is able to do text search through in document. More...
#include <plugin_doc_search.h>
Data Fields | |
| IPluginUnknown *(* | create_search_criteria )(IPluginUnknown *thiz) |
| Create the search criteria object for next search. | |
| PluginStatus(* | request_search_next )(IPluginUnknown *thiz, IPluginUnknown *criteria, const UDSString *from_anchor, const unsigned int search_id) |
| Send a request to search next/prev string according to the search criteria. | |
| PluginStatus(* | request_search_all )(IPluginUnknown *thiz, IPluginUnknown *criteria, const unsigned int search_id) |
| Send a request of searching the objective string in the whole document. The plugin will return list of all matched anchors. | |
| PluginStatus(* | abort_search )(IPluginUnknown *thiz, const unsigned int search_id) |
| Abort search request that is identified by search_id. | |
Detailed Description
Universal Document Shell Document Search interafce. Through IPluginDocumentSearch, caller is able to do text search through in document.
Copyright (C) 2008 iRex Technologies B.V. All rights reserved.
Definition at line 43 of file plugin_doc_search.h.
Field Documentation
| PluginStatus(* IPluginDocSearch::abort_search)(IPluginUnknown *thiz, const unsigned int search_id) |
Abort search request that is identified by search_id.
- Parameters:
-
thiz IPluginUnknown pointer of document object. search_id The search task id that has been sent.
- Returns:
- This function returns PLUGIN_OK if plugin can abort the search task. It returns other values if something wrong with plugin. The possible reason can be invalid search id.
Referenced by text::PluginDocImpl::PluginDocImpl(), and pdf::PluginDocImpl::PluginDocImpl().
Create the search criteria object for next search.
- Parameters:
-
thiz IPluginUnknown pointer of IPluginDocSearcher object.
- Returns:
- Returns IPluginUnknown pointer of a search criteria object if it can successfully create the object; otherwise returns NULL.
Referenced by text::PluginDocImpl::PluginDocImpl(), and pdf::PluginDocImpl::PluginDocImpl().
| PluginStatus(* IPluginDocSearch::request_search_all)(IPluginUnknown *thiz, IPluginUnknown *criteria, const unsigned int search_id) |
Send a request of searching the objective string in the whole document. The plugin will return list of all matched anchors.
- Parameters:
-
thiz IPluginUnknown pointer of document object. criteria The IPluginUnknown pointer of Plugin document search criteria object.
- Returns:
- The search status of executing this request
Referenced by text::PluginDocImpl::PluginDocImpl(), and pdf::PluginDocImpl::PluginDocImpl().
| PluginStatus(* IPluginDocSearch::request_search_next)(IPluginUnknown *thiz, IPluginUnknown *criteria, const UDSString *from_anchor, const unsigned int search_id) |
Send a request to search next/prev string according to the search criteria.
- Parameters:
-
thiz IPluginUnknown pointer of document object. criteria The IPluginUnknown pointer of document search criteria object created by the document object. from_anchor The start position anchor. The plugin searches from this position if it's initialized by caller before the function is invoked. If this value is empty, plugin would search from the beginning of the document. When this function returns successfully, the position of cursor will be adjusted to the start anchor of first matched text.
- Returns:
- The search status of executing this request.
Referenced by text::PluginDocImpl::PluginDocImpl(), and pdf::PluginDocImpl::PluginDocImpl().
The documentation for this struct was generated from the following file:
