IPluginSearchCriteria Struct Reference

Univeral Document Shell Plugin Document Search Criteria interface Through IPluginSearchCriteria, caller can set search criteria on specified document object. More...

#include <plugin_search_criteria.h>

Inheritance diagram for IPluginSearchCriteria:

[legend]

Data Fields
PluginStatus(*	set_search_text )(IPluginUnknown *thiz, const UDSString *text)
	Define the search text.
PluginStatus(*	set_case_sensitive )(IPluginUnknown *thiz, const PluginBool is_sensitive)
	Define whether the searching is case sensitive.
PluginStatus(*	set_match_whole_word )(IPluginUnknown *thiz, const PluginBool do_match_word)
	Define whether searching matches the whole word or not.
PluginStatus(*	set_forward )(IPluginUnknown *thiz, const PluginBool do_search_forward)
	Define whether search forward or not.

---

Detailed Description

Univeral Document Shell Plugin Document Search Criteria interface Through IPluginSearchCriteria, caller can set search criteria on specified document object.

Copyright (C) 2008 iRex Technologies B.V. All rights reserved.

Definition at line 42 of file plugin_search_criteria.h.

---

Field Documentation

PluginStatus(* IPluginSearchCriteria::set_case_sensitive)(IPluginUnknown *thiz, const PluginBool is_sensitive)

Define whether the searching is case sensitive.

Parameters:

	thiz	The IPluginUnknown pointer to the IPluginSearchCriteria object.
	is_sensitive	Specify whether the searching is case sensitive or not. By default it is case insensitive.

Returns:

TODO. Add return codes here.

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

PluginStatus(* IPluginSearchCriteria::set_forward)(IPluginUnknown *thiz, const PluginBool do_search_forward)

Define whether search forward or not.

Parameters:

	thiz	The IPluginUnknown pointer of the search criteria object.
	do_search_forward	Specify whether support forward searching or not.

Returns:

TODO. Add return codes here.

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

PluginStatus(* IPluginSearchCriteria::set_match_whole_word)(IPluginUnknown *thiz, const PluginBool do_match_word)

Define whether searching matches the whole word or not.

Parameters:

	thiz	The IPluginUnknown pointer of the search criteria object.
	do_match_word	Specify whether match the whole word or not. By default it should NOT match the whole word.

Returns:

TODO. Add return codes here.

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

PluginStatus(* IPluginSearchCriteria::set_search_text)(IPluginUnknown *thiz, const UDSString *text)

Define the search text.

Parameters:

	thiz	The IPluginUnknown pointer of search criteria object.
	text	The string pattern. NOTE: This pattern MUST be UTF-8.

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

---

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

• plugin_search_criteria.h