Package ghidra.trace.model.bookmark

Interface TraceBookmarkManager

All Superinterfaces:

TraceBookmarkOperations

All Known Implementing Classes:

DBTraceBookmarkManager

public interface TraceBookmarkManager
extends TraceBookmarkOperations

Method Summary

Modifier and Type	Method	Description
TraceBookmarkType	defineBookmarkType(String name, Icon icon, Color color, int priority)	Define (or redefine) a bookmark type.
TraceBookmark	getBookmark(long id)
TraceBookmarkSpace	getBookmarkRegisterSpace(TraceStackFrame frame, boolean createIfAbsent)
TraceBookmarkSpace	getBookmarkRegisterSpace(TraceThread thread, boolean createIfAbsent)
Collection<? extends TraceBookmark>	getBookmarksAdded(long from, long to)
TraceBookmarkSpace	getBookmarkSpace(AddressSpace space, boolean createIfAbsent)
Collection<? extends TraceBookmark>	getBookmarksRemoved(long from, long to)
TraceBookmarkType	getBookmarkType(String name)
Collection<? extends TraceBookmarkType>	getDefinedBookmarkTypes()	Get the defined bookmark types.

Methods inherited from interface ghidra.trace.model.bookmark.TraceBookmarkOperations

addBookmark, getAllBookmarks, getBookmarksAt, getBookmarksEnclosed, getBookmarksIntersecting, getCategoriesForType

Method Details

getBookmarkSpace

TraceBookmarkSpace getBookmarkSpace(AddressSpace space,
 boolean createIfAbsent)

getBookmarkRegisterSpace

TraceBookmarkSpace getBookmarkRegisterSpace(TraceThread thread,
 boolean createIfAbsent)

getBookmarkRegisterSpace

TraceBookmarkSpace getBookmarkRegisterSpace(TraceStackFrame frame,
 boolean createIfAbsent)

defineBookmarkType

TraceBookmarkType defineBookmarkType(String name,
 Icon icon,
 Color color,
 int priority)

Define (or redefine) a bookmark type. Bookmark type metadata are not stored in the database. To customize these things, a plugin must call this method for every opened program

Parameters:

name - a name to uniquely identify the type

icon - an icon for displaying the mark (usually in the listing margin)

color - a color for displaying the mark (usually in the listing background)

priority - a priority to determine which mark is displayed when multiple are present at the same location

Returns:

the newly-defined type

getDefinedBookmarkTypes

Collection<? extends TraceBookmarkType> getDefinedBookmarkTypes()

Get the defined bookmark types.

Returns:

the types

getBookmarkType

TraceBookmarkType getBookmarkType(String name)

getBookmark

TraceBookmark getBookmark(long id)

getBookmarksAdded

Collection<? extends TraceBookmark> getBookmarksAdded(long from,
 long to)

getBookmarksRemoved

Collection<? extends TraceBookmark> getBookmarksRemoved(long from,
 long to)