Package ghidra.util

Interface DynamicHelpLocation

public interface DynamicHelpLocation
An interface that can be added to the HelpService that signals the client has help that may change over time. The Help system will query this class to see if there is help for the registered object at the time help is requested. A client may register a static help location and an instance of this class with the Help system.

This can be used by a component to change the help location based on focus or mouse interaction. Typically a component will have one static help location. However, if that component has help for different areas within the component, then this interface allows that component to return any active help. This is useful for components that perform custom painting of regions, in which case that region has no object to use for adding help to the help system.

  • Method Details

    • getActiveHelpLocation

      HelpLocation getActiveHelpLocation()
      Returns:
      the current help location or null if there is currently no help for the client.