Detailed Description

Classes
class	MiniGraph

class	MiniGraphSidebarWidgetType

Class Documentation

◆ MiniGraph

class MiniGraph

Public Slots
void	notifyUpdate ()

void	graphDestroyed ()

void	newPane ()

Public Member Functions
	MiniGraph (bool popout=false)

	~MiniGraph ()

virtual void	notifyViewChanged (ViewFrame *frame) override

virtual void	OnViewChange (UIContext context, ViewFrame frame, const QString &type) override
	Callback when the ui changes views.

virtual QSize	sizeHint () const override

void	setSource (ViewFrame frame, FlowGraphWidget graphView)

Public Member Functions inherited from SidebarWidget
	SidebarWidget (const QString &title)

	~SidebarWidget ()

const QString &	title () const

void	enableRefreshTimer (int interval)

void	setRefreshQuiesce (bool enable)

bool	isQuiesced () const

virtual void	notifyRefresh ()

virtual void	notifyQuiesce (bool)

virtual void	notifyFontChanged ()

virtual void	notifyOffsetChanged (uint64_t)

virtual void	notifyThemeChanged ()

virtual void	notifyViewLocationChanged (View *, const ViewLocation &)

virtual void	focus ()

virtual void	closing ()

virtual void	setPrimaryOrientation (Qt::Orientation)

virtual QWidget *	headerWidget ()

Public Member Functions inherited from UIContextNotification
virtual	~UIContextNotification ()

virtual void	OnContextOpen (UIContext *context)
	Callback after a UIContext is opened (eg MainWindow)

virtual void	OnContextClose (UIContext *context)
	Callback right before closing a UIContext.

virtual bool	OnBeforeOpenDatabase (UIContext *context, FileMetadataRef metadata)
	Callback before a database (specifically a database, not a raw file) is opened.

virtual bool	OnAfterOpenDatabase (UIContext *context, FileMetadataRef metadata, BinaryViewRef data)
	Callback after a database (specifically a database, not a raw file) is opened.

virtual void	OnAfterOpenProject (UIContext *context, ProjectRef project)
	Callback after a project is opened.

virtual bool	OnBeforeOpenProjectFile (UIContext *context, ProjectFileRef projectFile)
	Callback before a project file is opened.

virtual void	OnAfterOpenProjectFile (UIContext context, ProjectFileRef projectFile, ViewFrame frame)
	Callback after a project file is opened.

virtual bool	OnBeforeOpenFile (UIContext context, FileContext file)
	Callback before a file (raw or database) is opened (after OnAfterOpenDatabase if opening a database)

virtual void	OnAfterOpenFile (UIContext context, FileContext file, ViewFrame *frame)
	Callback after a file (raw or database) is opened.

virtual bool	OnBeforeSaveFile (UIContext context, FileContext file, ViewFrame *frame)
	Callback before a file is saved (either as a database or raw)

virtual void	OnAfterSaveFile (UIContext context, FileContext file, ViewFrame *frame)
	Callback after a file is saved (either as a database or raw)

virtual bool	OnBeforeCloseFile (UIContext context, FileContext file, ViewFrame *frame)
	Callback before a file is closed.

virtual void	OnAfterCloseFile (UIContext context, FileContext file, ViewFrame *frame)
	Callback after a file is closed.

virtual void	OnViewReplaced (UIContext context, FileContext file, ViewFrame oldFrame, ViewFrame newFrame)
	Callback after a ViewFrame is replaced in an open file (e.g.

virtual void	OnDataViewReplaced (UIContext context, FileContext file, BinaryViewRef oldData, BinaryViewRef newData)
	Callback after a BinaryView is replaced in an open file (e.g.

virtual void	OnAddressChange (UIContext context, ViewFrame frame, View *view, const ViewLocation &location)
	Callback when the ui changes address.

virtual bool	GetNameForFile (UIContext context, FileContext file, QString &name)
	Callback to modify the displayed file name for a FileContext (eg in the window title or tab title) Note: Due to the out param &name, this is not usable from Python with PySide.

virtual bool	GetNameForPath (UIContext *context, const QString &path, QString &name)
	Callback to modify the displayed file name for a file path (eg in the new tab widget) Note: Due to the out param &name, this is not usable from Python with PySide.

virtual void	OnNewSelectionForXref (UIContext context, ViewFrame frame, View *view, const SelectionInfoForXref &selection)
	Callback when the ui changes selection and should update cross references.

virtual void	OnActionExecuted (UIContext context, UIActionHandler handler, const QString &name, const UIActionContext &ctx, std::function< void(const UIActionContext &)> &action)
	Callback when an action is executed, allowing plugins to intercept and modify the behavior of the action.

virtual void	OnContextMenuCreated (UIContext context, View view, Menu &menu)
	Callback when a context menu is created, allowing plugins to modify the menu, e.g., registering and adding new actions into it.

Protected Member Functions
virtual void	contextMenuEvent (QContextMenuEvent *event) override

virtual void	mouseMoveEvent (QMouseEvent *event) override

virtual void	mousePressEvent (QMouseEvent *event) override

virtual void	paintEvent (QPaintEvent *event) override

virtual void	scrollTo (int x, int y)

Additional Inherited Members
Protected Attributes inherited from SidebarWidget
QString	m_title

UIActionHandler	m_actionHandler

ContextMenuManager *	m_contextMenuManager = nullptr

Menu *	m_menu = nullptr

bool	m_quiesceState = true

QTimer *	m_updateTimer = nullptr

Constructor & Destructor Documentation

◆ MiniGraph()

MiniGraph::MiniGraph ( bool popout = false )

◆ ~MiniGraph()

MiniGraph::~MiniGraph ( )

Member Function Documentation

◆ notifyViewChanged()

virtual void MiniGraph::notifyViewChanged ( ViewFrame * frame )

overridevirtual

Reimplemented from SidebarWidget.

◆ OnViewChange()

virtual void MiniGraph::OnViewChange	(	UIContext *	context,
		ViewFrame *	frame,
		const QString &	type )

overridevirtual

Callback when the ui changes views.

Parameters

context	Context changing views
frame	ViewFrame which changed views
type	New view name

Reimplemented from UIContextNotification.

◆ sizeHint()

virtual QSize MiniGraph::sizeHint ( ) const

inlineoverridevirtual

◆ setSource()

void MiniGraph::setSource	(	ViewFrame *	frame,
		FlowGraphWidget *	graphView )

◆ contextMenuEvent()

virtual void MiniGraph::contextMenuEvent ( QContextMenuEvent * event )

overrideprotectedvirtual

◆ mouseMoveEvent()

virtual void MiniGraph::mouseMoveEvent ( QMouseEvent * event )

overrideprotectedvirtual

◆ mousePressEvent()

virtual void MiniGraph::mousePressEvent ( QMouseEvent * event )

overrideprotectedvirtual

◆ paintEvent()

virtual void MiniGraph::paintEvent ( QPaintEvent * event )

overrideprotectedvirtual

◆ scrollTo()

virtual void MiniGraph::scrollTo	(	int	x,
		int	y )

protectedvirtual

◆ notifyUpdate

void MiniGraph::notifyUpdate ( )

slot

◆ graphDestroyed

void MiniGraph::graphDestroyed ( )

slot

◆ newPane

void MiniGraph::newPane ( )

slot

◆ MiniGraphSidebarWidgetType

class MiniGraphSidebarWidgetType

Public Member Functions
	MiniGraphSidebarWidgetType ()

virtual SidebarWidget *	createWidget (ViewFrame *frame, BinaryViewRef data) override

virtual SidebarWidgetLocation	defaultLocation () const override

virtual bool	canUseAsPane (SplitPaneWidget *, BinaryViewRef) const override

virtual Pane *	createPane (SplitPaneWidget *pane, BinaryViewRef data) override

Public Member Functions inherited from SidebarWidgetType
	SidebarWidgetType (const QImage &icon, const QString &name)

virtual	~SidebarWidgetType ()

const SidebarIcon &	icon () const

const QString &	name () const

virtual bool	isInReferenceArea () const

virtual bool	viewSensitive () const

virtual SidebarContextSensitivity	contextSensitivity () const

virtual bool	alwaysShowTabs () const

virtual bool	hideIfNoContent () const

virtual SidebarWidget *	createInvalidContextWidget ()

virtual QWidget *	headerWidget (SplitPaneWidget , ViewFrame , BinaryViewRef)

virtual bool	focusHeaderWidget () const

virtual QString	noWidgetMessage () const

virtual DockableTabStyle *	tabStyle () const

void	updateTheme ()

Constructor & Destructor Documentation

◆ MiniGraphSidebarWidgetType()

MiniGraphSidebarWidgetType::MiniGraphSidebarWidgetType ( )

Member Function Documentation

◆ createWidget()

virtual SidebarWidget * MiniGraphSidebarWidgetType::createWidget	(	ViewFrame *	frame,
		BinaryViewRef	data )

overridevirtual

Reimplemented from SidebarWidgetType.

◆ defaultLocation()

virtual SidebarWidgetLocation MiniGraphSidebarWidgetType::defaultLocation ( ) const

inlineoverridevirtual

Reimplemented from SidebarWidgetType.

◆ canUseAsPane()

virtual bool MiniGraphSidebarWidgetType::canUseAsPane	(	SplitPaneWidget *	,
		BinaryViewRef	) const

inlineoverridevirtual

Reimplemented from SidebarWidgetType.

◆ createPane()

virtual Pane * MiniGraphSidebarWidgetType::createPane	(	SplitPaneWidget *	pane,
		BinaryViewRef	data )

overridevirtual

Reimplemented from SidebarWidgetType.

Detailed Description

Classes

Class Documentation

◆ MiniGraph

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ MiniGraph()

◆ ~MiniGraph()

Member Function Documentation

◆ notifyViewChanged()

◆ OnViewChange()

◆ sizeHint()

◆ setSource()

◆ contextMenuEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ paintEvent()

◆ scrollTo()

◆ notifyUpdate

◆ graphDestroyed

◆ newPane

◆ MiniGraphSidebarWidgetType

Public Member Functions

Constructor & Destructor Documentation

◆ MiniGraphSidebarWidgetType()

Member Function Documentation

◆ createWidget()

◆ defaultLocation()

◆ canUseAsPane()

◆ createPane()