ExtArgMultiSelect Class Reference

Represents an extcap argument that allows selecting multiple values via a tree view. More...

#include <extcap_argument_multiselect.h>

Inheritance diagram for ExtArgMultiSelect:

Public Slots
virtual void	setDefaultValue () override
	Sets the selector to its default values.
Public Slots inherited from ExtcapArgument
virtual void	setDefaultValue ()
	Slot to set the argument to its default value.
void	onBoolChanged (bool val)
	Slot to handle boolean value changes.
void	onIntChanged (int val)
	Slot to handle integer value changes.
void	onStringChanged (QString val)
	Slot to handle string value changes.

Public Member Functions
	ExtArgMultiSelect (extcap_arg *argument, QObject *parent=Q_NULLPTR)
	Constructs an ExtArgMultiSelect.
virtual	~ExtArgMultiSelect ()
	Destroys the ExtArgMultiSelect.
virtual QString	value () override
	Retrieves the currently selected values.
virtual bool	isValid () override
	Checks if the current selection is valid.
virtual QString	defaultValue () override
	Retrieves the default values for the selector.
virtual bool	isSetDefaultValueSupported () override
	Checks if setting default values is supported.
Public Member Functions inherited from ExtcapArgument
	ExtcapArgument (QObject *parent=Q_NULLPTR)
	Constructs an empty ExtcapArgument.
	ExtcapArgument (extcap_arg *argument, QObject *parent=Q_NULLPTR)
	Constructs an ExtcapArgument from a core extcap_arg structure.
	ExtcapArgument (const ExtcapArgument &obj)
	Copy constructor for ExtcapArgument.
virtual	~ExtcapArgument ()
	Destroys the ExtcapArgument.
virtual QWidget *	createLabel (QWidget *parent=0)
	Creates a label widget for this argument.
virtual extcap_arg *	argument ()
	Retrieves the underlying extcap_arg structure.
virtual QString	call ()
	Retrieves the call string for this argument.
bool	isDefault ()
	Checks if the argument currently holds its default value.
bool	isRequired ()
	Checks if the argument is required.
bool	isSufficient ()
	Checks if the argument provides sufficient information on its own.
bool	reload ()
	Reloads the argument data.
QString	prefKey (const QString &device_name, const QString &option_name, const QString &option_value)
	Generates a preference key for this argument.
virtual QString	prefValue ()
	Retrieves the preference value for this argument.
void	resetValue ()
	Resets the argument to its initial value.
virtual QString	group () const
	Retrieves the group name this argument belongs to.
virtual int	argNr () const
	Retrieves the argument number.

Protected Member Functions
virtual QList< QStandardItem * >	valueWalker (ExtcapValueList list, QStringList &defaults)
	Traverses the value list to create standard items.
void	checkItemsWalker (QStandardItem *item, QStringList defaults)
	Traverses and checks items recursively based on default values.
virtual QWidget *	createEditor (QWidget *parent) override
	Creates the editor widget for the multi-select argument.
virtual QStringList	checkedValues ()
	Retrieves a list of all currently checked values.
Protected Member Functions inherited from ExtcapArgument
bool	fileExists ()
	Checks if a file path specified by the argument exists.
ExtcapValueList	loadValues (QString parent)
	Loads the available values for this argument.
bool	reloadValues ()
	Reloads the values list.

Protected Attributes
QStandardItemModel *	viewModel
QMap< QString, QString >	displayNames
Protected Attributes inherited from ExtcapArgument
ExtcapValueList	values
extcap_arg *	_argument
QLabel *	_label
int	_number

Additional Inherited Members
Signals inherited from ExtcapArgument
void	valueChanged ()
	Signal emitted when the argument's value changes.
Static Public Member Functions inherited from ExtcapArgument
static ExtcapArgument *	create (extcap_arg *argument=Q_NULLPTR, QObject *parent=Q_NULLPTR)
	Factory method to create an appropriate ExtcapArgument subclass.

Detailed Description

Represents an extcap argument that allows selecting multiple values via a tree view.

Constructor & Destructor Documentation

ExtArgMultiSelect()

ExtArgMultiSelect::ExtArgMultiSelect	(	extcap_arg *	argument,
		QObject *	parent = Q_NULLPTR )

Constructs an ExtArgMultiSelect.

Parameters

argument	Pointer to the core extcap_arg.
parent	The parent QObject, defaults to Q_NULLPTR.

Member Function Documentation

checkedValues()

QStringList ExtArgMultiSelect::checkedValues ( )

protectedvirtual

Retrieves a list of all currently checked values.

Returns

A string list of checked values.

checkItemsWalker()

void ExtArgMultiSelect::checkItemsWalker ( QStandardItem * item, QStringList defaults )

protected

Traverses and checks items recursively based on default values.

Parameters

item	The root item to start traversing from.
defaults	The list of default values to check against.

createEditor()

QWidget * ExtArgMultiSelect::createEditor ( QWidget * parent )

overrideprotectedvirtual

Creates the editor widget for the multi-select argument.

Parameters

parent

The parent widget.

Returns

A pointer to the created tree view widget.

Reimplemented from ExtcapArgument.

Reimplemented in ExtArgTable.

defaultValue()

QString ExtArgMultiSelect::defaultValue ( )

overridevirtual

Retrieves the default values for the selector.

Returns

A comma-separated string of default values.

Reimplemented from ExtcapArgument.

isSetDefaultValueSupported()

bool ExtArgMultiSelect::isSetDefaultValueSupported ( )

overridevirtual

Checks if setting default values is supported.

Returns

True if supported, false otherwise.

Reimplemented from ExtcapArgument.

isValid()

bool ExtArgMultiSelect::isValid ( )

overridevirtual

Checks if the current selection is valid.

Returns

True if valid, false otherwise.

Reimplemented from ExtcapArgument.

value()

QString ExtArgMultiSelect::value ( )

overridevirtual

Retrieves the currently selected values.

Returns

A comma-separated string of selected values.

Reimplemented from ExtcapArgument.

Reimplemented in ExtArgTable.

valueWalker()

QList< QStandardItem * > ExtArgMultiSelect::valueWalker ( ExtcapValueList list, QStringList & defaults )

protectedvirtual

Traverses the value list to create standard items.

Parameters

list	The list of extcap values to process.
defaults	A list of default value strings to be updated.

Returns

A list of created QStandardItem objects.

Member Data Documentation

displayNames

QMap<QString, QString> ExtArgMultiSelect::displayNames

protected

This stores the displays associated with a value.

viewModel

QStandardItemModel* ExtArgMultiSelect::viewModel

protected

The model providing data for the tree view.

---

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

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