Package ghidra.app.events
Class ProgramLocationPluginEvent
- java.lang.Object
-
- ghidra.framework.plugintool.PluginEvent
-
- ghidra.app.events.ProgramLocationPluginEvent
-
public final class ProgramLocationPluginEvent extends PluginEvent
This plugin event class provides program location information. The event is fired when a plugin's program location has changed. Typically, a plugin does not actually generate the event unless it is processing some user action, e.g., the user mouse clicks somewhere on a plugin component to cause the program location to change.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringNAMEThe name of this plugin event.-
Fields inherited from class ghidra.framework.plugintool.PluginEvent
EXTERNAL_SOURCE_NAME
-
-
Constructor Summary
Constructors Constructor Description ProgramLocationPluginEvent(java.lang.String src, ProgramLocation loc, Program program)Construct a new ProgramLocationEvent.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.StringgetDetails()ProgramLocationgetLocation()Returns the ProgramLocation stored in this event.ProgramgetProgram()Returns the Program object that the location refers to.-
Methods inherited from class ghidra.framework.plugintool.PluginEvent
getEventName, getSourceName, getToolEventName, getTriggerEvent, isToolEvent, lookupToolEventName, setSourceName, setTriggerEvent, toString
-
-
-
-
Field Detail
-
NAME
public static final java.lang.String NAME
The name of this plugin event.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ProgramLocationPluginEvent
public ProgramLocationPluginEvent(java.lang.String src, ProgramLocation loc, Program program)Construct a new ProgramLocationEvent.- Parameters:
src- the name of the plugin that generated this event.loc- the ProgramLocation object that contains the new location.program- the Program for which the loc object refers.
-
-
Method Detail
-
getLocation
public ProgramLocation getLocation()
Returns the ProgramLocation stored in this event.
-
getProgram
public Program getProgram()
Returns the Program object that the location refers to.
-
getDetails
protected java.lang.String getDetails()
- Overrides:
getDetailsin classPluginEvent
-
-