QHelpEngineCore Class Reference · PyQt4 中文文檔

# QHelpEngineCore Class Reference ## [[QtHelp](index.htm) module] 該QHelpEngineCore類提供了幫助系統的核心功能。[More...](#details) 繼承[QObject](qobject.html)。通過繼承[QHelpEngine](qhelpengine.html)。 ### Methods * `__init__ (self, QString?collectionFile, QObject?parent?=?None)` * `bool addCustomFilter (self, QString?filterName, QStringList?attributes)` * `bool autoSaveFilter (self)` * `QString collectionFile (self)` * `bool copyCollectionFile (self, QString?fileName)` * `QString currentFilter (self)` * `QStringList customFilters (self)` * `QVariant customValue (self, QString?key, QVariant?defaultValue?=?QVariant())` * `QString documentationFileName (self, QString?namespaceName)` * `QString error (self)` * `QByteArray fileData (self, QUrl?url)` * `list-of-QUrl files (self, QString?namespaceName, QStringList?filterAttributes, QString?extensionFilter?=?QString())` * `QStringList filterAttributes (self)` * `QStringList filterAttributes (self, QString?filterName)` * `list-of-QStringList filterAttributeSets (self, QString?namespaceName)` * `QUrl findFile (self, QUrl?url)` * `dict-of-QString-QUrl linksForIdentifier (self, QString?id)` * `bool registerDocumentation (self, QString?documentationFileName)` * `QStringList registeredDocumentations (self)` * `bool removeCustomFilter (self, QString?filterName)` * `bool removeCustomValue (self, QString?key)` * `setAutoSaveFilter (self, bool?save)` * `setCollectionFile (self, QString?fileName)` * `setCurrentFilter (self, QString?filterName)` * `bool setCustomValue (self, QString?key, QVariant?value)` * `bool setupData (self)` * `bool unregisterDocumentation (self, QString?namespaceName)` ### Static Methods * `QVariant metaData (QString?documentationFileName, QString?name)` * `QString namespaceName (QString?documentationFileName)` ### Qt Signals * `void currentFilterChanged (const QString&)` * `void setupFinished ()` * `void setupStarted ()` * `void warning (const QString&)` * * * ## Detailed Description 該QHelpEngineCore類提供了幫助系統的核心功能。之前的幫助引擎可以被使用，它必須通過調用初始化[setupData](qhelpenginecore.html#setupData)（）。在安裝過程中的信號的開頭[setupStarted](qhelpenginecore.html#setupStarted)（）被發射。從這點上，直到該信號[setupFinished](qhelpenginecore.html#setupFinished)（）被發射，是在一個不確定的意義不可用狀態的幫助數據。核心幫助引擎可用于執行不同的任務。通過調用[linksForIdentifier](qhelpenginecore.html#linksForIdentifier)（）的引擎返回的URL中指定幫助系統內的文件位置。實際的文件數據可以通過調用retrived[fileData](qhelpenginecore.html#fileData)（）。相反，在這個類中的所有其他功能，[linksForIdentifier](qhelpenginecore.html#linksForIdentifier)（）取決于當前設置的自定義過濾器。根據不同的過濾器，該函數可能返回不同的點擊率。每一個幫助引擎可以包含任意數量的自定義過濾器。自定義過濾器是由一個名稱來定義，并設置過濾器的屬性，并可以通過調用被添加到幫助引擎[addCustomFilter](qhelpenginecore.html#addCustomFilter)（）。類似的，它是通過調用刪除[removeCustomFilter](qhelpenginecore.html#removeCustomFilter)（）。[customFilters](qhelpenginecore.html#customFilters)（）返回所有定義的過濾器。幫助引擎還提供了一個持續性的方式媲美ini文件或Windows注冊表項設置和讀取的值的可能性。欲了解更多信息，請參閱的setValue （）或（）的值。這個類不提供任何GUI組件或功能的指標或內容。如果您需要這些使用的一個[QHelpEngine](qhelpengine.html)代替。當創建一個自定義幫助觀眾觀眾可以通過寫其中可能包含不同的關鍵字被用于配置幫助引擎的自定義集合文件中進行配置。這些關鍵字和值和它們的含義可以在幫助信息中找到 [creating a custom help collection file](index.htm#creating-a-custom-help-collection-file)助理。 * * * ## Method Documentation ``` QHelpEngineCore.__init__ (self, QString?collectionFile, QObject?parent?=?None) ``` 該_parent_的說法，如果不是沒有，原因_self_通過Qt的，而不是PyQt的擁有。構造一個新的核心引擎的幫助用_parent_。幫助引擎使用存儲在信息_collectionFile_提供幫助。如果集合文件還不存在，它會被創建。 ``` bool QHelpEngineCore.addCustomFilter (self, QString?filterName, QStringList?attributes) ``` 添加新的自定義過濾器_filterName_。該過濾器的屬性被指定_attributes_。如果過濾器已經存在，它的屬性設置將被替換。該函數返回True如果操作成功，否則返回False 。 **See also** [customFilters](qhelpenginecore.html#customFilters)（）和[removeCustomFilter](qhelpenginecore.html#removeCustomFilter)（）。 ``` bool QHelpEngineCore.autoSaveFilter (self) ``` ``` QString QHelpEngineCore.collectionFile (self) ``` ``` bool QHelpEngineCore.copyCollectionFile (self, QString?fileName) ``` 創建文件_fileName_如果成功，將文件從當前集合文件到新創建的文件中的所有內容，并返回True，否則返回False 。在復制過程可確保文件引用的Qt收集文件（`.qch`）文件也會相應更新。 ``` QString QHelpEngineCore.currentFilter (self) ``` ``` QStringList QHelpEngineCore.customFilters (self) ``` 返回自定義過濾器的列表。 **See also** [addCustomFilter](qhelpenginecore.html#addCustomFilter)（）和[removeCustomFilter](qhelpenginecore.html#removeCustomFilter)（）。 ``` QVariant QHelpEngineCore.customValue (self, QString?key, QVariant?defaultValue?=?QVariant()) ``` 返回賦予的價值_key_。如果請求的鍵不存在，則指定_defaultValue_返回。 **See also** [setCustomValue](qhelpenginecore.html#setCustomValue)（）和[removeCustomValue](qhelpenginecore.html#removeCustomValue)（）。 ``` QString QHelpEngineCore.documentationFileName (self, QString?namespaceName) ``` 返回Qt的壓縮幫助文件確定的絕對文件名（。 QCH ）_namespaceName_。如果沒有注冊與指定的命名空間的Qt壓縮幫助文件，則返回一個空字符串。 **See also** [namespaceName](qhelpenginecore.html#namespaceName)（）。 ``` QString QHelpEngineCore.error (self) ``` 返回上次發生錯誤的描述。 ``` QByteArray QHelpEngineCore.fileData (self, QUrl?url) ``` [](qbytearray.html) [返回文件所指定的數據_url_。如果文件不存在，空](qbytearray.html)[QByteArray](qbytearray.html)返回。 **See also** [findFile](qhelpenginecore.html#findFile)（）。 ``` list-of-QUrl QHelpEngineCore.files (self, QString?namespaceName, QStringList?filterAttributes, QString?extensionFilter?=?QString()) ``` 返回文件包含了Qt壓縮幫助文件中的列表_namespaceName_。該文件可以被過濾_filterAttributes_以及由它們的擴展名_extensionFilter_（例如，“ HTML” ）。 ``` QStringList QHelpEngineCore.filterAttributes (self) ``` 返回所有定義的過濾器屬性列表。 ``` QStringList QHelpEngineCore.filterAttributes (self, QString?filterName) ``` 返回過濾器屬性所使用的自定義過濾器列表_filterName_。 ``` list-of-QStringList QHelpEngineCore.filterAttributeSets (self, QString?namespaceName) ``` 返回過濾器的屬性為Qt的壓縮幫助文件中定義與給定的命名空間中的不同的過濾器部分的列表_namespaceName_。 ``` QUrl QHelpEngineCore.findFile (self, QUrl?url) ``` [ 返回一個無效的URL ，如果該文件_url_無法找到。如果該文件存在，則返回無論是同一個URL或一個不同的URL ，如果該文件位于這是通過一個共同的虛擬文件夾合并不同的命名空間。 ``` dict-of-QString-QUrl QHelpEngineCore.linksForIdentifier (self, QString?id) ``` 返回命中發現了一個地圖_id_。一擊中的包含文件的標題和URL所在的關鍵字的位置。其結果取決于當前的過濾器，這意味著只有注冊為當前過濾器的關鍵字將被退回。 ``` QVariant QHelpEngineCore.metaData (QString?documentationFileName, QString?name) ``` 返回的元數據Qt的壓縮幫助文件_documentationFileName_。如果沒有可用的無數據_name_，一個無效的QVariant （）返回。元數據是指創建Qt的壓縮幫助文件時，不能在以后修改。通用元數據包括例如文檔的作者。 ``` QString QHelpEngineCore.namespaceName (QString?documentationFileName) ``` 返回由指定Qt的壓縮幫助文件中定義的命名空間名稱（ QCH ）其_documentationFileName_。如果該文件是無效的，則返回一個空字符串。 ](qurl.html) [**See also**](qurl.html) [documentationFileName](qhelpenginecore.html#documentationFileName)（）。 ``` bool QHelpEngineCore.registerDocumentation (self, QString?documentationFileName) ``` 寄存器文件中包含了Qt壓縮的幫助文件（。 QCH ）_documentationFileName_。一個壓縮的幫助文件，其命名空間唯一標識，只能注冊一次。返回True ，如果注冊成功，否則為False。 **See also** [unregisterDocumentation](qhelpenginecore.html#unregisterDocumentation)（）和[error](qhelpenginecore.html#error)（）。 ``` QStringList QHelpEngineCore.registeredDocumentations (self) ``` 返回當前集合文件的所有已注冊的Qt壓縮幫助文件的列表。返回的名稱是注冊的Qt壓縮的幫助文件（。 QCH ）的命名空間。 ``` bool QHelpEngineCore.removeCustomFilter (self, QString?filterName) ``` 返回True如果過濾器_filterName_成功移除，否則為False 。 **See also** [addCustomFilter](qhelpenginecore.html#addCustomFilter)（）和[customFilters](qhelpenginecore.html#customFilters)（）。 ``` bool QHelpEngineCore.removeCustomValue (self, QString?key) ``` 移除_key_從集合文件中的設置部分。如果該值被刪除成功，否則為False ，則返回True 。 **See also** [customValue](qhelpenginecore.html#customValue)（）和[setCustomValue](qhelpenginecore.html#setCustomValue)（）。 ``` QHelpEngineCore.setAutoSaveFilter (self, bool?save) ``` ``` QHelpEngineCore.setCollectionFile (self, QString?fileName) ``` ``` QHelpEngineCore.setCurrentFilter (self, QString?filterName) ``` ``` bool QHelpEngineCore.setCustomValue (self, QString?key, QVariant?value) ``` 保存_value_下_key_。如果鍵已經存在，則該值將被復蓋。返回True如果該值已成功保存，否則為False 。 **See also** [customValue](qhelpenginecore.html#customValue)（）和[removeCustomValue](qhelpenginecore.html#removeCustomValue)（）。 ``` bool QHelpEngineCore.setupData (self) ``` 設置了幫助發動機通過處理發現在收集文件并返回True，如果成功的信息，否則返回False 。通過調用函數時，幫助引擎是被迫立即初始化。大部分的時間，這個功能并沒有被顯式調用，因為它依賴于正確設置了幫助發動機getter函數做自己。 **Note:** `qsqlite4.dll`需要部署的應用程序加載的幫助集合時幫助系統使用sqlite的驅動程序。 ``` bool QHelpEngineCore.unregisterDocumentation (self, QString?namespaceName) ``` 注銷確定其Qt的壓縮的幫助文件（。 QCH ）_namespaceName_從幫助集合。成功時返回TRUE ，否則返回False 。 **See also** [registerDocumentation](qhelpenginecore.html#registerDocumentation)（）和[error](qhelpenginecore.html#error)（）。 * * * ## Qt Signal Documentation ``` void currentFilterChanged (const QString&) ``` 這是該信號的默認超載。當電流過濾器改變為這個信號被發射_newFilter_。 ``` void setupFinished () ``` 這是該信號的默認超載。當設置完成后這個信號被發射。 ``` void setupStarted () ``` 這是該信號的默認超載。當安裝程序啟動這個信號被發射。 ``` void warning (const QString&) ``` 這是該信號的默認超載。當一個非關鍵性錯誤發生時，這個信號被發射。警告消息存儲在_msg_。