QHelpEngineCore¶

PyQt5.QtHelp.QHelpEngineCore

Inherits from QObject.

Description¶

The QHelpEngineCore class provides the core functionality of the help system.

Before the help engine can be used, it must be initialized by calling setupData(). At the beginning of the setup process the signal setupStarted is emitted. From this point on until the signal setupFinished is emitted, is the help data in an undefined meaning unusable state.

The core help engine can be used to perform different tasks. By calling linksForIdentifier() the engine returns URLs specifying the file locations inside the help system. The actual file data can then be retrived by calling fileData(). In contrast to all other functions in this class, linksForIdentifier() depends on the currently set custom filter. Depending on the filter, the function may return different results.

Every help engine can contain any number of custom filters. A custom filter is defined by a name and set of filter attributes and can be added to the help engine by calling addCustomFilter(). Analogous, it is removed by calling removeCustomFilter(). customFilters() returns all defined filters.

The help engine also offers the possibility to set and read values in a persistant way comparable to ini files or Windows registry entries. For more information see setValue() or value().

This class does not offer any GUI components or functionality for indices or contents. If you need one of those use QHelpEngine instead.

When creating a custom help viewer the viewer can be configured by writing a custom collection file which could contain various keywords to be used to configure the help engine. These keywords and values and their meaning can be found in the help information for creating a custom help collection file for Assistant.

Methods¶

__init__(str, parent: QObject = None): Constructs a new core help engine with a parent. The help engine uses the information stored in the collectionFile to provide help. If the collection file does not exist yet, it’ll be created.

addCustomFilter(str, Iterable[str]) → bool: Adds the new custom filter filterName. The filter attributes are specified by attributes. If the filter already exists, its attribute set is replaced. The function returns true if the operation succeeded, otherwise it returns false.

See also

customFilters(), removeCustomFilter().

autoSaveFilter() → bool: See also

setAutoSaveFilter().

collectionFile() → str: See also

setCollectionFile().

copyCollectionFile(str) → bool

Creates the file fileName and copies all contents from the current collection file into the newly created file, and returns true if successful; otherwise returns false.

The copying process makes sure that file references to Qt Collection files (.qch) files are updated accordingly.

currentFilter() → str: See also

setCurrentFilter().

customFilters() → List[str]: Returns a list of custom filters.

See also

addCustomFilter(), removeCustomFilter().

customValue(str, defaultValue: Any = None) → Any: Returns the value assigned to the key. If the requested key does not exist, the specified defaultValue is returned.

See also

setCustomValue(), removeCustomValue().

documentationFileName(str) → str: Returns the absolute file name of the Qt compressed help file (.qch) identified by the namespaceName. If there is no Qt compressed help file with the specified namespace registered, an empty string is returned.

See also

namespaceName().

error() → str: Returns a description of the last error that occurred.

fileData(QUrl) → QByteArray: Returns the data of the file specified by url. If the file does not exist, an empty QByteArray is returned.

See also

findFile().

files(str, Iterable[str], extensionFilter: str = '') → List[QUrl]: Returns a list of files contained in the Qt compressed help file namespaceName. The files can be filtered by filterAttributes as well as by their extension extensionFilter (e.g. ‘html’).

files(str, str, extensionFilter: str = '') → List[QUrl]: TODO

filterAttributes() → List[str]: Returns a list of all defined filter attributes.

filterAttributes(str) → List[str]: Returns a list of filter attributes used by the custom filter filterName.

filterAttributeSets(str) → List[List[str]]: Returns a list of filter attributes for the different filter sections defined in the Qt compressed help file with the given namespace namespaceName.

filterEngine() → QHelpFilterEngine: TODO

findFile(QUrl) → QUrl: Returns an invalid URL if the file url cannot be found. If the file exists, either the same url is returned or a different url if the file is located in a different namespace which is merged via a common virtual folder.

linksForIdentifier(str) → Dict[str, QUrl]: Returns documents found for the id. The map contains the document titles and their URLs. The returned map contents depends on the current filter, meaning only the keywords registered for the current filter will be returned.

linksForKeyword(str) → Dict[str, QUrl]: Returns all documents found for the keyword. The returned map consists of the document titles and their URLs.

@staticmethod metaData(str, str) → Any: Returns the meta data for the Qt compressed help file documentationFileName. If there is no data available for name, an invalid QVariant() is returned. The meta data is defined when creating the Qt compressed help file and cannot be modified later. Common meta data includes e.g. the author of the documentation.

@staticmethod namespaceName(str) → str: Returns the namespace name defined for the Qt compressed help file (.qch) specified by its documentationFileName. If the file is not valid, an empty string is returned.

See also

documentationFileName().

registerDocumentation(str) → bool: Registers the Qt compressed help file (.qch) contained in the file documentationFileName. One compressed help file, uniquely identified by its namespace can only be registered once. True is returned if the registration was successful, otherwise false.

See also

unregisterDocumentation(), error().

registeredDocumentations() → List[str]: Returns a list of all registered Qt compressed help files of the current collection file. The returned names are the namespaces of the registered Qt compressed help files (.qch).

removeCustomFilter(str) → bool: Returns true if the filter filterName was removed successfully, otherwise false.

See also

addCustomFilter(), customFilters().

removeCustomValue(str) → bool: Removes the key from the settings section in the collection file. Returns true if the value was removed successfully, otherwise false.

See also

customValue(), setCustomValue().

setAutoSaveFilter(bool): See also

autoSaveFilter().

setCollectionFile(str): See also

collectionFile().

setCurrentFilter(str): See also

currentFilter().

setCustomValue(str, Any) → bool: Save the value under the key. If the key already exist, the value will be overwritten. Returns true if the value was saved successfully, otherwise false.

See also

customValue(), removeCustomValue().

setupData() → bool

Sets up the help engine by processing the information found in the collection file and returns true if successful; otherwise returns false.

By calling the function, the help engine is forced to initialize itself immediately. Most of the times, this function does not have to be called explicitly because getter functions which depend on a correctly set up help engine do that themselves.

Note: qsqlite4.dll needs to be deployed with the application as the help system uses the sqlite driver when loading help collections.

setUsesFilterEngine(bool): TODO

unregisterDocumentation(str) → bool: Unregisters the Qt compressed help file (.qch) identified by its namespaceName from the help collection. Returns true on success, otherwise false.

See also

registerDocumentation(), error().

usesFilterEngine() → bool: TODO

Signals¶

currentFilterChanged(str): TODO

readersAboutToBeInvalidated(): TODO

setupFinished(): TODO

setupStarted(): TODO

warning(str): TODO