dynamorio::drgui::drgui_tool_interface_t Class Reference

#include <drgui_tool_interface.h>

Inherits QWidget.

Signals
void	new_instance_requested (QWidget *tool, QString tool_name)

Public Member Functions
virtual QStringList	tool_names () const =0
virtual QWidget *	create_instance (const QStringList &args=QStringList())=0
virtual drgui_options_interface_t *	create_options_page (void)=0
virtual void	open_file (const QString &path, int line_num)=0

Detailed Description

Interface for drgui to interact with its loaded tools. drgui discovers tools through the QPluginLoader system, which attempts to load each of the tools it has been pointed at by the 'Load Tools' action.

Member Function Documentation

create_instance()

virtual QWidget* dynamorio::drgui::drgui_tool_interface_t::create_instance ( const QStringList &  args = QStringList() )

pure virtual

Returns a new instance of a tool to be displayed by drgui's tab interface. This is called by drgui when a user requests a new tab by clicking on the tool's action in the 'Tools' menu. Arguments can be optionally supplied to the tool.

create_options_page()

virtual drgui_options_interface_t* dynamorio::drgui::drgui_tool_interface_t::create_options_page ( void  )

pure virtual

Returns an instance of the tools options page to be displayed by drgui's preferences dialog. This is called by drgui's preferences dialog the first time it disovers the tool on each run of drgui.

new_instance_requested

void dynamorio::drgui::drgui_tool_interface_t::new_instance_requested ( QWidget *  tool, QString  tool_name  )

signal

Allows a tool to tell drgui to open the given widget in a new tab with the given name as a label. Signals do not have implementations, therefore it does not make sense to declare a signal as virtual.

open_file()

virtual void dynamorio::drgui::drgui_tool_interface_t::open_file ( const QString &  path, int  line_num  )

pure virtual

Used by drgui to tell a tool to open a file at a line number XXX i#1251: Currently only used as a bridge from tools to the code editor plugin.

tool_names()

virtual QStringList dynamorio::drgui::drgui_tool_interface_t::tool_names ( ) const

pure virtual

Returns a list of the names of the tools that are to be provided. The names are used for titles in the 'Tools' menu and in the tab widget. They are also used to keep track of which plugins are already loaded, and must be unique.

---

The documentation for this class was generated from the following file:

• /home/runner/work/dynamorio/dynamorio/ext/drgui/drgui_tool_interface.h