schrodinger.ui.qt.standard.components.help_button module

class schrodinger.ui.qt.standard.components.help_button.HelpButtonMixin(*args, **kwargs)

Bases: object

Mixin to define the behavior of a help button. Subclasses should define its appearance.

Help buttons show a context menu on hover. The menu can include options like Tutorials, Maestro Assistant, and Documentation.

The menu is shown only if at least one of the following conditions is met:

• Tutorials are available for the specified help topic ID.

• Maestro is available, _maestro_assistant_context is not None,

  and MAESTRO_ASSISTANT_ENABLED feature flag is enabled.

Variables:

• tutorialRequested (QtCore.pyqtSignal(str)) – Signal for requesting launching a tutorial, emitted when a tutorial is clicked. This emits the tutorial topic string required to launch the help dialog.

• documentationRequested (QtCore.pyqtSignal) – Signal emitted when a user action requests documentation to be shown.

tutorialRequested

A pyqtSignal emitted by instances of the class.

documentationRequested

A pyqtSignal emitted by instances of the class.

__init__(*args, **kwargs)

Set up the tool button and the ellipsis button on top.

setHelpTopic(help_topic: str)

Set the tutorial mapping for the menu using the given help topic. This map is used to populate the menu actions along with the tutorial ID.

Parameters:

help_topic – panel specific help topic

setMaestroAssistantContext(context: str | None)

Show the Maestro Assistant option in the help menu, clicking on which opens Maestro Assistant panel with the specified context. If context is None, the Maestro Assistant option will not be shown.

Parameters:

context – The context to pass to the Maestro Assistant panel.

isMaestroAssistantOptionShown() → bool

Return whether the Maestro Assistant option is shown in the help menu.

Returns:

True if the Maestro Assistant option is shown, False otherwise.

enterEvent(event)

leaveEvent(event)

class schrodinger.ui.qt.standard.components.help_button.HelpButton(*args, **kwargs)

Bases: HelpButtonMixin, IconButton

__init__(*args, **kwargs)

Set up the tool button and the ellipsis button on top.