A dialog for displaying and modifying properties and statistics of a capture file. More...

#include <capture_file_properties_dialog.h>

Inheritance diagram for CaptureFilePropertiesDialog:

Signals
void	captureCommentChanged ()
	Signal emitted when a capture comment has been changed.

Public Member Functions
	CaptureFilePropertiesDialog (QWidget &parent, CaptureFile &capture_file)
	Constructs a new CaptureFilePropertiesDialog.

virtual	~CaptureFilePropertiesDialog ()
	Destroys the CaptureFilePropertiesDialog.

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 Slots
void	changeEvent (QEvent *event)
	Handles state change events for the dialog.

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

Protected Member Functions
virtual QString	getStartTextString () const
	Retrieves the start text string for the dialog.

virtual QString	getFirstItemString () const
	Retrieves the string representing the first item.

virtual QString	getLastItemString () const
	Retrieves the string representing the last item.

virtual QString	getEndTextString () const
	Retrieves the end text string for the dialog.

virtual QString	getDroppedItemString () const
	Retrieves the string indicating dropped items.

virtual QString	getItemSizeLimitString () const
	Retrieves the string displaying the item size limit.

virtual QString	getRowTitleString () const
	Retrieves the title string for the row.

virtual QString	getAvgItemSizeString () const
	Retrieves the string displaying the average item size.

virtual QString	getItemCommentString () const
	Retrieves the string associated with the item comment.

virtual QString	getCreatedByString () const
	Retrieves the string showing who created the file or capture.

Protected Member Functions inherited from WiresharkDialog
virtual void	keyPressEvent (QKeyEvent *event)
	Handles key press events.

virtual void	accept ()
	Accepts the dialog.

virtual void	reject ()
	Rejects 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	captureFileClosing ()
	Called when the capture file is about to close. This can be used to disconnect taps and similar actions. updateWidgets() is called at the end. To enable/disable widgets captureFileClosed() is more suitable.

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
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

A dialog for displaying and modifying properties and statistics of a capture file.

Constructor & Destructor Documentation

◆ CaptureFilePropertiesDialog()

CaptureFilePropertiesDialog::CaptureFilePropertiesDialog	(	QWidget &	parent,
		CaptureFile &	capture_file
	)

explicit

Constructs a new CaptureFilePropertiesDialog.

Parameters

parent	The parent widget.
capture_file	The capture file whose properties are to be displayed.

Member Function Documentation

◆ changeEvent

void CaptureFilePropertiesDialog::changeEvent ( QEvent * event )

protectedslot

Handles state change events for the dialog.

Parameters

event The event to handle.

◆ getAvgItemSizeString()

QString CaptureFilePropertiesDialog::getAvgItemSizeString ( ) const

protectedvirtual

Retrieves the string displaying the average item size.

Returns: The average item size string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getCreatedByString()

QString CaptureFilePropertiesDialog::getCreatedByString ( ) const

protectedvirtual

Retrieves the string showing who created the file or capture.

Returns: The creator string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getDroppedItemString()

QString CaptureFilePropertiesDialog::getDroppedItemString ( ) const

protectedvirtual

Retrieves the string indicating dropped items.

Returns: The dropped item string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getEndTextString()

QString CaptureFilePropertiesDialog::getEndTextString ( ) const

protectedvirtual

Retrieves the end text string for the dialog.

Returns: The end text string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getFirstItemString()

QString CaptureFilePropertiesDialog::getFirstItemString ( ) const

protectedvirtual

Retrieves the string representing the first item.

Returns: The first item string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getItemCommentString()

QString CaptureFilePropertiesDialog::getItemCommentString ( ) const

protectedvirtual

Retrieves the string associated with the item comment.

Returns: The item comment string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getItemSizeLimitString()

QString CaptureFilePropertiesDialog::getItemSizeLimitString ( ) const

protectedvirtual

Retrieves the string displaying the item size limit.

Returns: The item size limit string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getLastItemString()

QString CaptureFilePropertiesDialog::getLastItemString ( ) const

protectedvirtual

Retrieves the string representing the last item.

Returns: The last item string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getRowTitleString()

QString CaptureFilePropertiesDialog::getRowTitleString ( ) const

protectedvirtual

Retrieves the title string for the row.

Returns: The row title string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

◆ getStartTextString()

QString CaptureFilePropertiesDialog::getStartTextString ( ) const

protectedvirtual

Retrieves the start text string for the dialog.

Returns: The start text string.

Reimplemented in StratosharkCaptureFilePropertiesDialog.

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

/builds/wireshark/wireshark/ui/qt/capture_file_properties_dialog.h
/builds/wireshark/wireshark/ui/qt/capture_file_properties_dialog.cpp

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaptureFilePropertiesDialog()

Member Function Documentation

◆ changeEvent

◆ getAvgItemSizeString()

◆ getCreatedByString()

◆ getDroppedItemString()

◆ getEndTextString()

◆ getFirstItemString()

◆ getItemCommentString()

◆ getItemSizeLimitString()

◆ getLastItemString()

◆ getRowTitleString()

◆ getStartTextString()