A table model for managing the list of packet list columns. More...

#include <column_list_model.h>

Inheritance diagram for ColumnListModel:

Public Types
enum	{ COL_DISPLAYED , COL_TITLE , COL_TYPE , COL_FIELDS , COL_OCCURRENCE , COL_DISPLAY , COL_WIDTH , COL_XALIGN }
	Enumeration of column identifiers in the column list model. More...

enum	{ OriginalType = Qt::UserRole , DisplayedState }
	Enumeration of custom roles used in the column list model. More...

Public Member Functions
	ColumnListModel (QObject *parent=Q_NULLPTR)
	Constructs a new ColumnListModel.

void	saveColumns ()
	Saves the current column list to the global configuration.

void	addEntry ()
	Adds a new default entry to the end of the column list.

void	deleteEntry (int row)
	Deletes a specific entry from the column list.

void	reset ()
	Resets the column list to the default configuration.

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Retrieves header data for the table model.

virtual QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
	Retrieves data from the model.

virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const
	Retrieves the number of rows in the model.

virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const
	Retrieves the number of columns in the model.

virtual Qt::ItemFlags	flags (const QModelIndex &index) const
	Retrieves the item flags for a given index.

virtual QStringList	mimeTypes () const
	Retrieves the supported MIME types for drag and drop operations.

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
	Generates MIME data for the specified list of indexes.

virtual Qt::DropActions	supportedDropActions () const
	Specifies the supported drag and drop actions.

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
	Checks if MIME data can be dropped at a specific location.

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
	Handles dropped MIME data to rearrange rows.

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Sets data in the model for the given index and role.

Static Public Member Functions
static bool	displayEnabled (const QModelIndex &index, bool &displayStrings, bool &displayDetails)
	Checks whether the display options are enabled for the given index.

Detailed Description

A table model for managing the list of packet list columns.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumeration of column identifiers in the column list model.

Enumerator
COL_DISPLAYED	Column showing whether the column is currently displayed.
COL_TITLE	Column showing the column title.
COL_TYPE	Column showing the column type.
COL_FIELDS	Column showing the field names used in the column.
COL_OCCURRENCE	Column showing the occurrence index of the field.
COL_DISPLAY	Column showing the display format mapping.
COL_WIDTH	Column showing the width property.
COL_XALIGN	Column showing the alignment property.

◆ anonymous enum

anonymous enum

Enumeration of custom roles used in the column list model.

Enumerator
OriginalType	Role for the original, unmodified column type.
DisplayedState	Role for querying the internal displayed state.

Constructor & Destructor Documentation

◆ ColumnListModel()

ColumnListModel::ColumnListModel ( QObject * parent = Q_NULLPTR )

Constructs a new ColumnListModel.

Parameters

parent The parent QObject, defaults to Q_NULLPTR.

Member Function Documentation

◆ canDropMimeData()

bool ColumnListModel::canDropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)		const

virtual

Checks if MIME data can be dropped at a specific location.

Parameters

data	The MIME data being dropped.
action	The drop action.
row	The target row for the drop.
column	The target column for the drop.
parent	The target parent model index.

Returns: True if the drop is allowed, false otherwise.

◆ columnCount()

int ColumnListModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

virtual

Retrieves the number of columns in the model.

Parameters

parent The parent model index.

Returns: The number of columns.

◆ data()

QVariant ColumnListModel::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

virtual

Retrieves data from the model.

Parameters

index	The model index.
role	The requested data role.

Returns: The data associated with the index and role.

◆ deleteEntry()

void ColumnListModel::deleteEntry ( int row )

Deletes a specific entry from the column list.

Parameters

row	The row index to delete.

◆ displayEnabled()

bool ColumnListModel::displayEnabled	(	const QModelIndex &	index,
		bool &	displayStrings,
		bool &	displayDetails
	)

static

Checks whether the display options are enabled for the given index.

Parameters

index	The model index.
displayStrings	Output boolean indicating if display strings are supported.
displayDetails	Output boolean indicating if display details are supported.

Returns: True if display options are enabled, false otherwise.

◆ dropMimeData()

bool ColumnListModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)

virtual

Handles dropped MIME data to rearrange rows.

Parameters

data	The MIME data dropped.
action	The drop action.
row	The target row.
column	The target column.
parent	The target parent index.

Returns: True if the drop was successfully processed, false otherwise.

◆ flags()

Qt::ItemFlags ColumnListModel::flags ( const QModelIndex & index ) const

virtual

Retrieves the item flags for a given index.

Parameters

index The model index.

Returns: The valid item flags for the index.

◆ headerData()

QVariant ColumnListModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

virtual

Retrieves header data for the table model.

Parameters

section	The column or row section.
orientation	The orientation of the header.
role	The requested data role.

Returns: The header data.

◆ mimeData()

QMimeData * ColumnListModel::mimeData ( const QModelIndexList & indexes ) const

virtual

Generates MIME data for the specified list of indexes.

Parameters

indexes The list of indexes to generate data for.

Returns: A pointer to the generated QMimeData.

◆ mimeTypes()

QStringList ColumnListModel::mimeTypes ( ) const

virtual

Retrieves the supported MIME types for drag and drop operations.

Returns: A list of supported MIME type strings.

◆ rowCount()

int ColumnListModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

virtual

Retrieves the number of rows in the model.

Parameters

parent The parent model index.

Returns: The number of rows.

◆ setData()

bool ColumnListModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

virtual

Sets data in the model for the given index and role.

Parameters

index	The model index to update.
value	The value to set.
role	The data role being set.

Returns: True if the data was successfully updated, false otherwise.

◆ supportedDropActions()

Qt::DropActions ColumnListModel::supportedDropActions ( ) const

virtual

Specifies the supported drag and drop actions.

Returns: The supported drop actions.

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

/builds/wireshark/wireshark/ui/qt/models/column_list_model.h
/builds/wireshark/wireshark/ui/qt/models/column_list_model.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ColumnListModel()

Member Function Documentation

◆ canDropMimeData()

◆ columnCount()

◆ data()

◆ deleteEntry()

◆ displayEnabled()

◆ dropMimeData()

◆ flags()

◆ headerData()

◆ mimeData()

◆ mimeTypes()

◆ rowCount()

◆ setData()

◆ supportedDropActions()