digiKam
|
Public Types | |
enum | Type { PHYSICAL =0 , TAG , DATE , SEARCH , FACE } |
Public Member Functions | |
QList< int > | childAlbumIds (bool recursive=false) |
AlbumList | childAlbums (bool recursive=false) |
Album * | childAtRow (int row) const |
int | childCount () const |
CoreDbUrl | databaseUrl () const override |
QString | displayTitle () const |
void * | extraData (const void *const key) const |
Album * | firstChild () const |
int | globalID () const |
int | id () const |
bool | isAdvancedSearch () const |
bool | isAncestorOf (Album *const album) const |
bool | isDuplicatesSearch () const |
bool | isHaarSearch () const |
bool | isKeywordSearch () const |
bool | isMapSearch () const |
bool | isNormalSearch () const |
bool | isRoot () const |
bool | isTemporarySearch () const |
bool | isTimelineSearch () const |
bool | isTrashAlbum () const |
bool | isUsedByLabelsTree () const |
Album * | lastChild () const |
Album * | next () const |
Album * | parent () const |
Album * | prev () const |
QString | query () const |
void | removeExtraData (const void *const key) |
int | rowFromAlbum () const |
SAlbum (const QString &title, int id, bool root=false) | |
DatabaseSearch::Type | searchType () const |
void | setExtraData (const void *const key, void *const value) |
void | setUsedByLabelsTree (bool isUsed) |
QString | title () const |
Type | type () const |
~SAlbum () override | |
Static Public Member Functions | |
static QString | getTemporaryHaarTitle (DatabaseSearch::HaarSearchType haarType) |
static QString | getTemporaryTitle (DatabaseSearch::Type type, DatabaseSearch::HaarSearchType haarType=DatabaseSearch::HaarImageSearch) |
static int | globalID (Type type, int id) |
Produces the global id. More... | |
Protected Member Functions | |
void | clear () |
void | insertChild (Album *const child) |
void | removeChild (Album *const child) |
void | setParent (Album *const parent) |
void | setTitle (const QString &title) |
Friends | |
class | AlbumManager |
A Search Album representation
|
inherited |
Digikam::SAlbum::SAlbum | ( | const QString & | title, |
int | id, | ||
bool | root = false |
||
) |
References Digikam::Album::setTitle(), and Digikam::Album::title().
|
override |
|
inherited |
References Digikam::Album::childAlbums().
Referenced by Digikam::AlbumManager::subTags().
|
inherited |
Referenced by Digikam::Album::childAlbumIds().
|
inherited |
Referenced by Digikam::AbstractAlbumModel::index().
|
inherited |
childCount
of the album Referenced by Digikam::AbstractAlbumModel::rowCount().
|
protectedinherited |
Delete all child albums and also remove any associated extra data
Referenced by Digikam::Album::~Album().
|
overridevirtual |
Implements Digikam::Album.
References Digikam::CoreDbUrl::searchUrl().
QString Digikam::SAlbum::displayTitle | ( | ) | const |
References Digikam::DatabaseSearch::AdvancedSearch, Digikam::DatabaseSearch::DuplicatesSearch, getTemporaryHaarTitle(), Digikam::DatabaseSearch::HaarImageSearch, Digikam::DatabaseSearch::HaarSearch, Digikam::DatabaseSearch::HaarSketchSearch, isTemporarySearch(), Digikam::DatabaseSearch::KeywordSearch, Digikam::DatabaseSearch::LegacyUrlSearch, Digikam::DatabaseSearch::MapSearch, Digikam::DatabaseSearch::TimeLineSearch, Digikam::Album::title(), and Digikam::DatabaseSearch::UndefinedType.
Referenced by Digikam::SearchModel::albumData(), and Digikam::SearchModificationHelper::slotSearchDelete().
|
inherited |
Retrieve the associated extra data associated with key
key | the key of the extra data |
Referenced by Digikam::FindDuplicatesView::populateTreeView().
|
inherited |
Referenced by Digikam::AlbumManager::createPAlbum(), Digikam::AbstractSpecificAlbumModel::emitDataChangedForChildren(), Digikam::AlbumManager::findSAlbum(), Digikam::AlbumManager::findSAlbumsBySearchType(), Digikam::AbstractAlbumModel::hasChildren(), Digikam::AlbumManager::mergeTAlbum(), and Digikam::AlbumIterator::operator++().
|
static |
Returns the title for a temporary haar search depending on the sub-type used for this search
haarType | type of the haar search to get the name for |
References Digikam::DatabaseSearch::HaarImageSearch, and Digikam::DatabaseSearch::HaarSketchSearch.
Referenced by displayTitle(), Digikam::FuzzySearchView::dropEvent(), getTemporaryTitle(), isTemporarySearch(), Digikam::FuzzySearchView::setItemInfo(), and Digikam::ItemIconView::Private::userPresentableAlbumTitle().
|
static |
Returns the title of search albums that is used to mark them as a temporary search that isn't saved officially yet and is only used for viewing purposes.
type | the type of the search to get the temporary title for |
haarType | there are several haar searches, so that this search type needs a special handling |
References Digikam::DatabaseSearch::AdvancedSearch, Digikam::DatabaseSearch::DuplicatesSearch, getTemporaryHaarTitle(), Digikam::DatabaseSearch::HaarSearch, Digikam::DatabaseSearch::KeywordSearch, Digikam::DatabaseSearch::LegacyUrlSearch, Digikam::DatabaseSearch::MapSearch, Digikam::DatabaseSearch::TimeLineSearch, and Digikam::Album::type().
Referenced by isTemporarySearch(), Digikam::SearchTabHeader::selectedSearchChanged(), and Digikam::ItemIconView::Private::userPresentableAlbumTitle().
|
inherited |
An album ID is only unique among the set of all Albums of its Type. This is a global Identifier which will uniquely identifying the Album among all Albums
You can always get the ID
of the album using something like
globalID
of the album Referenced by Digikam::DBInfoIface::albumChooserItems(), Digikam::AbstractAlbumModel::albumData(), Digikam::AlbumManager::createSAlbum(), Digikam::AlbumManager::deleteSAlbum(), Digikam::AlbumManager::findAlbum(), Digikam::AlbumManager::findDAlbum(), Digikam::AlbumManager::findPAlbum(), Digikam::AlbumManager::findSAlbum(), Digikam::AlbumManager::findTAlbum(), Digikam::AlbumThumbnailLoader::getAlbumThumbnailDirectly(), Digikam::AlbumThumbnailLoader::getFaceThumbnailDirectly(), Digikam::AlbumThumbnailLoader::getTagThumbnailDirectly(), Digikam::ImportUI::slotDownload(), Digikam::AlbumThumbnailLoader::slotGotThumbnailFromIcon(), Digikam::AlbumThumbnailLoader::slotIconChanged(), and Digikam::AlbumManager::startScan().
|
staticinherited |
Produces the global id.
type | The type of the album |
id | the (type-specific) id of the album |
References Digikam::Album::DATE, Digikam::Album::FACE, Digikam::Album::id(), Digikam::Album::PHYSICAL, Digikam::Album::SEARCH, Digikam::Album::TAG, and Digikam::Album::type().
|
inherited |
Each album has a ID
uniquely identifying it in the set of Albums of a Type
ID
for a root Album is always 0ID
of the album Referenced by Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::ContextMenuHelper::addGotoMenu(), Digikam::AbstractCountingAlbumModel::albumCleared(), Digikam::AbstractCountingAlbumModel::albumCount(), Digikam::AbstractAlbumModel::albumData(), Digikam::AbstractCountingAlbumModel::albumData(), Digikam::AlbumModel::albumData(), Digikam::TagModel::albumData(), Digikam::AlbumManager::albumTitles(), Digikam::SetupCamera::applySettings(), Digikam::ItemAlbumFilterModel::compareInfosCategories(), Digikam::DigikamItemView::confirmFaces(), Digikam::TagDragDropHandler::createMimeData(), Digikam::TagEditDlg::createTAlbum(), Digikam::AlbumManager::createTAlbum(), Digikam::AlbumManager::deleteSAlbum(), Digikam::AlbumManager::deleteTAlbum(), Digikam::AbstractAlbumTreeView::doSaveState(), Digikam::AbstractCheckableAlbumTreeView::doSaveState(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::TagDragDropHandler::dropEvent(), Digikam::DuplicatesFinder::DuplicatesFinder(), Digikam::SearchTabHeader::editSearch(), Digikam::AbstractCountingAlbumModel::excludeChildrenCount(), Digikam::TagModel::fontRoleData(), Digikam::AlbumManager::getItemFromAlbum(), Digikam::Album::globalID(), Digikam::ScanController::hintAtMoveOrCopyOfItem(), Digikam::ScanController::hintAtMoveOrCopyOfItems(), Digikam::AbstractCountingAlbumModel::includeChildrenCount(), Digikam::AlbumFilterModel::lessThan(), Digikam::AlbumManager::mergeTAlbum(), Digikam::AlbumManager::moveTAlbum(), Digikam::SearchFieldAlbum::read(), Digikam::SearchFieldLabels::read(), Digikam::AlbumManager::renamePAlbum(), Digikam::AlbumManager::renameTAlbum(), Digikam::TagList::restoreSettings(), Digikam::AbstractAlbumTreeView::rowsAboutToBeRemoved(), Digikam::AlbumSelectors::selectedAlbumIds(), Digikam::AlbumSelectors::selectedTagIds(), Digikam::TagFolderView::setContexMenuItems(), Digikam::AbstractCountingAlbumModel::setCount(), Digikam::AddTagsLineEdit::setCurrentTag(), Digikam::AddTagsLineEdit::setParentTag(), Digikam::FaceGroup::slotAlbumRenamed(), Digikam::ItemIconView::slotAlbumSelected(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), Digikam::ItemIconView::slotRefresh(), Digikam::TagModificationHelper::slotTagToFaceTag(), Digikam::AddTagsComboBox::slotViewIndexActivated(), Digikam::AlbumManager::tagNames(), Digikam::AlbumManager::tagPaths(), Digikam::AlbumManager::updatePAlbumIcon(), Digikam::AlbumManager::updateSAlbum(), Digikam::AlbumManager::updateTAlbumIcon(), Digikam::SearchFieldAlbum::write(), and Digikam::SearchFieldLabels::write().
|
protectedinherited |
Referenced by Digikam::Album::setParent().
bool Digikam::SAlbum::isAdvancedSearch | ( | ) | const |
References Digikam::DatabaseSearch::AdvancedSearch.
Referenced by Digikam::SearchTabHeader::editSearch().
|
inherited |
album
is in the parent hierarchyalbum | the album to check whether it belongs in the child hierarchy |
References Digikam::Album::isRoot(), and Digikam::Album::parent().
Referenced by Digikam::AlbumDragDropHandler::accepts(), Digikam::TagDragDropHandler::accepts(), Digikam::AlbumManager::createTAlbum(), Digikam::AlbumManager::moveTAlbum(), Digikam::ItemAlbumModel::slotCollectionImageChange(), and Digikam::ItemAlbumModel::slotImageTagChange().
bool Digikam::SAlbum::isDuplicatesSearch | ( | ) | const |
References Digikam::DatabaseSearch::DuplicatesSearch.
Referenced by Digikam::FindDuplicatesView::populateTreeView().
bool Digikam::SAlbum::isHaarSearch | ( | ) | const |
References Digikam::DatabaseSearch::HaarSearch.
Referenced by isTemporarySearch().
bool Digikam::SAlbum::isKeywordSearch | ( | ) | const |
References Digikam::DatabaseSearch::KeywordSearch.
Referenced by Digikam::SearchTabHeader::editSearch(), and Digikam::SearchTabHeader::selectedSearchChanged().
bool Digikam::SAlbum::isMapSearch | ( | ) | const |
References Digikam::DatabaseSearch::MapSearch.
Referenced by Digikam::ItemAlbumModel::slotImageChange().
bool Digikam::SAlbum::isNormalSearch | ( | ) | const |
|
inherited |
Referenced by Digikam::AlbumDragDropHandler::accepts(), Digikam::TagDragDropHandler::accepts(), Digikam::ContextMenuHelper::addActionDeleteAlbum(), Digikam::ContextMenuHelper::addActionEditAlbum(), Digikam::ContextMenuHelper::addActionRenameAlbum(), Digikam::ContextMenuHelper::addActionResetAlbumIcon(), Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::AbstractCountingAlbumModel::albumData(), Digikam::AbstractCheckableAlbumModel::albumData(), Digikam::TagModel::albumData(), Digikam::AlbumDragDropHandler::createMimeData(), Digikam::AlbumManager::createPAlbum(), Digikam::TagEditDlg::createTAlbum(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::AlbumThumbnailLoader::getStandardAlbumIcon(), Digikam::AlbumThumbnailLoader::getStandardTagIcon(), Digikam::Album::isAncestorOf(), Digikam::AlbumFilterModel::matchResult(), Digikam::PAlbumPath::PAlbumPath(), Digikam::AlbumSelectDialog::selectAlbum(), Digikam::TagMngrTreeView::setContexMenuItems(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeAdded(), Digikam::AlbumWatch::slotAlbumAboutToBeDeleted(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeDeleted(), Digikam::AlbumWatch::slotAlbumAdded(), Digikam::AlbumModificationHelper::slotAlbumDelete(), Digikam::AlbumModificationHelper::slotAlbumEdit(), Digikam::AlbumModificationHelper::slotAlbumNew(), Digikam::ItemIconView::slotAlbumOpenInFileManager(), Digikam::ItemIconView::slotAlbumSelected(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), Digikam::TagModificationHelper::slotMultipleTagDel(), Digikam::TagPropWidget::slotSelectionChanged(), Digikam::TagModificationHelper::slotTagDelete(), Digikam::TAlbum::tagIDs(), and Digikam::TAlbum::tagPath().
bool Digikam::SAlbum::isTemporarySearch | ( | ) | const |
Indicates whether this album is a temporary search or not.
References getTemporaryHaarTitle(), getTemporaryTitle(), Digikam::DatabaseSearch::HaarImageSearch, Digikam::DatabaseSearch::HaarSketchSearch, isHaarSearch(), and Digikam::Album::title().
Referenced by Digikam::EditableSearchTreeView::addCustomContextMenuActions(), displayTitle(), and Digikam::SearchFilterModel::matches().
bool Digikam::SAlbum::isTimelineSearch | ( | ) | const |
References Digikam::DatabaseSearch::TimeLineSearch.
Referenced by Digikam::ItemAlbumModel::slotImageChange().
|
inherited |
References Digikam::Album::PHYSICAL.
Referenced by Digikam::AlbumDragDropHandler::accepts(), Digikam::AlbumModel::albumData(), Digikam::ToolTipFiller::albumTipContents(), Digikam::AlbumDragDropHandler::createMimeData(), Digikam::AlbumThumbnailLoader::getStandardAlbumIcon(), Digikam::AlbumFilterModel::lessThan(), Digikam::AlbumWatch::slotAlbumAboutToBeDeleted(), Digikam::AlbumWatch::slotAlbumAdded(), and Digikam::ItemIconView::slotAlbumSelected().
|
inherited |
|
inherited |
Referenced by Digikam::AlbumManager::createSAlbum(), and Digikam::AlbumManager::moveTAlbum().
|
inherited |
Referenced by Digikam::AlbumManager::createPAlbum(), Digikam::AbstractSpecificAlbumModel::emitDataChangedForChildren(), Digikam::AlbumManager::findSAlbum(), Digikam::AlbumManager::findSAlbumsBySearchType(), and Digikam::AlbumIterator::operator++().
|
inherited |
Referenced by Digikam::TagDragDropHandler::accepts(), Digikam::AlbumModel::albumData(), Digikam::Album::isAncestorOf(), Digikam::AlbumFilterModel::matchResult(), Digikam::AlbumManager::moveTAlbum(), Digikam::AlbumIterator::operator++(), Digikam::AbstractAlbumModel::parent(), Digikam::Album::setParent(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeDeleted(), Digikam::ItemIconView::slotAlbumSelected(), Digikam::TagModificationHelper::slotMultipleTagDel(), Digikam::TAlbum::tagIDs(), and Digikam::TAlbum::tagPath().
|
inherited |
QString Digikam::SAlbum::query | ( | ) | const |
|
protectedinherited |
Referenced by Digikam::AlbumManager::moveTAlbum(), and Digikam::Album::~Album().
|
inherited |
Remove the associated extra data associated with key
key | the key of the extra data |
|
inherited |
rowFromAlbum
of the album Referenced by Digikam::ItemAlbumFilterModel::compareInfosCategories(), Digikam::AbstractAlbumModel::indexForAlbum(), Digikam::AbstractAlbumModel::slotAlbumAboutToBeAdded(), and Digikam::AbstractAlbumModel::slotAlbumAboutToBeDeleted().
DatabaseSearch::Type Digikam::SAlbum::searchType | ( | ) | const |
|
inherited |
This allows to associate some "extra" data to a Album. As one Album can be used by several objects (often views) which all need to add some data, you have to use a key to reference your extra data within the Album.
That way a Album can hold and provide access to all those views separately.
for eg,
and can later access the searchFolderItem by doing
Note: you have to remove and destroy the data you associated yourself when you don't need it anymore!
key | the key of the extra data |
value | the value of the extra data |
References value.
Referenced by Digikam::FindDuplicatesView::populateTreeView().
|
protectedinherited |
References Digikam::Album::insertChild(), and Digikam::Album::parent().
Referenced by Digikam::AlbumManager::createSAlbum(), and Digikam::AlbumManager::moveTAlbum().
|
protectedinherited |
|
inherited |
Sets the property m_usedByLabelsTree to true if the search album was created using the Colors and labels tree view
isUsed | => the status of the usage |
|
inherited |
title
aka name of the album Referenced by Digikam::AbstractAlbumModel::albumData(), Digikam::SearchModel::albumData(), Digikam::DBInfoIface::albumInfo(), Digikam::AbstractCountingAlbumModel::albumName(), Digikam::AlbumPropsEdit::AlbumPropsEdit(), Digikam::ToolTipFiller::albumTipContents(), Digikam::AlbumManager::albumTitles(), Digikam::ListItem::data(), Digikam::AlbumFilterModel::dataForCurrentSortRole(), displayTitle(), Digikam::TagDragDropHandler::dropEvent(), Digikam::ImageWindow::dropEvent(), Digikam::ScanController::hintAtMoveOrCopyOfAlbum(), isTemporarySearch(), Digikam::lessThanByTitle(), Digikam::TagsManagerFilterModel::matches(), Digikam::AlbumManager::mergeTAlbum(), Digikam::AlbumManager::moveTAlbum(), Digikam::ItemViewUtilities::openInfos(), Digikam::PAlbum::PAlbum(), Digikam::AlbumManager::renamePAlbum(), SAlbum(), Digikam::SearchTabHeader::selectedSearchChanged(), Digikam::AddTagsLineEdit::setCurrentTag(), Digikam::Album::setTitle(), Digikam::AlbumModificationHelper::slotAlbumEdit(), Digikam::AlbumModificationHelper::slotAlbumRename(), Digikam::TagModificationHelper::slotMultipleFaceTagDel(), Digikam::SearchModificationHelper::slotSearchRename(), Digikam::TagPropWidget::slotSelectionChanged(), Digikam::AddTagsComboBox::slotViewIndexActivated(), Digikam::AbstractAlbumModel::sortRoleData(), Digikam::AlbumManager::tagNames(), Digikam::TAlbum::tagPath(), Digikam::TAlbum::TAlbum(), and Digikam::AlbumManager::updateSAlbum().
|
inherited |
Referenced by Digikam::ContextMenuHelper::addAlbumCheckUncheckActions(), Digikam::ContextMenuHelper::addGotoMenu(), Digikam::ContextMenuHelper::addStandardActionThumbnail(), Digikam::AbstractAlbumModel::albumData(), Digikam::DBInfoIface::albumItems(), Digikam::ItemInfoJob::allItemsFromAlbum(), Digikam::ItemViewUtilities::createNewAlbumForInfos(), Digikam::AlbumFilterModel::dataForCurrentSortRole(), Digikam::DBInfoIface::defaultUploadUrl(), Digikam::ItemDragDropHandler::dropEvent(), Digikam::AbstractAlbumModel::filterAlbum(), getTemporaryTitle(), Digikam::Album::globalID(), Digikam::AlbumFilterModel::lessThan(), Digikam::ItemViewUtilities::setAsAlbumThumbnail(), Digikam::AlbumWatch::slotAlbumAboutToBeDeleted(), Digikam::AlbumWatch::slotAlbumAdded(), Digikam::ItemAlbumModel::slotAlbumDeleted(), Digikam::ItemIconView::slotAlbumOpenInFileManager(), Digikam::AlbumFilterModel::slotAlbumRenamed(), Digikam::FaceGroup::slotAlbumRenamed(), Digikam::ImportUI::slotDownload(), Digikam::AlbumThumbnailLoader::slotIconChanged(), and Digikam::ItemIconView::slotRefresh().
|
friend |