WiresharkFileDialog Class Reference

The WiresharkFileDialog class. More...

#include <wireshark_file_dialog.h>

Inheritance diagram for WiresharkFileDialog:

Public Member Functions
	WiresharkFileDialog (QWidget *parent=nullptr, const QString &caption=QString(), const QString &directory=QString(), const QString &filter=QString())
	Constructs a Wireshark file dialog.
QString	selectedNativePath () const
	Returns the selected file path in native OS format.

Static Public Member Functions
static QString	getExistingDirectory (QWidget *parent=Q_NULLPTR, const QString &caption=QString(), const QString &dir=QString(), Options options=ShowDirsOnly)
	Presents a directory chooser dialog and returns the selected path.
static QString	getOpenFileName (QWidget *parent=Q_NULLPTR, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=Q_NULLPTR, Options options=Options())
	Presents an open-file dialog and returns the selected file path.
static QString	getSaveFileName (QWidget *parent=Q_NULLPTR, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString *selectedFilter=Q_NULLPTR, Options options=Options())
	Presents a save-file dialog and returns the chosen file path.

Detailed Description

The WiresharkFileDialog class.

Qt uses '/' as a universal path separator and converts to native path separators, i.e., '\' on Windows, only immediately before displaying a path to a user. This class can return the path with native path separators.

Qt <= 5.9 supports setting old (Windows 8.1) per-monitor DPI awareness via Qt:AA_EnableHighDpiScaling. We do this in main.cpp. In order for native dialogs to be rendered correctly we need to set per-monitor v2 awareness prior to creating the dialog. Qt doesn't render correctly when per-monitor v2 awareness is enabled, so we need to revert our thread context when we're done. The class functions below are simple wrappers around their QFileDialog equivalents that set PMv2 awareness before showing native dialogs on Windows and resets it afterward. They also return the result with native directory separators on Windows.

Constructor & Destructor Documentation

WiresharkFileDialog()

WiresharkFileDialog::WiresharkFileDialog	(	QWidget *	parent = nullptr,
		const QString &	caption = QString(),
		const QString &	directory = QString(),
		const QString &	filter = QString()
	)

Constructs a Wireshark file dialog.

Parameters

parent	The parent widget.
caption	The dialog window title.
directory	The initial directory shown in the dialog.
filter	The file type filter string (e.g. "Captures (*.pcap *.pcapng)").

Member Function Documentation

getExistingDirectory()

QString WiresharkFileDialog::getExistingDirectory ( QWidget *  parent = Q_NULLPTR, const QString &  caption = QString(), const QString &  dir = QString(), Options  options = ShowDirsOnly  )

static

Presents a directory chooser dialog and returns the selected path.

Parameters

parent	The parent widget.
caption	The dialog window title.
dir	The initial directory to display.
options	Dialog behavior options (default: ShowDirsOnly).

Returns

The chosen directory path in native format, or an empty string if cancelled.

getOpenFileName()

QString WiresharkFileDialog::getOpenFileName ( QWidget *  parent = Q_NULLPTR, const QString &  caption = QString(), const QString &  dir = QString(), const QString &  filter = QString(), QString *  selectedFilter = Q_NULLPTR, Options  options = Options()  )

static

Presents an open-file dialog and returns the selected file path.

Parameters

parent	The parent widget.
caption	The dialog window title.
dir	The initial directory to display.
filter	The file type filter string.
selectedFilter	If non-null, receives the filter the user selected.
options	Dialog behavior options.

Returns

The chosen file path in native format, or an empty string if cancelled.

getSaveFileName()

QString WiresharkFileDialog::getSaveFileName ( QWidget *  parent = Q_NULLPTR, const QString &  caption = QString(), const QString &  dir = QString(), const QString &  filter = QString(), QString *  selectedFilter = Q_NULLPTR, Options  options = Options()  )

static

Presents a save-file dialog and returns the chosen file path.

Parameters

parent	The parent widget.
caption	The dialog window title.
dir	The initial directory to display.
filter	The file type filter string.
selectedFilter	If non-null, receives the filter the user selected.
options	Dialog behavior options.

Returns

The chosen file path in native format, or an empty string if cancelled.

selectedNativePath()

QString WiresharkFileDialog::selectedNativePath

(

)

const

Returns the selected file path in native OS format.

Returns

The selected path with native directory separators.

---

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

• /builds/wireshark/wireshark/ui/qt/widgets/wireshark_file_dialog.h
• /builds/wireshark/wireshark/ui/qt/widgets/wireshark_file_dialog.cpp