Inheritance diagram for Digikam::DConfigDlgWdgModel:

Public Types
enum	Role { HeaderRole = Qt::UserRole + 1 , WidgetRole }

Signals
void	toggled (DConfigDlgWdgItem *page, bool checked)

Public Member Functions
void	addPage (DConfigDlgWdgItem *item)

DConfigDlgWdgItem *	addPage (QWidget *widget, const QString &name)

void	addSubPage (DConfigDlgWdgItem parent, DConfigDlgWdgItem item)

DConfigDlgWdgItem *	addSubPage (DConfigDlgWdgItem parent, QWidget widget, const QString &name)

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

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

	DConfigDlgWdgModel (QObject *const parent=nullptr)

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

QModelIndex	index (const DConfigDlgWdgItem *item) const

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override

void	insertPage (DConfigDlgWdgItem before, DConfigDlgWdgItem item)

DConfigDlgWdgItem *	insertPage (DConfigDlgWdgItem before, QWidget widget, const QString &name)

DConfigDlgWdgItem *	item (const QModelIndex &index) const

QModelIndex	parent (const QModelIndex &index) const override

void	removePage (DConfigDlgWdgItem *item)

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

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

	~DConfigDlgWdgModel () override

Protected Attributes
DConfigDlgModelPrivate *const	d_ptr

Detailed Description

This page model is used by

See also: DConfigDlgWdg to provide a hierarchical layout of pages.

Member Enumeration Documentation

◆ Role

enum Digikam::DConfigDlgModel::Role

inherited

Additional roles that DConfigDlgView uses.

Enumerator
HeaderRole	A string to be rendered as page header.
WidgetRole	A pointer to the page widget. This is the widget that is shown when the item is selected.

Constructor & Destructor Documentation

◆ DConfigDlgWdgModel()

Digikam::DConfigDlgWdgModel::DConfigDlgWdgModel ( QObject *const parent = nullptr )

explicit

Creates a new page widget model.

Parameters

parent The parent object.

◆ ~DConfigDlgWdgModel()

Digikam::DConfigDlgWdgModel::~DConfigDlgWdgModel ( )

override

Destroys the page widget model.

Member Function Documentation

◆ addPage() [1/2]

void Digikam::DConfigDlgWdgModel::addPage ( DConfigDlgWdgItem * item )

Adds a new top level page to the model.

Parameters

item The

See also: DConfigDlgWdgItem which describes the page.

References item(), and toggled().

◆ addPage() [2/2]

DConfigDlgWdgItem * Digikam::DConfigDlgWdgModel::addPage	(	QWidget *	widget,
		const QString &	name
	)

Adds a new top level page to the model.

Parameters

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated

See also: DConfigDlgWdgItem.

References item().

◆ addSubPage() [1/2]

void Digikam::DConfigDlgWdgModel::addSubPage	(	DConfigDlgWdgItem *	parent,
		DConfigDlgWdgItem *	item
	)

Inserts a new sub page in the model.

Parameters

parent The new page will be insert as child of this

See also: DConfigDlgWdgItem.

Parameters

item The

See also: DConfigDlgWdgItem which describes the page.

References Digikam::PageItem::appendChild(), Digikam::PageItem::childCount(), Digikam::PageItem::findChild(), index(), item(), parent(), Digikam::PageItem::row(), and toggled().

◆ addSubPage() [2/2]

DConfigDlgWdgItem * Digikam::DConfigDlgWdgModel::addSubPage	(	DConfigDlgWdgItem *	parent,
		QWidget *	widget,
		const QString &	name
	)

Inserts a new sub page in the model.

Parameters

parent The new page will be insert as child of this

See also: DConfigDlgWdgItem.

Parameters

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated

See also: DConfigDlgWdgItem.

References item(), and parent().

◆ columnCount()

int Digikam::DConfigDlgWdgModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

override

These methods are reimplemented from QAbstractItemModel.

◆ data()

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

override

References Digikam::DConfigDlgWdgItem::header, Digikam::DConfigDlgModel::HeaderRole, Digikam::DConfigDlgWdgItem::icon, index(), Digikam::DConfigDlgWdgItem::isCheckable(), Digikam::DConfigDlgWdgItem::isChecked(), item(), Digikam::DConfigDlgWdgItem::name, Digikam::DConfigDlgWdgItem::widget(), and Digikam::DConfigDlgModel::WidgetRole.

◆ flags()

Qt::ItemFlags Digikam::DConfigDlgWdgModel::flags ( const QModelIndex & index ) const

override

References index(), Digikam::DConfigDlgWdgItem::isCheckable(), Digikam::DConfigDlgWdgItem::isEnabled(), and item().

◆ index() [1/2]

QModelIndex Digikam::DConfigDlgWdgModel::index ( const DConfigDlgWdgItem * item ) const

Returns the index for a given

See also: DConfigDlgWdgItem. The index is invalid if the item can't be found in the model.

References Digikam::PageItem::findChild(), item(), and Digikam::PageItem::row().

◆ index() [2/2]

QModelIndex Digikam::DConfigDlgWdgModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

override

References Digikam::PageItem::child(), and parent().

Referenced by addSubPage(), data(), flags(), insertPage(), item(), parent(), removePage(), and setData().

◆ insertPage() [1/2]

void Digikam::DConfigDlgWdgModel::insertPage	(	DConfigDlgWdgItem *	before,
		DConfigDlgWdgItem *	item
	)

Inserts a new page in the model.

Parameters

before The new page will be insert before this

See also: DConfigDlgWdgItem on the same level in hierarchy.

Parameters

item The

See also: DConfigDlgWdgItem which describes the page.

References Digikam::PageItem::findChild(), index(), item(), Digikam::PageItem::parent(), parent(), Digikam::PageItem::row(), and toggled().

◆ insertPage() [2/2]

DConfigDlgWdgItem * Digikam::DConfigDlgWdgModel::insertPage	(	DConfigDlgWdgItem *	before,
		QWidget *	widget,
		const QString &	name
	)

Inserts a new page in the model.

Parameters

before The new page will be insert before this

See also: DConfigDlgWdgItem on the same level in hierarchy.

Parameters

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated

See also: DConfigDlgWdgItem.

References item().

◆ item()

DConfigDlgWdgItem * Digikam::DConfigDlgWdgModel::item ( const QModelIndex & index ) const

Returns the

See also: DConfigDlgWdgItem for a given index or 0 if the index is invalid.

References index().

Referenced by Digikam::DConfigDlgWdgPrivate::_k_slotCurrentPageChanged(), addPage(), addSubPage(), data(), flags(), index(), insertPage(), parent(), removePage(), and setData().

◆ parent()

QModelIndex Digikam::DConfigDlgWdgModel::parent ( const QModelIndex & index ) const

override

References index(), item(), and Digikam::PageItem::row().

Referenced by addSubPage(), index(), insertPage(), and rowCount().

◆ removePage()

void Digikam::DConfigDlgWdgModel::removePage ( DConfigDlgWdgItem * item )

Removes the page associated with the given

See also: DConfigDlgWdgItem.

References Digikam::PageItem::findChild(), index(), item(), Digikam::PageItem::parent(), Digikam::PageItem::removeChild(), Digikam::PageItem::row(), and toggled().

◆ rowCount()

int Digikam::DConfigDlgWdgModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

References Digikam::PageItem::childCount(), and parent().

◆ setData()

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

override

References index(), Digikam::DConfigDlgWdgItem::isCheckable(), item(), Digikam::DConfigDlgWdgItem::setChecked(), and value.

◆ toggled

void Digikam::DConfigDlgWdgModel::toggled	(	DConfigDlgWdgItem *	page,
		bool	checked
	)

signal

This signal is emitted whenever a checkable page changes its state.

Parameters

checked	is true when the
page	is checked, or false if the
page	is unchecked.

Referenced by addPage(), addSubPage(), Digikam::DConfigDlgWdg::DConfigDlgWdg(), insertPage(), and removePage().

Member Data Documentation

◆ d_ptr

DConfigDlgModelPrivate* const Digikam::DConfigDlgModel::d_ptr

protectedinherited

Referenced by Digikam::DConfigDlgModel::DConfigDlgModel(), and Digikam::DConfigDlgModel::~DConfigDlgModel().

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

core/libs/dialogs/dconfigdlgmodels.h
core/libs/dialogs/dconfigdlgmodels.cpp

Public Types

Signals

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Role

Constructor & Destructor Documentation

◆ DConfigDlgWdgModel()

◆ ~DConfigDlgWdgModel()

Member Function Documentation

◆ addPage() [1/2]

◆ addPage() [2/2]

◆ addSubPage() [1/2]

◆ addSubPage() [2/2]

◆ columnCount()

◆ data()

◆ flags()

◆ index() [1/2]

◆ index() [2/2]

◆ insertPage() [1/2]

◆ insertPage() [2/2]

◆ item()

◆ parent()

◆ removePage()

◆ rowCount()

◆ setData()

◆ toggled

Member Data Documentation

◆ d_ptr