Class: QgsHistoryEntryNode

Base class for nodes representing a QgsHistoryEntry.

Added in version 3.32.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsHistoryEntryNode

Subclasses

QgsHistoryEntryGroup

Base class for history entry “group” nodes, which contain children of their own.

Methods

childCount

Returns the number of child nodes owned by this node.

createWidget

Returns a new widget which should be shown to users when selecting the node.

data

Returns the node's data for the specified model role.

doubleClicked

Called when the node is double-clicked.

html

Returns a HTML formatted text string which should be shown to a user when selecting the node.

matchesString

Returns true if the node matches the specified searchString, and should be shown in filtered results with that search string.

parent

Returns the node's parent node.

populateContextMenu

Allows the node to populate a context menu before display to the user.
class qgis.gui.QgsHistoryEntryNode[source]

Bases: object

childCount(self) → int[source]

Returns the number of child nodes owned by this node.

Return type:

int

createWidget(self, context: QgsHistoryWidgetContext) → QWidget | None[source]

Returns a new widget which should be shown to users when selecting the node.

If a None is returned, the node’s html() method will be called instead to create the node’s content.

See also

html()

Parameters:

context (QgsHistoryWidgetContext)

Return type:

Optional[QWidget]

data(self, role: int = Qt.DisplayRole) → Any[source]

Returns the node’s data for the specified model role.

Parameters:

role (int = Qt.DisplayRole)

Return type:

Any

doubleClicked(self, context: QgsHistoryWidgetContext) → bool[source]

Called when the node is double-clicked. The default implementation does nothing.

Returns True if the node handled the double-click event and it should not be further processed.

Parameters:

context (QgsHistoryWidgetContext)

Return type:

bool

html(self, context: QgsHistoryWidgetContext) → str[source]

Returns a HTML formatted text string which should be shown to a user when selecting the node.

Subclasses should implement this method or createWidget(), but not both.

See also

createWidget()

Parameters:

context (QgsHistoryWidgetContext)

Return type:

str

matchesString(self, searchString: str | None) → bool[source]

Returns true if the node matches the specified searchString, and should be shown in filtered results with that search string.

The default implementation returns True if the string is contained within the node’s DisplayRole.

Parameters:

searchString (Optional[str])

Return type:

bool

parent(self) → QgsHistoryEntryGroup | None[source]

Returns the node’s parent node.

If parent is None, the node is a root node.

Return type:

Optional[QgsHistoryEntryGroup]

populateContextMenu(self, menu: QMenu | None, context: QgsHistoryWidgetContext)[source]

Allows the node to populate a context menu before display to the user.

Actions should be parented to the specified menu.

Parameters: