Obsolete Members for QHelpEngineCore

以下成员源于类 QHelpEngineCore 已过时。 提供它们是为使旧源代码能继续工作。强烈建议不要在新代码中使用它们。

特性

• (obsolete) currentFilter : QString

公共函数

(obsolete) bool	addCustomFilter (const QString & filterName , const QStringList & 属性 )
(obsolete) QString	currentFilter () const
(obsolete) QStringList	customFilters () const
(obsolete) QList<QUrl>	文件 (const QString namespaceName , const QStringList & filterAttributes , const QString & extensionFilter = QString())
(obsolete) QList<QStringList>	filterAttributeSets (const QString & namespaceName ) const
(obsolete) QStringList	filterAttributes () const
(obsolete) QStringList	filterAttributes (const QString & filterName ) const
(obsolete) QMap<QString, QUrl>	linksForIdentifier (const QString & id ) const
(obsolete) QMap<QString, QUrl>	linksForKeyword (const QString & keyword ) const
(obsolete) bool	removeCustomFilter (const QString & filterName )
(obsolete) void	setCurrentFilter (const QString & filterName )

信号

(obsolete) void	currentFilterChanged (const QString & newFilter )
(obsolete) void	readersAboutToBeInvalidated ()

特性文档编制

currentFilter : QString

This property is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

This property holds the name of the custom filter currently applied.

QHelpFilterEngine::activeFilter () 应该被使用以取而代之。

Setting this property will save the new custom filter permanently in the help collection file. To set a custom filter without saving it permanently, disable the auto save filter mode.

该特性在 Qt 4.5 引入。

访问函数：

QString	currentFilter () const
void	setCurrentFilter (const QString & filterName )

另请参阅 autoSaveFilter ().

成员函数文档编制

[signal] void QHelpEngineCore:: currentFilterChanged (const QString & newFilter )

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::filterActivated () 应该被使用以取而代之。

This signal is emitted when the current filter is changed to newFilter .

[signal] void QHelpEngineCore:: readersAboutToBeInvalidated ()

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

bool QHelpEngineCore:: addCustomFilter (const QString & filterName , const QStringList & 属性 )

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::setFilterData () 应该被使用以取而代之。

Adds the new custom filter filterName . The filter attributes are specified by 属性 . If the filter already exists, its attribute set is replaced. The function returns true if the operation succeeded, otherwise it returns false.

另请参阅 customFilters () 和 removeCustomFilter ().

QStringList QHelpEngineCore:: customFilters () const

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::filters () 应该被使用以取而代之。

Returns a list of custom filters.

另请参阅 addCustomFilter () 和 removeCustomFilter ().

QList < QUrl > QHelpEngineCore:: 文件 (const QString namespaceName , const QStringList & filterAttributes , const QString & extensionFilter = QString())

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

files() should be used instead.

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').

QList < QStringList > QHelpEngineCore:: filterAttributeSets (const QString & namespaceName ) const

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::filterData () 应该被使用以取而代之。

Returns a list of filter attributes for the different filter sections defined in the Qt compressed help file with the given namespace namespaceName .

QStringList QHelpEngineCore:: filterAttributes () const

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::availableComponents () 应该被使用以取而代之。

Returns a list of all defined filter attributes.

QStringList QHelpEngineCore:: filterAttributes (const QString & filterName ) const

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::filterData () 应该被使用以取而代之。

Returns a list of filter attributes used by the custom filter filterName .

QMap < QString , QUrl > QHelpEngineCore:: linksForIdentifier (const QString & id ) const

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

使用 documentsForIdentifier () 代替。

Returns a map of the documents found for the id . The map contains the document titles and their URLs. The returned map contents depend on the current filter, and therefore only the identifiers registered for the current filter will be returned.

QMap < QString , QUrl > QHelpEngineCore:: linksForKeyword (const QString & keyword ) const

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

使用 documentsForKeyword () 代替。

Returns a map of all the documents found for the keyword . The map contains the document titles and URLs. The returned map contents depend on the current filter, and therefore only the keywords registered for the current filter will be returned.

bool QHelpEngineCore:: removeCustomFilter (const QString & filterName )

此函数已过时。提供它是为使旧源代码能继续工作。强烈建议不要在新代码中使用它。

QHelpFilterEngine::removeFilter () 应该被使用以取而代之。

Returns true if the filter filterName was removed successfully, otherwise false.

另请参阅 addCustomFilter () 和 customFilters ().