Obsolete Members for QHelpEngineCore

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

特性

公共函数

(弃用) bool addCustomFilter (const QString & filterName , const QStringList & 属性 )
(弃用) QString currentFilter () const
(弃用) QStringList customFilters () const
(弃用) QList<QUrl> 文件 (const QString namespaceName , const QStringList & filterAttributes , const QString & extensionFilter = QString())
(弃用) QList<QStringList> filterAttributeSets (const QString & namespaceName ) const
(弃用) QStringList filterAttributes () const
(弃用) QStringList filterAttributes (const QString & filterName ) const
(弃用) bool removeCustomFilter (const QString & filterName )
(弃用) void setCurrentFilter (const QString & filterName )

信号

(弃用) void currentFilterChanged (const QString & newFilter )
(弃用) void readersAboutToBeInvalidated ()

特性文档编制

currentFilter : QString

This property is deprecated. 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.

访问函数:

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

另请参阅 autoSaveFilter ().

成员函数文档编制

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

This function is deprecated. We strongly advise against using it in new code.

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

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.

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

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

This function is deprecated. We strongly advise against using it in new code.

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

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

QStringList QHelpEngineCore:: customFilters () const

This function is deprecated. We strongly advise against using it in new code.

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

Returns a list of custom filters.

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

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

This function is deprecated. We strongly advise against using it in new code.

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

This function is deprecated. We strongly advise against using it in new code.

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

This function is deprecated. We strongly advise against using it in new code.

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

Returns a list of all defined filter attributes.

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

This function is deprecated. We strongly advise against using it in new code.

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

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

[signal] void QHelpEngineCore:: readersAboutToBeInvalidated ()

This function is deprecated. We strongly advise against using it in new code.

bool QHelpEngineCore:: removeCustomFilter (const QString & filterName )

This function is deprecated. We strongly advise against using it in new code.

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

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

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