FunnelConsoleAction Class Reference

An action that opens and manages a funnel console dialog. More...

#include <funnel_statistics.h>

Inheritance diagram for FunnelConsoleAction:

Public Member Functions
	FunnelConsoleAction (QString name, funnel_console_eval_cb_t eval_cb, funnel_console_open_cb_t open_cb, funnel_console_close_cb_t close_cb, void *callback_data, QObject *parent)
	Constructs a new FunnelConsoleAction.
	~FunnelConsoleAction ()
	Destroys the FunnelConsoleAction.
virtual void	triggerCallback () override
	Triggers the console action, initializing and displaying the dialog.
Public Member Functions inherited from FunnelAction
	FunnelAction (QObject *parent=nullptr)
	Constructs an empty FunnelAction.
	FunnelAction (QString title, funnel_menu_callback callback, void *callback_data, bool retap, QObject *parent)
	Constructs a FunnelAction for a general menu callback.
	FunnelAction (QString title, funnel_packet_menu_callback callback, void *callback_data, bool retap, const char *packet_required_fields, QObject *parent)
	Constructs a FunnelAction for a packet-specific menu callback.
	~FunnelAction ()
	Destroys the FunnelAction.
funnel_menu_callback	callback () const
	Retrieves the standard menu callback.
QString	title () const
	Retrieves the title of the action.
void	setPacketCallback (funnel_packet_menu_callback packet_callback)
	Sets the packet-specific menu callback.
void	setPacketData (GPtrArray *finfos)
	Sets the packet data required by the packet callback.
void	addToMenu (QMenu *ctx_menu, QHash< QString, QMenu * > &menuTextToMenus)
	Adds this action to a specific context menu hierarchy.
void	setPacketRequiredFields (const char *required_fields_str)
	Sets the fields required for the packet callback to be active.
const QSet< QString >	getPacketRequiredFields ()
	Retrieves the set of required packet fields.
bool	retap ()
	Checks if executing this action requires a retap.
QString	getPacketSubmenus ()
	Retrieves the path/hierarchy for packet submenus.

Additional Inherited Members
Public Slots inherited from FunnelAction
void	triggerPacketCallback ()
	Slot triggered to execute the packet-specific callback.

Detailed Description

An action that opens and manages a funnel console dialog.

Constructor & Destructor Documentation

FunnelConsoleAction()

FunnelConsoleAction::FunnelConsoleAction	(	QString	name,
		funnel_console_eval_cb_t	eval_cb,
		funnel_console_open_cb_t	open_cb,
		funnel_console_close_cb_t	close_cb,
		void *	callback_data,
		QObject *	parent = nullptr )

Constructs a new FunnelConsoleAction.

Parameters

name	The title or name of the console action.
eval_cb	The callback used to evaluate console input.
open_cb	The callback used when the console is opened.
close_cb	The callback used when the console is closed.
callback_data	User data to pass to the callbacks.
parent	The parent QObject.

Member Function Documentation

triggerCallback()

void FunnelConsoleAction::triggerCallback ( )

overridevirtual

Triggers the console action, initializing and displaying the dialog.

Reimplemented from FunnelAction.

---

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

• /builds/wireshark/wireshark/ui/qt/funnel_statistics.h
• /builds/wireshark/wireshark/ui/qt/funnel_statistics.cpp