| Wireshark 4.7.0 The Wireshark network protocol analyzer

Loading...
Searching...
No Matches
Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
WiresharkDialog Class Reference
Inheritance diagram for WiresharkDialog:

## Public Member Functions
| WiresharkDialog (QWidget &parent, CaptureFile &capture_file)
bool | fileClosed () const
| true if the file has been closed, false otherwise.
Public Member Functions inherited from GeometryStateDialog
| GeometryStateDialog (QWidget *parent, Qt::WindowFlags f=Qt::Window)
void | setWindowModality (Qt::WindowModality windowModality)

## Protected Slots
void | captureEvent (CaptureEvent)

## Protected Member Functions
virtual void | keyPressEvent (QKeyEvent *event)
virtual void | accept ()
virtual void | reject ()
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 ()
virtual void | updateWidgets ()
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())
void | loadSplitterState (QSplitter *splitter=nullptr)

## Protected Attributes
CaptureFile & | cap_file_
bool | file_closed_

## Member Function Documentation

## ◆ beginRetapPackets()

void WiresharkDialog::beginRetapPackets | ( |  | ) |
| protected

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.

This is automatically called when tapping begins, but might need to be called explicitly if any member functions are called or variables are accessed after tapping is finished.

## ◆ captureFileClosed()

void WiresharkDialog::captureFileClosed | ( |  | ) |
| protectedvirtual

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.

Reimplemented in BluetoothAttServerAttributesDialog, BluetoothDevicesDialog, BluetoothHciSummaryDialog, FollowStreamDialog, RtpStreamDialog, and VoipCallsDialog.

## ◆ captureFileClosing()

void WiresharkDialog::captureFileClosing | ( |  | ) |
| protectedvirtual

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.

Reimplemented in BluetoothDeviceDialog, BluetoothHciSummaryDialog, ConversationDialog, EndpointDialog, IOGraphDialog, LteMacStatisticsDialog, LteRlcStatisticsDialog, MulticastStatisticsDialog, PacketDialog, RtpStreamDialog, VoipCallsDialog, WlanStatisticsDialog, and PlotDialog.

## ◆ dialogClosed()

bool WiresharkDialog::dialogClosed | ( |  | ) | const
| inlineprotected

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

Returns
  true if the dialog has been closed, false otherwise.

## ◆ endRetapPackets()

void WiresharkDialog::endRetapPackets | ( |  | ) |
| protectedvirtual

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

This is automatically called when tapping ends, but might need to be called explicitly if any member functions are called or variables are accessed after tapping is finished.

## ◆ registerTapListener()

bool WiresharkDialog::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
| ) |  |
| protected

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.

Shows a warning dialog if registration is unsuccessful.

Parameters

  tap_name | A registered tap name.
  tap_data | A unique pointer. Usually 'this'.
  filter | A display filter.
  flags | See register_tap_listener.
  tap_reset | Reset callback.
  tap_packet | Per-packet callback.
  tap_draw | Draw callback.

## ◆ removeTapListeners()

void WiresharkDialog::removeTapListeners | ( |  | ) |
| protectedvirtual

Remove all tap listeners registered via registerTapListener.

Reimplemented in VoipCallsDialog.

## ◆ retapDepth()

int WiresharkDialog::retapDepth | ( |  | ) | const
| inlineprotected

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

Returns
  The current retap depth. (In current implementation, 0 or 1.)

## ◆ setWindowSubtitle()

void WiresharkDialog::setWindowSubtitle | ( | const QString & | subtitle | ) |
| protected

Set the window subtitle, e.g. "Foo Timeouts". The subtitle and file name will be added to the dialog window title.

Parameters

  subtitle | The subtitle to add. It should be unique, short, and descriptive.

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

- /builds/wireshark/wireshark/ui/qt/wireshark_dialog.h
- /builds/wireshark/wireshark/ui/qt/wireshark_dialog.cpp