Package ghidra.app.util.viewer.listingpanel

Class ApplyFunctionSignatureAction

  • All Implemented Interfaces:
    DockingActionIf, HelpDescriptor
    public class ApplyFunctionSignatureAction
extends ghidra.app.plugin.core.functioncompare.AbstractApplyFunctionSignatureAction
    Action that applies the signature of the function in the currently active side of a listing code comparison panel to the function in the other side of the panel.

    • Constructor Detail

      • ApplyFunctionSignatureAction

        public ApplyFunctionSignatureAction​(java.lang.String owner)
        Constructor for the action that applies a function signature from one side of a dual listing panel to the other.
        Parameters:
        owner - the owner of this action.

    • Method Detail

      • isAddToPopup

        public boolean isAddToPopup​(ActionContext context)
        Description copied from interface: DockingActionIf
        method is used to determine if this action should be displayed on the current popup. This method will only be called if the action has popup PopupMenuData set.

        Generally, actions don't need to override this method as the default implementation will defer to the DockingActionIf.isEnabledForContext(ActionContext), which will have the effect of adding the action to the popup only if it is enabled for a given context. By overriding this method, you can change this behavior so that the action will be added to the popup, even if it is disabled for the context, by having this method return true even if the DockingActionIf.isEnabledForContext(ActionContext) method will return false, resulting in the action appearing in the popup menu, but begin disabled.

        Specified by:
        isAddToPopup in interface DockingActionIf
        Specified by:
        isAddToPopup in class ghidra.app.plugin.core.functioncompare.AbstractApplyFunctionSignatureAction
        Parameters:
        context - the ActionContext from the active provider.
        Returns:
        true if this action is appropriate for the given context.

      • isEnabledForContext

        public boolean isEnabledForContext​(ActionContext context)
        Description copied from interface: DockingActionIf
        Method used to determine if this action should be enabled for the given context.

        This is the method implementors override to control when the action may be used.

        This method will be called by the DockingWindowManager for actions on the global menuBar and toolBar and for actions that have a keyBinding.

        This method will be called whenever one of the following events occur:

        1. when the user invokes the action via its keyBinding,
        2. the user changes focus from one component provider to another,
        3. the user moves a component to another position in the window or into another window,
        4. a component provider reports a change in it's context,
        5. any plugin or software component reports a general change in context (calls the tool.contextChanged(ComponentProvider) with a null parameter).
        The default implementation will simply return this action's enablement state.
        Specified by:
        isEnabledForContext in interface DockingActionIf
        Specified by:
        isEnabledForContext in class ghidra.app.plugin.core.functioncompare.AbstractApplyFunctionSignatureAction
        Parameters:
        context - the current ActionContext for the window.
        Returns:
        true if the action should be enabled for the context or false otherwise.