Stratoshark-specific plot dialog that provides system-call-aware defaults for plot fields, axis labels, and hint text. More...

#include <stratoshark_plot_dialog.h>

Inheritance diagram for StratosharkPlotDialog:

Public Member Functions
	StratosharkPlotDialog (QWidget &parent, CaptureFile &cf)
	Constructs the StratosharkPlotDialog.

virtual	~StratosharkPlotDialog ()
	Destroys the StratosharkPlotDialog.

void	initialize (QWidget &parent, bool show_default=true)
	Initializes the dialog, optionally populating it with a default plot using Stratoshark-specific event fields.

Public Member Functions inherited from PlotDialog
	PlotDialog (QWidget &parent, CaptureFile &cf)
	Construct a PlotDialog.

virtual	~PlotDialog ()
	Destroy the dialog and its associated resources.

void	initialize (QWidget &parent, uat_field_t *plot_fields, bool show_default=true)
	Finish initialising the dialog after construction.

void	addPlot (bool checked, const QString &dfilter, const QString &yfield)
	Add a plot with default name, style, colour, and Y-axis factor.

Public Member Functions inherited from WiresharkDialog
	WiresharkDialog (QWidget &parent, CaptureFile &capture_file)
	Constructs a new WiresharkDialog object.

bool	fileClosed () const
	Checks if the capture file has been closed.

Public Member Functions inherited from GeometryStateDialog
	GeometryStateDialog (QWidget *parent, Qt::WindowFlags f=Qt::Window)
	Constructs a new GeometryStateDialog with the specified parent and window flags.

	~GeometryStateDialog ()
	Save the geometry and splitter state and then destroy the GeometryStateDialog.

void	setWindowModality (Qt::WindowModality windowModality)
	Sets the window modality for the dialog. On non-macOS platforms, this also sets the parent to ensure modal dialogs are always on top of their parent.

Protected Member Functions
virtual QString	getFilteredName () const override
	Returns the display filter field name used to identify filtered items.

virtual QString	getYAxisName () const override
	Returns the label string for the Y axis.

virtual QString	getHintText (unsigned num_items) const override
	Returns a contextual hint string describing the number of plotted items.

virtual void	addDefaultPlot (bool enabled, bool filtered) override
	Adds the default plot entry for Stratoshark with the given visibility and filter state.

Protected Member Functions inherited from PlotDialog
void	captureFileClosing () override
	Handle capture file closing.

void	keyPressEvent (QKeyEvent *event) override
	Handle key press events.

void	reject () override
	Handle dialog rejection (Close button / Escape).

void	addPlot (bool checked, const QString &name, const QString &dfilter, QColor color_idx, Graph::PlotStyles style, const QString &yfield, double y_axis_factor=Graph::default_y_axis_factor_)
	Add a fully-specified plot to the dialog.

Protected Member Functions inherited from WiresharkDialog
virtual void	accept ()
	Accepts the dialog.

virtual void	beginRetapPackets ()
	Mark the start of a code block that retaps packets. If the user closes the dialog while tapping, the dialog will not be destroyed until endRetapPackets is called.

virtual void	endRetapPackets ()
	Mark the end of a code block that retaps packets. If the user has closed the dialog it will be destroyed at this point.

void	setWindowSubtitle (const QString &subtitle)
	Set the window subtitle, e.g. "Foo Timeouts". The subtitle and file name will be added to the dialog window title.

const QString &	windowSubtitle ()
	Retrieves the current window subtitle.

virtual void	updateWidgets ()
	Updates the state and contents of the dialog's widgets.

bool	registerTapListener (const char tap_name, void tap_data, const char *filter, unsigned flags, tap_reset_cb tap_reset, tap_packet_cb tap_packet, tap_draw_cb tap_draw)
	Convenience wrapper for register_tap_listener. Tap listeners registered via this function are automatically removed during destruction. They can also be explicitly removed using remove_tap_listener or removeTapListeners.

virtual void	removeTapListeners ()
	Remove all tap listeners registered via registerTapListener.

bool	dialogClosed () const
	Check to see if the user has closed (and not minimized) the dialog.

int	retapDepth () const
	Check to see if we're currently retapping. If this is positive, tapping will fail in process_specified_records.

virtual void	captureFileClosed ()
	Called when the capture file was closed. This can be used to enable or disable widgets according to the state of file_closed_. updateWidgets() is called at the end.

Protected Member Functions inherited from GeometryStateDialog
void	loadGeometry (int width=0, int height=0, const QString &dialog_name=QString())
	Loads the geometry and splitter state for the dialog.

void	loadSplitterState (QSplitter *splitter=nullptr)
	Loads the state of a splitter for the dialog.

Additional Inherited Members
Public Slots inherited from PlotDialog
void	scheduleReplot ()
	Request a lightweight QCustomPlot replot of existing data.

void	scheduleRecalc ()
	Request a medium-weight value recalculation then replot.

void	scheduleRetap ()
	Request a full retap of the capture file.

Signals inherited from PlotDialog
void	goToPacket (int packet, int hf_id)
	Emitted when the packet list should navigate to a specific packet.

void	updateMarker (const int size, const double xCoord, const int)
	Emitted to update the size and position of a measurement marker.

void	setPosMarker (const double xCoord, const int selectMPos, const int posMPos)
	Emitted to set the position of a position or difference marker.

Protected Slots inherited from PlotDialog
void	modelDataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles)
	Respond to data changes in the UAT model.

void	modelRowsReset ()
	Respond to a full UAT model reset.

void	modelRowsInserted (const QModelIndex &parent, int first, int last)
	Respond to new rows being inserted into the UAT model.

void	modelRowsRemoved (const QModelIndex &parent, int first, int last)
	Respond to rows being removed from the UAT model.

void	modelRowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
	Respond to rows being reordered within the UAT model.

Protected Slots inherited from WiresharkDialog
void	captureEvent (CaptureEvent e)
	Handles capture events.

Protected Attributes inherited from WiresharkDialog
CaptureFile &	cap_file_
	Reference to the underlying capture file.

bool	file_closed_
	Flag indicating if the capture file has been closed.

Detailed Description

Stratoshark-specific plot dialog that provides system-call-aware defaults for plot fields, axis labels, and hint text.

Constructor & Destructor Documentation

◆ StratosharkPlotDialog()

StratosharkPlotDialog::StratosharkPlotDialog	(	QWidget &	parent,
		CaptureFile &	cf
	)

explicit

Constructs the StratosharkPlotDialog.

Parameters

parent	The parent widget.
cf	The capture file whose data is to be plotted.

Member Function Documentation

◆ addDefaultPlot()

void StratosharkPlotDialog::addDefaultPlot	(	bool	enabled,
		bool	filtered
	)

overrideprotectedvirtual

Adds the default plot entry for Stratoshark with the given visibility and filter state.

Parameters

enabled	If true, the plot is enabled/visible.
filtered	If true, the plot applies the current display filter.

Reimplemented from PlotDialog.

◆ getFilteredName()

QString StratosharkPlotDialog::getFilteredName ( ) const

overrideprotectedvirtual

Returns the display filter field name used to identify filtered items.

Returns: The filtered item field name string.

Reimplemented from PlotDialog.

◆ getHintText()

QString StratosharkPlotDialog::getHintText ( unsigned num_items ) const

overrideprotectedvirtual

Returns a contextual hint string describing the number of plotted items.

Parameters

num_items The number of items currently in the plot.

Returns: A human-readable hint string.

Reimplemented from PlotDialog.

◆ getYAxisName()

QString StratosharkPlotDialog::getYAxisName ( ) const

overrideprotectedvirtual

Returns the label string for the Y axis.

Returns: The Y axis name.

Reimplemented from PlotDialog.

◆ initialize()

void StratosharkPlotDialog::initialize	(	QWidget &	parent,
		bool	show_default = `true`
	)

Initializes the dialog, optionally populating it with a default plot using Stratoshark-specific event fields.

Parameters

parent	The parent widget.
show_default	If true, adds a default plot on initialization.

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

/builds/wireshark/wireshark/ui/stratoshark/stratoshark_plot_dialog.h
/builds/wireshark/wireshark/ui/stratoshark/stratoshark_plot_dialog.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StratosharkPlotDialog()

Member Function Documentation

◆ addDefaultPlot()

◆ getFilteredName()

◆ getHintText()

◆ getYAxisName()

◆ initialize()