Classes
class	Private

Public Member Functions
	ItemLister ()

void	list (ItemListerReceiver *const receiver, const CoreDbUrl &url)

void	listDateRange (ItemListerReceiver *const receiver, const QDate &startDate, const QDate &endDate)

void	setListOnlyAvailable (bool listOnlyAvailable)

void	setRecursive (bool recursive)

	~ItemLister ()

Operations with TAlbum
void	listTag (ItemListerReceiver *const receiver, const QList< int > &tagIds)

void	listImageTagPropertySearch (ItemListerReceiver *const receiver, const QString &xml)

QString	tagSearchXml (int tagId, const QString &type, bool includeChildTags) const

Operations with FAlbum
void	listFaces (ItemListerReceiver *const receiver, int personId)

Operations with PAlbum
void	listPAlbum (ItemListerReceiver *const receiver, int albumRootId, const QString &album)

Operations with SAlbum
void	listSearch (ItemListerReceiver *const receiver, const QString &xml, int limit=0, qlonglong referenceImageId=-1)

void	listHaarSearch (ItemListerReceiver *const receiver, const QString &xml)

void	listAreaRange (ItemListerReceiver *const receiver, double lat1, double lat2, double lon1, double lon2)

Constructor & Destructor Documentation

◆ ItemLister()

Digikam::ItemLister::ItemLister ( )

explicit

◆ ~ItemLister()

Digikam::ItemLister::~ItemLister ( )

Member Function Documentation

◆ list()

void Digikam::ItemLister::list	(	ItemListerReceiver *const	receiver,
		const CoreDbUrl &	url
	)

Convenience method for Album, Tag and Date URLs, not for Search URLs.

References Digikam::CoreDbUrl::album(), Digikam::CoreDbUrl::albumRootId(), Digikam::CoreDbUrl::areaCoordinates(), Digikam::CoreDbUrl::endDate(), Digikam::CoreDbUrl::isAlbumUrl(), Digikam::CoreDbUrl::isDateUrl(), Digikam::CoreDbUrl::isMapImagesUrl(), Digikam::CoreDbUrl::isTagUrl(), listAreaRange(), listDateRange(), listPAlbum(), listTag(), Digikam::CoreDbUrl::startDate(), and Digikam::CoreDbUrl::tagIds().

Referenced by listFaces().

◆ listAreaRange()

void Digikam::ItemLister::listAreaRange	(	ItemListerReceiver *const	receiver,
		double	lat1,
		double	lat2,
		double	lon1,
		double	lon2
	)

List the images whose coordinates are between coordinates contained in areaCoordinates(lat1, lat2, lng1, lng2).

References Digikam::ItemListerRecord::albumRootID, Digikam::CoreDbAccess::backend(), Digikam::ItemListerRecord::creationDate, Digikam::BdEngineBackend::execSql(), Digikam::ItemListerRecord::extraValues, Digikam::ItemListerRecord::imageID, Digikam::ItemLister::Private::listOnlyAvailableImages, Digikam::ItemListerRecord::rating, and Digikam::ItemListerReceiver::receive().

Referenced by list(), and Digikam::GPSJob::run().

◆ listDateRange()

void Digikam::ItemLister::listDateRange	(	ItemListerReceiver *const	receiver,
		const QDate &	startDate,
		const QDate &	endDate
	)

List those images whose date lies in the range beginning with startDate (inclusive) and ending before endDate (exclusive).

Referenced by list(), and Digikam::DatesJob::run().

◆ listFaces()

void Digikam::ItemLister::listFaces	(	ItemListerReceiver *const	receiver,
		int	personId
	)

List the images which have faces. An image with n faces will be listed n times. FIXME: Obviously an ugly way. Should be trashed later in favor of a better method.

References Digikam::CoreDbAccess::backend(), Digikam::BdEngineBackend::execSql(), Digikam::TagsCache::instance(), list(), Digikam::TagsCache::tagForPath(), Digikam::TagsCache::tagName(), and Digikam::ItemTagPair::values().

◆ listHaarSearch()

void Digikam::ItemLister::listHaarSearch	(	ItemListerReceiver *const	receiver,
		const QString &	xml
	)

Execute the search specified by search XML describing a Haar search

Parameters

receiver	the receiver for the searches
xml	SearchXml describing the query

References Digikam::HaarIface::bestMatchesForImageWithThreshold(), Digikam::HaarIface::bestMatchesForSignature(), Digikam::SearchXml::End, Digikam::ItemListerReceiver::error(), Digikam::SearchXml::Field, Digikam::SearchXmlReader::fieldName(), Digikam::HaarIface::HanddrawnSketch, Digikam::ItemLister::Private::listOnlyAvailableImages, Digikam::SearchXmlReader::readNext(), Digikam::SearchXmlReader::readToFirstField(), Digikam::HaarIface::ScannedSketch, Digikam::HaarIface::setAlbumRootsToSearch(), Digikam::SearchXmlReader::value(), Digikam::SearchXmlReader::valueToIntList(), and Digikam::SearchXmlReader::valueToLongLong().

◆ listImageTagPropertySearch()

void Digikam::ItemLister::listImageTagPropertySearch	(	ItemListerReceiver *const	receiver,
		const QString &	xml
	)

Execute the search specified by search XML describing a Tag Properties search. Two special add-ons: Non-unique by image id; if enabled, uses the extended ImageRecord protocol to pass the property value in the record's extraValue.

Parameters

receiver	the receiver for the searches
xml	SearchXml describing the query

Referenced by Digikam::TagsJob::run().

◆ listPAlbum()

void Digikam::ItemLister::listPAlbum	(	ItemListerReceiver *const	receiver,
		int	albumRootId,
		const QString &	album
	)

List images in the Album (physical album) specified by albumRoot, album. The results will be fed to the specified receiver.

Referenced by list(), and Digikam::AlbumsJob::run().

◆ listSearch()

void Digikam::ItemLister::listSearch	(	ItemListerReceiver *const	receiver,
		const QString &	xml,
		int	limit = `0`,
		qlonglong	referenceImageId = `-1`
	)

Execute the search specified by search XML

Parameters

receiver	the receiver for the searches
xml	SearchXml describing the query
limit	the limit the count of the result set. If limit = 0, then no limit is set.
referenceImageId	the id of a reference image in the search query.