# QHelpSearchEngine Class Reference ## [[QtHelp](index.htm) module] 該QHelpSearchEngine類提供??可重復使用的部件來集成全文搜索，以及索引和搜索文檔。[More...](#details) 繼承[QObject](qobject.html)。 ### Methods * `__init__ (self, QHelpEngineCore?helpEngine, QObject?parent?=?None)` * `cancelIndexing (self)` * `cancelSearching (self)` * `int hitCount (self)` * `list-of-tuple-of-QString-QString hits (self, int?start, int?end)` * `int hitsCount (self)` * `list-of-QHelpSearchQuery query (self)` * `QHelpSearchQueryWidget queryWidget (self)` * `reindexDocumentation (self)` * `QHelpSearchResultWidget resultWidget (self)` * `search (self, list-of-QHelpSearchQuery?queryList)` ### Qt Signals * `void indexingFinished ()` * `void indexingStarted ()` * `void searchingFinished (int)` * `void searchingStarted ()` * * * ## Detailed Description 該QHelpSearchEngine類提供??可重復使用的部件來集成全文搜索，以及索引和搜索文檔。 之前的搜索引擎，可以使用1具有實例化至少一個[QHelpEngineCore](qhelpenginecore.html)對象需要被傳遞給搜索引擎的構造。這是必需的作為搜索引擎需要連接到setupFinished幫助引擎（）信號知道它何時可以開始索引文件。 起始索引過程的信號后[indexingStarted](qhelpsearchengine.html#indexingStarted)（）被發射和在索引過程結束時[indexingFinished](qhelpsearchengine.html#indexingFinished)（）被發射。要停止索引可以調用[cancelIndexing](qhelpsearchengine.html#cancelIndexing)（ ） 。 而索引過程完成后，搜索引擎現在可以用來進行搜索直通其索引為一個給定的術語。要做到這一點人們可以使用創建的可能性[QHelpSearchQuery](qhelpsearchquery.html)通過自我列出或重用[QHelpSearchQueryWidget](qhelpsearchquerywidget.html)它具有inbuild功能設置的得到傳遞給搜索引擎一個適當的搜索查詢列表[search](qhelpsearchengine.html#search)（）函數。 經過查詢列表中已經傳遞給搜索引擎，信號[searchingStarted](qhelpsearchengine.html#searchingStarted)（）被發射，并在搜索完成后[searchingFinished](qhelpsearchengine.html#searchingFinished)（）信號被發射。搜索過程可以通過調用停止[cancelSearching](qhelpsearchengine.html#cancelSearching)（ ） 。 如果搜索成功，則[searchingFinished](qhelpsearchengine.html#searchingFinished)（ ）將被調用的搜索命中計數，可重復使用來獲取搜索點擊來自搜索引擎。調用[hits](qhelpsearchengine.html#hits)點擊與您希望得到的range（）函數將返回請求SearchHits列表。他們基本上constist在對字符串如該對的值是文檔文件的路徑和頁面標題的那一刻。 要顯示給定的命中使用[QHelpSearchResultWidget](qhelpsearchresultwidget.html)或者如果您需要更高級的功能，建立自己的之一。注意，這個[QHelpSearchResultWidget](qhelpsearchresultwidget.html)不能直接實例化，必須從搜索引擎檢索的部件在使用中的所有連接將被小部件本身建立適合你。 * * * ## Method Documentation ``` QHelpSearchEngine.__init__ (self, QHelpEngineCore?helpEngine, QObject?parent?=?None) ``` 該_parent_的說法，如果不是沒有，原因_self_通過Qt的，而不是PyQt的擁有。 構造一個新的搜索引擎與給定_parent_。該搜索引擎使用給定的_helpEngine_訪問需要被索引的文檔。該[QHelpEngine](qhelpengine.html)的setupFinished （ ）信號被自動連接到[QHelpSearchEngine](qhelpsearchengine.html)的索引函數，從而使信號被發射之后，新的文件將被編入索引。 ``` QHelpSearchEngine.cancelIndexing (self) ``` 這種方法也是一個Qt槽與C + +的簽名`void cancelIndexing()`。 停止索引過程。 ``` QHelpSearchEngine.cancelSearching (self) ``` 這種方法也是一個Qt槽與C + +的簽名`void cancelSearching()`。 停止搜索過程。 ``` int QHelpSearchEngine.hitCount (self) ``` 返回的搜索引擎找到的點擊量。 此功能被引入Qt的4.6 。 ``` list-of-tuple-of-QString-QString QHelpSearchEngine.hits (self, int?start, int?end) ``` 返回范圍內的搜索命中列表_start_ _end_。 ``` int QHelpSearchEngine.hitsCount (self) ``` ``` list-of-QHelpSearchQuery QHelpSearchEngine.query (self) ``` 返回查詢列表中最后一個被搜索的。 此功能被引入Qt的4.5 。 ``` QHelpSearchQueryWidget QHelpSearchEngine.queryWidget (self) ``` [ 返回一個widget作為輸入部件使用。根據您的搜索引擎的配置，你會得到一個不同的小部件或多或少subwidgets 。 ``` QHelpSearchEngine.reindexDocumentation (self) ``` 這種方法也是一個Qt槽與C + +的簽名`void reindexDocumentation()`。 迫使搜索引擎重新索引所有的文檔文件。 ](qhelpsearchquerywidget.html) ``` QHelpSearchResultWidget QHelpSearchEngine.resultWidget (self) ``` [ 返回一個小工具，可以容納并顯示搜索結果。 ``` QHelpSearchEngine.search (self, list-of-QHelpSearchQuery?queryList) ``` 這種方法也是一個Qt槽與C + +的簽名`void search(const QList<QHelpSearchQuery>&)`。 使用查詢的給定列表開始搜索過程_queryList_構建由搜索字段名稱和值來搜索。 * * * ## Qt Signal Documentation ``` void indexingFinished () ``` 這是該信號的默認超載。 當索引過程完成后，這個信號被發射。 ``` void indexingStarted () ``` 這是該信號的默認超載。 當開始索引過程中這個信號被發射。 ``` void searchingFinished (int) ``` 這是該信號的默認超載。 當搜索過程就完成了這個信號被發射。命中計數存儲在_hits_。 ``` void searchingStarted () ``` 這是該信號的默認超載。 當開始搜索處理這個信號被發射。 ](qhelpsearchresultwidget.html)