Inheritance diagram for Digikam::AbstractAlbumModel:

Public Types
enum	AlbumDataRole { AlbumTitleRole = Qt::UserRole , AlbumTypeRole = Qt::UserRole + 1 , AlbumPointerRole = Qt::UserRole + 2 , AlbumIdRole = Qt::UserRole + 3 , AlbumGlobalIdRole = Qt::UserRole + 4 , AlbumSortRole = Qt::UserRole + 5 }

enum	RootAlbumBehavior { IncludeRootAlbum , IgnoreRootAlbum }

Signals
void	rootAlbumAvailable ()

Public Member Functions
	AbstractAlbumModel (Album::Type albumType, Album const rootAlbum, RootAlbumBehavior rootBehavior=IncludeRootAlbum, QObject const parent=nullptr)

Album *	albumForIndex (const QModelIndex &index) const

Album::Type	albumType () const

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

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

AlbumModelDragDropHandler *	dragDropHandler () const

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

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

bool	hasChildren (const QModelIndex &parent=QModelIndex()) const override

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

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

QModelIndex	indexForAlbum (Album *album) const

bool	isFaceTagModel () const

QMimeData *	mimeData (const QModelIndexList &indexes) const override

QStringList	mimeTypes () const override

QModelIndex	parent (const QModelIndex &index) const override

Album *	rootAlbum () const

RootAlbumBehavior	rootAlbumBehavior () const

QModelIndex	rootAlbumIndex () const

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

void	setDragDropHandler (AlbumModelDragDropHandler *handler)

Qt::DropActions	supportedDropActions () const override

	~AbstractAlbumModel () override

Static Public Member Functions
static Album *	retrieveAlbum (const QModelIndex &index)

Protected Slots
void	slotAlbumAboutToBeAdded (Album album, Album parent, Album *prev)

void	slotAlbumAboutToBeDeleted (Album *album)

void	slotAlbumAdded (Album *)

void	slotAlbumHasBeenDeleted (quintptr)

void	slotAlbumIconChanged (Album *album)

void	slotAlbumRenamed (Album *album)

void	slotAlbumsCleared ()

Protected Member Functions
virtual void	albumCleared (Album *)
	Notification when an entry is removed. More...

virtual QVariant	albumData (Album *a, int role) const
	For subclassing convenience: A part of the implementation of data() More...

virtual void	allAlbumsCleared ()
	Notification when all entries are removed. More...

virtual QString	columnHeader () const
	For subclassing convenience: A part of the implementation of headerData() More...

virtual QVariant	decorationRoleData (Album *a) const
	For subclassing convenience: A part of the implementation of data() More...

virtual bool	filterAlbum (Album *album) const

virtual QVariant	fontRoleData (Album *a) const
	For subclassing convenience: A part of the implementation of data() More...

virtual Qt::ItemFlags	itemFlags (Album *album) const
	For subclassing convenience: A part of the implementation of itemFlags() More...

void	setEnableDrag (bool enable)

void	setEnableDrop (bool enable)

void	setFaceTagModel (bool enable)

virtual QVariant	sortRoleData (Album *a) const
	For subclassing convenience: A part of the implementation of data() More...

Member Enumeration Documentation

◆ AlbumDataRole

enum Digikam::AbstractAlbumModel::AlbumDataRole

Enumerator
AlbumTitleRole	Returns the album title. Principally the same as display role, but without any additions.
AlbumTypeRole	Returns the Album::Type of the associated album.
AlbumPointerRole	Returns a pointer to the associated Album object.
AlbumIdRole	Returns the id of the associated Album object.
AlbumGlobalIdRole	Returns the global id (unique across all album types)
AlbumSortRole	Returns the data to sort on.

◆ RootAlbumBehavior

enum Digikam::AbstractAlbumModel::RootAlbumBehavior

AbstractAlbumModel is the abstract base class for all models that present Album objects as managed by AlbumManager. You will want to create an instance of the base classes.

Enumerator
IncludeRootAlbum	The root album will be included as a single parent item with all top-level album as children
IgnoreRootAlbum	The root album will not be included, but all top-level album are represented as top-level items in this view

Constructor & Destructor Documentation

◆ AbstractAlbumModel()

Digikam::AbstractAlbumModel::AbstractAlbumModel	(	Album::Type	albumType,
		Album *const	rootAlbum,
		RootAlbumBehavior	rootBehavior = `IncludeRootAlbum`,
		QObject *const	parent = `nullptr`
	)

explicit

Create an AbstractAlbumModel object for albums with the given type. Pass the root album if it is already available. Do not use this class directly, but one of the subclasses.

◆ ~AbstractAlbumModel()

Digikam::AbstractAlbumModel::~AbstractAlbumModel ( )

override

Member Function Documentation

◆ albumCleared()

virtual void Digikam::AbstractAlbumModel::albumCleared ( Album * )

inlineprotectedvirtual

Notification when an entry is removed.

Reimplemented in Digikam::AbstractCheckableAlbumModel, and Digikam::AbstractCountingAlbumModel.

Referenced by slotAlbumAboutToBeDeleted().

◆ albumData()

QVariant Digikam::AbstractAlbumModel::albumData	(	Album *	a,
		int	role
	)		const

protectedvirtual

For subclassing convenience: A part of the implementation of data()

NOTE: these can be reimplemented in a subclass

Reimplemented in Digikam::SearchModel, Digikam::TagModel, Digikam::AlbumModel, Digikam::AbstractCheckableAlbumModel, and Digikam::AbstractCountingAlbumModel.

References AlbumGlobalIdRole, AlbumIdRole, AlbumPointerRole, AlbumSortRole, AlbumTitleRole, AlbumTypeRole, decorationRoleData(), fontRoleData(), Digikam::Album::globalID(), Digikam::Album::id(), sortRoleData(), Digikam::Album::title(), and Digikam::Album::type().

Referenced by Digikam::AbstractCountingAlbumModel::albumData(), and data().

◆ albumForIndex()

Album * Digikam::AbstractAlbumModel::albumForIndex ( const QModelIndex & index ) const

Returns the album object associated with the given model index

References index().

Referenced by Digikam::AlbumModel::albumForIndex(), Digikam::TagModel::albumForIndex(), Digikam::SearchModel::albumForIndex(), Digikam::DateAlbumModel::albumForIndex(), Digikam::AbstractCountingAlbumModel::excludeChildrenCount(), Digikam::AbstractCountingAlbumModel::includeChildrenCount(), Digikam::AbstractCheckableAlbumModel::invertCheckedAlbums(), mimeData(), Digikam::AbstractAlbumTreeView::rowsAboutToBeRemoved(), and Digikam::AbstractCheckableAlbumModel::setData().

◆ albumType()

Album::Type Digikam::AbstractAlbumModel::albumType ( ) const

Returns the Album::Type of the contained albums

Referenced by AbstractAlbumModel().

◆ allAlbumsCleared()

virtual void Digikam::AbstractAlbumModel::allAlbumsCleared ( )

inlineprotectedvirtual

Notification when all entries are removed.

Reimplemented in Digikam::AbstractCheckableAlbumModel, and Digikam::AbstractCountingAlbumModel.

Referenced by slotAlbumsCleared().

◆ columnCount()

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

override

◆ columnHeader()

QString Digikam::AbstractAlbumModel::columnHeader ( ) const

protectedvirtual

For subclassing convenience: A part of the implementation of headerData()

Reimplemented in Digikam::AbstractSpecificAlbumModel.

Referenced by headerData().

◆ data()

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

override

References albumData(), and index().

◆ decorationRoleData()

QVariant Digikam::AbstractAlbumModel::decorationRoleData ( Album * a ) const

protectedvirtual

For subclassing convenience: A part of the implementation of data()

Reimplemented in Digikam::DateAlbumModel, Digikam::TagModel, and Digikam::AlbumModel.

Referenced by albumData().

◆ dragDropHandler()

AlbumModelDragDropHandler * Digikam::AbstractAlbumModel::dragDropHandler ( ) const

Returns the drag drop handler, or 0 if none is installed

Referenced by Digikam::AbstractAlbumTreeView::dragEnterEvent(), Digikam::AbstractAlbumTreeView::dragMoveEvent(), Digikam::AbstractAlbumTreeView::dropEvent(), Digikam::AlbumTreeView::setAlbumModel(), and Digikam::TagTreeView::setAlbumModel().

◆ dropMimeData()

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

override

◆ filterAlbum()

bool Digikam::AbstractAlbumModel::filterAlbum ( Album * album ) const

protectedvirtual

Returns true for those and only those albums that shall be contained in this model. They must have a common root album, which is set in the constructor.

References Digikam::Album::type().

Referenced by Digikam::AbstractSpecificAlbumModel::emitDataChangedForChildren(), indexForAlbum(), slotAlbumAboutToBeAdded(), slotAlbumAboutToBeDeleted(), slotAlbumIconChanged(), slotAlbumRenamed(), and Digikam::AbstractSpecificAlbumModel::slotGotThumbnailFromIcon().

◆ flags()

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

override

References index(), and itemFlags().

Referenced by Digikam::AbstractCheckableAlbumModel::flags().

◆ fontRoleData()

QVariant Digikam::AbstractAlbumModel::fontRoleData ( Album * a ) const

protectedvirtual

For subclassing convenience: A part of the implementation of data()

Reimplemented in Digikam::TagModel.

Referenced by albumData().

◆ hasChildren()

bool Digikam::AbstractAlbumModel::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

override

References Digikam::Album::firstChild(), IncludeRootAlbum, and parent().

◆ headerData()

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

override

References columnHeader().

◆ index()

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

override

References Digikam::Album::childAtRow(), IncludeRootAlbum, and parent().

◆ indexForAlbum()

QModelIndex Digikam::AbstractAlbumModel::indexForAlbum ( Album * album ) const

Return the QModelIndex for the given album, or an invalid index if the album is not contained in this model.

References filterAlbum(), IncludeRootAlbum, and Digikam::Album::rowFromAlbum().

Referenced by Digikam::TagModel::activateFaceTagModel(), Digikam::AbstractSpecificAlbumModel::emitDataChangedForChildren(), Digikam::AlbumFilterModel::indexForAlbum(), Digikam::ContextMenuHelper::Private::indexForAlbumFromAction(), Digikam::AlbumFilterModel::matches(), parent(), Digikam::AbstractCheckableAlbumModel::resetAllCheckedAlbums(), rootAlbumIndex(), Digikam::AbstractCheckableAlbumModel::setChecked(), Digikam::AbstractCheckableAlbumModel::setCheckState(), Digikam::AbstractCheckableAlbumModel::setCheckStateForChildren(), Digikam::AbstractCheckableAlbumModel::setCheckStateForParents(), Digikam::AbstractCountingAlbumModel::setCount(), slotAlbumAboutToBeAdded(), slotAlbumAboutToBeDeleted(), slotAlbumIconChanged(), slotAlbumRenamed(), and Digikam::AbstractSpecificAlbumModel::slotGotThumbnailFromIcon().

◆ isFaceTagModel()

bool Digikam::AbstractAlbumModel::isFaceTagModel ( ) const

Returns true if the album model a face tag model

Referenced by Digikam::TagModel::decorationRoleData(), and Digikam::AlbumFilterModel::lessThan().

◆ itemFlags()

Qt::ItemFlags Digikam::AbstractAlbumModel::itemFlags ( Album * album ) const

protectedvirtual

For subclassing convenience: A part of the implementation of itemFlags()

Referenced by flags().

◆ mimeData()

QMimeData * Digikam::AbstractAlbumModel::mimeData ( const QModelIndexList & indexes ) const

override

References albumForIndex(), and index().

◆ mimeTypes()

QStringList Digikam::AbstractAlbumModel::mimeTypes ( ) const

override

◆ parent()

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

override

References index(), indexForAlbum(), and Digikam::Album::parent().

Referenced by Digikam::AbstractCheckableAlbumModel::checkAllAlbums(), hasChildren(), index(), Digikam::AbstractCheckableAlbumModel::invertCheckedAlbums(), Digikam::AbstractCheckableAlbumModel::resetCheckedAlbums(), rowCount(), slotAlbumAboutToBeAdded(), and slotAlbumAboutToBeDeleted().

◆ retrieveAlbum()

Album * Digikam::AbstractAlbumModel::retrieveAlbum ( const QModelIndex & index )

static

Returns the album represented by the index. In contrast to albumForIndex(), the index can be from any proxy model, as long as an AbstractAlbumModel is at the end.

References AlbumPointerRole, and index().

Referenced by Digikam::AlbumFilterModel::albumForIndex(), and Digikam::AlbumFilterModel::filterAcceptsRow().

◆ rootAlbum()

Album * Digikam::AbstractAlbumModel::rootAlbum ( ) const

Referenced by AbstractAlbumModel(), Digikam::AbstractAlbumTreeView::setAlbumModel(), Digikam::AbstractCheckableAlbumModel::setRootCheckable(), Digikam::AbstractCountingAlbumModel::setShowCount(), Digikam::DateAlbumModel::setYearMonthMap(), and Digikam::AbstractSpecificAlbumModel::slotReloadThumbnails().

◆ rootAlbumAvailable

void Digikam::AbstractAlbumModel::rootAlbumAvailable ( )

signal

This is initialized once after creation, if the root album becomes available, if it was not already available at time of construction. This is emitted regardless of root album policy.

Referenced by slotAlbumAdded().