WordFinder Class Documentation

classWordFinder

Namespace:datalogics_interface

Detailed Description

A class used to extract words from a document.

Constructor & Destructor Documentation

~WordFinder

~WordFinder()

Member Function Documentation

enum_words

boolenum_words(intpage_num, WordCallbackcallback)

Parameters

page_num: int

The page number from which to extract words. Pass AllPages to sequentially process all pages in the document.

callback: WordCallback

A user-supplied callback to call once for each word found. Enumeration halts if wordProc returns false.

Returns:

true if enumeration was successfully completed, false if enumeration was terminated because wordProc returned false.

Extracts words, one at a time, from the specified page or the entire document. It calls a user-supplied procedure once for each word found.

Only words within or partially within the page's crop box (see Page::CropBox) are enumerated. Words outside the crop box are skipped.

Word objects passed to wordProc become invalid once the call to EnumWords returns, or if the page number changes between calls to the WordProc.

get_visible_word_list

std::vector< Word >get_visible_word_list(intpage_num)

Parameters

page_num: int

the page number for which to get the list of words.

Returns:

a list of x, y sorted words on the specified page.

Finds all Visible words on the specified page and returns a list containing the words. The words are sorted by their x- and y-coordinates on the page.

NOTE: Only words visible according to the Optional Content are returned.

get_word_list

std::vector< Word >get_word_list(intpage_num)

Parameters

page_num: int

the page number for which to get the list of words.

Returns:

a list of x, y sorted words on the specified page.

Finds all words on the specified page and returns a list containing the words. The words are sorted by their x- and y-coordinates on the page.

NOTE: All words found on the page are returned, even if they are currently invisible as specified by the Optional Content.