PySide6.QtHelp.QHelpContentModel¶

class QHelpContentModel¶

The QHelpContentModel class provides a model that supplies content to views. More…

Synopsis¶

Methods¶

def contentItemAt()
def createContents()
def createContentsForCurrentFilter()
def isCreatingContents()

Signals¶

def contentsCreated()
def contentsCreationStarted()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

contentItemAt(index)¶

Parameters:: index – QModelIndex
Return type:: QHelpContentItem

Returns the help content item at the model index position index.

contentsCreated()¶

This signal is emitted when the contents have been created.

contentsCreationStarted()¶

This signal is emitted when the creation of the contents has started. The current contents are invalid from this point on until the signal contentsCreated() is emitted.

See also

isCreatingContents()

createContents(customFilterName)¶

Parameters:: customFilterName – str

Creates new contents by querying the help system for contents specified for the custom filter name.

createContentsForCurrentFilter()¶

Creates new contents by querying the help system for contents specified for the current filter.

isCreatingContents()¶

Return type:: bool

Returns true if the contents are currently rebuilt, otherwise false.