Digikam::AbstractAlbumTreeView Class Reference

Inheritance diagram for Digikam::AbstractAlbumTreeView:

Classes
class	ContextMenuElement
class	Private

Public Types
enum	Flag {   CreateDefaultModel , CreateDefaultFilterModel , CreateDefaultDelegate , ShowCountAccordingToSettings ,   AlwaysShowInclusiveCounts , DefaultFlags = CreateDefaultFilterModel | CreateDefaultDelegate | ShowCountAccordingToSettings }
enum	StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }

Public Slots
void	adaptColumnsToContent ()
void	expandEverything (const QModelIndex &index)
void	scrollToSelectedAlbum ()
void	setCurrentAlbums (const QList< Album * > &albums, bool selectInAlbumManager=true)
void	setSearchTextSettings (const SearchTextSettings &settings)
void	slotCollapseAllNodes ()
	slotCollapseAllNodes - collapse all nodes without root node More...
void	slotCollapseNode ()
	slotCollapseNode - collapse recursively selected nodes More...
void	slotExpandNode ()
	slotExpandNode - expands recursively selected nodes More...

Signals
void	currentAlbumChanged (Album *currentAlbum)
void	selectedAlbumsChanged (const QList< Album * > &selectedAlbums)

Public Member Functions
	AbstractAlbumTreeView (QWidget *const parent, Flags flags)
void	addContextMenuElement (ContextMenuElement *const element)
AlbumFilterModel *	albumFilterModel () const
AbstractSpecificAlbumModel *	albumModel () const
QList< ContextMenuElement * >	contextMenuElements () const
template<class A >
QList< A * >	currentAlbums ()
void	doLoadState () override
void	doSaveState () override
bool	expandMatches (const QModelIndex &index)
StateSavingDepth	getStateSavingDepth () const
QModelIndex	indexVisuallyAt (const QPoint &p)
void	loadState ()
void	removeContextMenuElement (ContextMenuElement *const element)
void	saveState ()
QList< Album * >	selectedItems ()
	selectedItems() - More...
void	setAlbumManagerCurrentAlbum (const bool setCurrentAlbum)
virtual void	setConfigGroup (const KConfigGroup &group)
void	setContextMenuIcon (const QPixmap &pixmap)
void	setContextMenuTitle (const QString &title)
void	setEnableContextMenu (const bool enable)
virtual void	setEntryPrefix (const QString &prefix)
void	setExpandNewCurrentItem (const bool doThat)
void	setExpandOnSingleClick (const bool doThat)
void	setSelectAlbumOnClick (const bool selectOnClick)
void	setSelectOnContextMenu (const bool select)
void	setStateSavingDepth (const StateSavingDepth depth)
bool	viewportEvent (QEvent *event) override
	~AbstractAlbumTreeView () override

Protected Slots
void	albumSettingsChanged ()
void	slotCurrentChanged ()
virtual void	slotRootAlbumAvailable ()
void	slotSearchTextSettingsAboutToChange (bool searched, bool willSearch)
void	slotSearchTextSettingsChanged (bool wasSearching, bool searching)
void	slotSelectionChanged ()

Protected Member Functions
virtual void	addCustomContextMenuActions (ContextMenuHelper &cmh, Album *album)
virtual QPixmap	contextMenuIcon () const
virtual QString	contextMenuTitle () const
void	dragEnterEvent (QDragEnterEvent *e) override
void	dragLeaveEvent (QDragLeaveEvent *e) override
void	dragMoveEvent (QDragMoveEvent *e) override
void	dropEvent (QDropEvent *e) override
QString	entryName (const QString &base) const
KConfigGroup	getConfigGroup () const
virtual void	handleCustomContextMenuAction (QAction *action, const AlbumPointer< Album > &album)
virtual void	middleButtonPressed (Album *a)
void	mousePressEvent (QMouseEvent *e) override
	Other helper methods. More...
virtual QPixmap	pixmapForDrag (const QStyleOptionViewItem &option, QList< QModelIndex > indexes)
void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end) override
void	rowsInserted (const QModelIndex &index, int start, int end) override
void	setAlbumFilterModel (AlbumFilterModel *const filterModel)
void	setAlbumModel (AbstractSpecificAlbumModel *const model)
virtual bool	showContextMenuAt (QContextMenuEvent *event, Album *albumForEvent)
void	startDrag (Qt::DropActions supportedActions) override

Protected Attributes
AlbumFilterModel *	m_albumFilterModel
AbstractSpecificAlbumModel *	m_albumModel
bool	m_checkOnMiddleClick
AlbumModelDragDropHandler *	m_dragDropHandler
Flags	m_flags
int	m_lastScrollBarValue
bool	m_restoreCheckState

Detailed Description

Base class for all tree views that display Album-based content provided by an AbstractSpecificAlbumModel. This class enables various utility functions like selecting albums on mouse actions or providing an infrastructure for displaying a context menu for albums.

Context menu handling is implemented as template methods with hook methods that can be implemented by subclasses to provide a custom behavior. In default mode no context menu is shown at all. It must be enabled via a call to setEnableContextMenu.

Member Enumeration Documentation

Flag

enum Digikam::AbstractAlbumTreeView::Flag

Enumerator
CreateDefaultModel	Create a default model. Not supported by abstract classes. Not part of default flags!
CreateDefaultFilterModel	Create a default filter model.
CreateDefaultDelegate	Create a delegate which paints according to settings. If not set, the Qt default delegate of the view is used.
ShowCountAccordingToSettings	Show the count according to the settings. If not set, call setShowCount() on the model yourself.
AlwaysShowInclusiveCounts	Always show the inclusive counts. Not part of default flags!
DefaultFlags

StateSavingDepth

enum Digikam::StateSavingObject::StateSavingDepth

inherited

This enum defines the "depth" of the StateSavingObject::loadState() and StateSavingObject::saveState() methods.

Enumerator
INSTANCE	Only the instance the saving / restoring was invoked on is saved / restored.
DIRECT_CHILDREN	The instance itself and all direct children of this instance implementing StateSavingObject are saved / restored.
RECURSIVE	The instance and all children in the complete hierarchy are saved / restored.

Constructor & Destructor Documentation

AbstractAlbumTreeView()

Digikam::AbstractAlbumTreeView::AbstractAlbumTreeView	(	QWidget *const	parent,
		Flags	flags
	)

Constructs an album tree view. If you give 0 for model, call setAlbumModel afterwards. If you supply 0 for filterModel, call setAlbumFilterModel afterwards.

References adaptColumnsToContent(), albumSettingsChanged(), Digikam::AbstractAlbumTreeView::Private::contextMenuIcon, Digikam::AbstractAlbumTreeView::Private::contextMenuTitle, CreateDefaultDelegate, CreateDefaultFilterModel, currentAlbumChanged(), Digikam::AbstractAlbumTreeView::Private::delegate, Digikam::ApplicationSettings::instance(), Digikam::AbstractAlbumTreeView::Private::resizeColumnsTimer, and setAlbumFilterModel().

~AbstractAlbumTreeView()

Digikam::AbstractAlbumTreeView::~AbstractAlbumTreeView ( )

override

Member Function Documentation

adaptColumnsToContent

void Digikam::AbstractAlbumTreeView::adaptColumnsToContent ( )

slot

Adapt the column sizes to the contents of the tree view.

Referenced by AbstractAlbumTreeView(), and setAlbumFilterModel().

addContextMenuElement()

void Digikam::AbstractAlbumTreeView::addContextMenuElement

(

ContextMenuElement *const

element

)

References Digikam::AbstractAlbumTreeView::Private::contextMenuElements.

Referenced by Digikam::AbstractAlbumTreeViewSelectComboBox::addCheckUncheckContextMenuActions(), and Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView().

addCustomContextMenuActions()

void Digikam::AbstractAlbumTreeView::addCustomContextMenuActions ( ContextMenuHelper &  cmh, Album *  album  )

protectedvirtual

Hook method to add custom actions to the generated context menu.

Parameters

cmh	helper object to create the context menu
album	tag on which the context menu will be created. May be null if it is requested on no tag entry

Reimplemented in Digikam::NormalSearchTreeView, Digikam::EditableSearchTreeView, Digikam::TagFolderView, Digikam::TagCheckView, Digikam::AlbumSelectTreeView, and Digikam::TagFilterView.

albumFilterModel()

AlbumFilterModel * Digikam::AbstractAlbumTreeView::albumFilterModel

(

)

const

References m_albumFilterModel.

Referenced by doSaveState(), expandEverything(), and setCurrentAlbums().

albumModel()

AbstractSpecificAlbumModel * Digikam::AbstractAlbumTreeView::albumModel

(

)

const

References m_albumModel.

Referenced by rowsAboutToBeRemoved().

albumSettingsChanged

void Digikam::AbstractAlbumTreeView::albumSettingsChanged ( )

protectedslot

References Digikam::AbstractAlbumTreeView::Private::delegate, Digikam::ApplicationSettings::instance(), and Digikam::AlbumTreeViewDelegate::updateHeight().

Referenced by AbstractAlbumTreeView().

contextMenuElements()

QList< AbstractAlbumTreeView::ContextMenuElement * > Digikam::AbstractAlbumTreeView::contextMenuElements

(

)

const

References Digikam::AbstractAlbumTreeView::Private::contextMenuElements.

contextMenuIcon()

QPixmap Digikam::AbstractAlbumTreeView::contextMenuIcon ( ) const

protectedvirtual

Hook method that can be implemented to return a special icon used for the context menu.

Returns

the icon for the context menu

References Digikam::AbstractAlbumTreeView::Private::contextMenuIcon.

Referenced by Digikam::TagMngrTreeView::contextMenuEvent(), and Digikam::TagFolderView::contextMenuEvent().

contextMenuTitle()

QString Digikam::AbstractAlbumTreeView::contextMenuTitle ( ) const

protectedvirtual

Hook method to implement that returns the title for the context menu.

Returns

title for the context menu

Reimplemented in Digikam::EditableSearchTreeView, and Digikam::TagFolderView.

References Digikam::AbstractAlbumTreeView::Private::contextMenuTitle.

currentAlbumChanged

void Digikam::AbstractAlbumTreeView::currentAlbumChanged ( Album *  currentAlbum )

signal

Emitted when the currently selected album changes

Referenced by AbstractAlbumTreeView(), Digikam::AddTagsLineEdit::setTagTreeView(), and slotCurrentChanged().

currentAlbums()

template<class A >

QList< A * > Digikam::AbstractAlbumTreeView::currentAlbums

References Digikam::AlbumManager::currentAlbums(), and Digikam::AlbumManager::instance().

doLoadState()

void Digikam::AbstractAlbumTreeView::doLoadState ( )

overridevirtual

Implements state loading for the album tree view in a somewhat clumsy procedure because the model may not be fully loaded when this method is called. Therefore the config is first parsed into d->statesByAlbumId which holds the state of all tree view entries indexed by album id. Afterwards an initial sync run is done restoring the state of all model entries that are already present at this time. Every processed entry is removed from d->statesByAlbumId. If there are still entries left in this map we assume that the model is not fully loaded at the moment. Therefore the rowsInserted signal is connected to a slot that restores the state of new rows based on the remaining entries in d->statesByAlbumId.

Implements Digikam::StateSavingObject.

Reimplemented in Digikam::TagCheckView, and Digikam::AbstractCheckableAlbumTreeView.

References Digikam::AbstractAlbumTreeView::Private::configCurrentIndexEntry, Digikam::AbstractAlbumTreeView::Private::configExpansionEntry, Digikam::AbstractAlbumTreeView::Private::configSelectionEntry, Digikam::AbstractAlbumTreeView::Private::configSortColumnEntry, Digikam::AbstractAlbumTreeView::Private::configSortOrderEntry, Digikam::CoreDbAccess::db(), Digikam::StateSavingObject::entryName(), Digikam::CoreDB::getAlbumForPath(), Digikam::CoreDB::getAlbumRoots(), Digikam::StateSavingObject::getConfigGroup(), Digikam::AlbumRootInfo::id, scrollToSelectedAlbum(), and Digikam::AbstractAlbumTreeView::Private::statesByAlbumId.

Referenced by Digikam::AbstractCheckableAlbumTreeView::doLoadState().

doSaveState()

void Digikam::AbstractAlbumTreeView::doSaveState ( )

overridevirtual

Implement this hook method for state saving. Use getConfigGroup() and entryName() for the implementation.

Implements Digikam::StateSavingObject.

Reimplemented in Digikam::TagCheckView, and Digikam::AbstractCheckableAlbumTreeView.

References albumFilterModel(), Digikam::AlbumFilterModel::albumForIndex(), Digikam::AbstractAlbumTreeView::Private::configCurrentIndexEntry, Digikam::AbstractAlbumTreeView::Private::configExpansionEntry, Digikam::AbstractAlbumTreeView::Private::configSelectionEntry, Digikam::AbstractAlbumTreeView::Private::configSortColumnEntry, Digikam::AbstractAlbumTreeView::Private::configSortOrderEntry, Digikam::StateSavingObject::entryName(), Digikam::StateSavingObject::getConfigGroup(), Digikam::Album::id(), and Digikam::ApplicationSettings::instance().

Referenced by Digikam::AbstractCheckableAlbumTreeView::doSaveState().

dragEnterEvent()

void Digikam::AbstractAlbumTreeView::dragEnterEvent ( QDragEnterEvent *  e )

overrideprotected

References Digikam::AlbumModelDragDropHandler::acceptsMimeData(), Digikam::AbstractAlbumModel::dragDropHandler(), and m_albumModel.

dragLeaveEvent()

void Digikam::AbstractAlbumTreeView::dragLeaveEvent ( QDragLeaveEvent *  e )

overrideprotected

dragMoveEvent()

void Digikam::AbstractAlbumTreeView::dragMoveEvent ( QDragMoveEvent *  e )

overrideprotected

References Digikam::AlbumModelDragDropHandler::accepts(), Digikam::AbstractAlbumModel::dragDropHandler(), indexVisuallyAt(), m_albumFilterModel, m_albumModel, and Digikam::AlbumFilterModel::mapToSourceAlbumModel().

dropEvent()

void Digikam::AbstractAlbumTreeView::dropEvent ( QDropEvent *  e )

overrideprotected

References Digikam::AbstractAlbumModel::dragDropHandler(), Digikam::AlbumModelDragDropHandler::dropEvent(), indexVisuallyAt(), m_albumFilterModel, m_albumModel, and Digikam::AlbumFilterModel::mapToSourceAlbumModel().

entryName()

QString Digikam::StateSavingObject::entryName ( const QString &  base ) const

protectedinherited

Always use this method to create config group entry names. This allows to manipulate the entry keys externally by eg. setting a prefix.

Parameters

base	original name planned for the config group entry

Returns

entry name after manipulating it with externally set parameters

Referenced by Digikam::FilterSideBarWidget::doLoadState(), doLoadState(), Digikam::AbstractCheckableAlbumTreeView::doLoadState(), Digikam::LabelsTreeView::doLoadState(), Digikam::ImportItemPropertiesSideBarImport::doLoadState(), Digikam::ItemPropertiesSideBar::doLoadState(), Digikam::ItemPropertiesSideBarDB::doLoadState(), Digikam::TagCheckView::doLoadState(), Digikam::Sidebar::doLoadState(), Digikam::SearchTextBar::doLoadState(), ShowFoto::ShowfotoFolderViewSideBar::doLoadState(), ShowFoto::ShowfotoStackViewSideBar::doLoadState(), Digikam::FaceScanWidget::doLoadState(), Digikam::FuzzySearchView::doLoadState(), Digikam::GPSSearchView::doLoadState(), Digikam::FilterSideBarWidget::doSaveState(), doSaveState(), Digikam::AbstractCheckableAlbumTreeView::doSaveState(), Digikam::LabelsTreeView::doSaveState(), Digikam::ImportItemPropertiesSideBarImport::doSaveState(), Digikam::ItemPropertiesSideBar::doSaveState(), Digikam::ItemPropertiesSideBarDB::doSaveState(), Digikam::TagCheckView::doSaveState(), Digikam::Sidebar::doSaveState(), Digikam::SearchTextBar::doSaveState(), ShowFoto::ShowfotoFolderViewSideBar::doSaveState(), ShowFoto::ShowfotoStackViewSideBar::doSaveState(), Digikam::FaceScanWidget::doSaveState(), Digikam::FuzzySearchView::doSaveState(), and Digikam::GPSSearchView::doSaveState().

expandEverything

void Digikam::AbstractAlbumTreeView::expandEverything ( const QModelIndex &  index )

slot

Expands the complete tree under the given index.

Parameters

index

the index to start expanding everything

References albumFilterModel().

expandMatches()

bool Digikam::AbstractAlbumTreeView::expandMatches

(

const QModelIndex &

index

)

Ensures that every current match is visible by expanding all parent entries.

Parameters

index

the index to start ensuring expansion state

Returns

true if there was a match under index. This return value can normally be ignored by the caller because it is only used for an internal recursion.

References Digikam::AlbumFilterModel::ChildMatch, Digikam::AlbumFilterModel::DirectMatch, m_albumFilterModel, Digikam::AlbumFilterModel::matchResult(), Digikam::AlbumFilterModel::NoMatch, Digikam::AlbumFilterModel::ParentMatch, and Digikam::AlbumFilterModel::SpecialMatch.

Referenced by slotSearchTextSettingsChanged().

getConfigGroup()

KConfigGroup Digikam::StateSavingObject::getConfigGroup ( ) const

protectedinherited

Returns the config group that must be used for state saving and loading.

Returns

config group for state saving and loading

Referenced by Digikam::AlbumFolderViewSideBarWidget::AlbumFolderViewSideBarWidget(), Digikam::DateFolderViewSideBarWidget::DateFolderViewSideBarWidget(), Digikam::FilterSideBarWidget::doLoadState(), Digikam::TagViewSideBarWidget::doLoadState(), Digikam::TimelineSideBarWidget::doLoadState(), Digikam::MapWidgetView::doLoadState(), Digikam::TableView::doLoadState(), doLoadState(), Digikam::AbstractCheckableAlbumTreeView::doLoadState(), Digikam::LabelsTreeView::doLoadState(), Digikam::ImportItemPropertiesSideBarImport::doLoadState(), Digikam::ItemPropertiesSideBar::doLoadState(), Digikam::ItemPropertiesSideBarDB::doLoadState(), Digikam::TagsManager::doLoadState(), Digikam::TagCheckView::doLoadState(), Digikam::Sidebar::doLoadState(), Digikam::SearchTextBar::doLoadState(), ShowFoto::ShowfotoFolderViewSideBar::doLoadState(), ShowFoto::ShowfotoStackViewSideBar::doLoadState(), Digikam::FaceScanWidget::doLoadState(), Digikam::FuzzySearchView::doLoadState(), Digikam::GPSSearchView::doLoadState(), Digikam::FilterSideBarWidget::doSaveState(), Digikam::TagViewSideBarWidget::doSaveState(), Digikam::TimelineSideBarWidget::doSaveState(), Digikam::MapWidgetView::doSaveState(), Digikam::TableView::doSaveState(), doSaveState(), Digikam::AbstractCheckableAlbumTreeView::doSaveState(), Digikam::LabelsTreeView::doSaveState(), Digikam::ImportItemPropertiesSideBarImport::doSaveState(), Digikam::ItemPropertiesSideBar::doSaveState(), Digikam::ItemPropertiesSideBarDB::doSaveState(), Digikam::TagsManager::doSaveState(), Digikam::TagCheckView::doSaveState(), Digikam::Sidebar::doSaveState(), Digikam::SearchTextBar::doSaveState(), ShowFoto::ShowfotoFolderViewSideBar::doSaveState(), ShowFoto::ShowfotoStackViewSideBar::doSaveState(), Digikam::FaceScanWidget::doSaveState(), Digikam::FuzzySearchView::doSaveState(), Digikam::GPSSearchView::doSaveState(), Digikam::FuzzySearchSideBarWidget::FuzzySearchSideBarWidget(), Digikam::GPSSearchSideBarWidget::GPSSearchSideBarWidget(), Digikam::LabelsSideBarWidget::LabelsSideBarWidget(), Digikam::PeopleSideBarWidget::PeopleSideBarWidget(), Digikam::SearchSideBarWidget::SearchSideBarWidget(), Digikam::TagsManager::setupUi(), Digikam::TagViewSideBarWidget::TagViewSideBarWidget(), and Digikam::TimelineSideBarWidget::TimelineSideBarWidget().

getStateSavingDepth()

StateSavingObject::StateSavingDepth Digikam::StateSavingObject::getStateSavingDepth ( ) const

inherited

Returns the depth used for state saving or loading. Default is StateSavingDepth::INSTANCE.

Returns

state saving / restoring depth

handleCustomContextMenuAction()

void Digikam::AbstractAlbumTreeView::handleCustomContextMenuAction ( QAction *  action, const AlbumPointer< Album > &  album  )

protectedvirtual

Hook method to handle the custom context menu actions that were added with addCustomContextMenuActions.

Parameters

action	the action that was chosen by the user, may be null if none of the custom actions were selected
album	the tag on which the context menu was requested. May be null if there was no

Reimplemented in Digikam::NormalSearchTreeView, Digikam::EditableSearchTreeView, Digikam::TagFolderView, Digikam::AlbumSelectTreeView, and Digikam::TagFilterView.

indexVisuallyAt()

QModelIndex Digikam::AbstractAlbumTreeView::indexVisuallyAt

(

const QPoint &

p

)

This is a combination of indexAt() checked with visualRect(). p must be in the viewport currently. Decoration will not be included. Suitable for mouse click positions.

Referenced by dragMoveEvent(), dropEvent(), and mousePressEvent().

loadState()

void Digikam::StateSavingObject::loadState ( )

inherited

Invokes loading the class' state.

References Digikam::StateSavingObject::doLoadState().

Referenced by Digikam::FuzzySearchView::doLoadState(), Digikam::SearchTextBar::SearchTextBar(), ShowFoto::Showfoto::Showfoto(), and Digikam::TagsManager::TagsManager().

middleButtonPressed()

void Digikam::AbstractAlbumTreeView::middleButtonPressed ( Album *  a )

protectedvirtual

Reimplemented in Digikam::AbstractCheckableAlbumTreeView.

Referenced by mousePressEvent().

mousePressEvent()

void Digikam::AbstractAlbumTreeView::mousePressEvent ( QMouseEvent *  e )

overrideprotected

Other helper methods.

References Digikam::AlbumFilterModel::albumForIndex(), Digikam::AbstractAlbumTreeView::Private::expandNewCurrent, Digikam::AbstractAlbumTreeView::Private::expandOnSingleClick, indexVisuallyAt(), m_albumFilterModel, m_checkOnMiddleClick, and middleButtonPressed().

pixmapForDrag()

QPixmap Digikam::AbstractAlbumTreeView::pixmapForDrag ( const QStyleOptionViewItem &  option, QList< QModelIndex >  indexes  )

protectedvirtual

TODO: Move to delegate, when we have one. Copy code from image delegate for creating icons when dragging multiple items

Referenced by startDrag().

removeContextMenuElement()

void Digikam::AbstractAlbumTreeView::removeContextMenuElement

(

ContextMenuElement *const

element

)

References Digikam::AbstractAlbumTreeView::Private::contextMenuElements.

rowsAboutToBeRemoved()

void Digikam::AbstractAlbumTreeView::rowsAboutToBeRemoved ( const QModelIndex &  parent, int  start, int  end  )

overrideprotected

References Digikam::AbstractAlbumModel::albumForIndex(), albumModel(), Digikam::Album::id(), and Digikam::AbstractAlbumTreeView::Private::statesByAlbumId.

rowsInserted()

void Digikam::AbstractAlbumTreeView::rowsInserted ( const QModelIndex &  index, int  start, int  end  )

overrideprotected

References Digikam::AbstractAlbumTreeView::Private::statesByAlbumId.

Referenced by Digikam::AbstractCountingAlbumTreeView::rowsInserted(), and setAlbumFilterModel().

saveState()

void Digikam::StateSavingObject::saveState ( )

inherited

Invokes saving the class' state.

References Digikam::StateSavingObject::doSaveState().

Referenced by Digikam::ImageWindow::closeEvent(), Digikam::FuzzySearchView::doSaveState(), Digikam::DateFolderView::~DateFolderView(), Digikam::SearchTextBar::~SearchTextBar(), Digikam::Sidebar::~Sidebar(), and Digikam::TagsManager::~TagsManager().

scrollToSelectedAlbum

void Digikam::AbstractAlbumTreeView::scrollToSelectedAlbum ( )

slot

Scrolls to the first selected album if there is one.

Referenced by doLoadState().

selectedAlbumsChanged

void Digikam::AbstractAlbumTreeView::selectedAlbumsChanged ( const QList< Album * > &  selectedAlbums )

signal

Emitted when the current selection changes. Use currentChanged unless in multi-selection mode.

selectedItems()

QList< Album * > Digikam::AbstractAlbumTreeView::selectedItems

(

)

selectedItems() -

References m_albumFilterModel.

Referenced by Digikam::TagMngrTreeView::contextMenuEvent(), Digikam::TagFolderView::contextMenuEvent(), and Digikam::TagDragDropHandler::dropEvent().

setAlbumFilterModel()

void Digikam::AbstractAlbumTreeView::setAlbumFilterModel ( AlbumFilterModel *const  filterModel )

protected

References adaptColumnsToContent(), m_albumFilterModel, m_albumModel, Digikam::AlbumFilterModel::rootAlbumIndex(), rowsInserted(), Digikam::AlbumFilterModel::setSourceAlbumModel(), slotCurrentChanged(), slotSearchTextSettingsAboutToChange(), slotSearchTextSettingsChanged(), and slotSelectionChanged().

Referenced by AbstractAlbumTreeView(), and Digikam::AbstractCountingAlbumTreeView::setAlbumFilterModel().

setAlbumManagerCurrentAlbum()

void Digikam::AbstractAlbumTreeView::setAlbumManagerCurrentAlbum

(

const bool

setCurrentAlbum

)

Some treeviews shall control the global current album kept by AlbumManager. Other treeview are self-contained and shall not change the current album. Default: false

References Digikam::AbstractAlbumTreeView::Private::setInAlbumManager.

Referenced by Digikam::FuzzySearchView::FuzzySearchView().

setAlbumModel()

void Digikam::AbstractAlbumTreeView::setAlbumModel ( AbstractSpecificAlbumModel *const  model )

protected

References m_albumFilterModel, m_albumModel, Digikam::AbstractAlbumModel::rootAlbum(), Digikam::AlbumFilterModel::rootAlbumIndex(), Digikam::AlbumFilterModel::setSourceAlbumModel(), and slotRootAlbumAvailable().

Referenced by Digikam::AbstractCountingAlbumTreeView::setAlbumModel().

setConfigGroup()

void Digikam::StateSavingObject::setConfigGroup ( const KConfigGroup &  group )

virtualinherited

Sets a dedicated config group that will be used to store and reload the state from. If this method is not called, a group based on the object name is used.

You can re-implement this method to pass the group set here to child objects. Don't forget to call this method in your implementation.

Parameters

group

config group to use for state saving and restoring

Reimplemented in Digikam::GPSSearchView, Digikam::FuzzySearchView, Digikam::FilterSideBarWidget, and Digikam::DateFolderView.

Referenced by Digikam::ImageWindow::closeEvent(), Digikam::DateFolderView::setConfigGroup(), Digikam::FilterSideBarWidget::setConfigGroup(), Digikam::FuzzySearchView::setConfigGroup(), and Digikam::GPSSearchView::setConfigGroup().

setContextMenuIcon()

void Digikam::AbstractAlbumTreeView::setContextMenuIcon

(

const QPixmap &

pixmap

)

Set the context menu title and icon. This is used by the default implementation of contextMenuIcon() and contextMenuTitle(). You can alternatively reimplement these methods.

References Digikam::AbstractAlbumTreeView::Private::contextMenuIcon.

setContextMenuTitle()

void Digikam::AbstractAlbumTreeView::setContextMenuTitle

(

const QString &

title

)

References Digikam::AbstractAlbumTreeView::Private::contextMenuTitle.

Referenced by Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView().

setCurrentAlbums

void Digikam::AbstractAlbumTreeView::setCurrentAlbums ( const QList< Album * > &  albums, bool  selectInAlbumManager = true  )

slot

Selects the given album.

Parameters

albums	the albums to select
selectInAlbumManager	the album will be set as current album, if both this parameter is true and setAlbumManagerCurrentAlbum() was set to true.

References albumFilterModel(), Digikam::AlbumManager::instance(), Digikam::AlbumManager::setCurrentAlbums(), and Digikam::AbstractAlbumTreeView::Private::setInAlbumManager.

Referenced by Digikam::AlbumTreeView::setCurrentAlbums(), Digikam::DateTreeView::setCurrentAlbums(), Digikam::SearchTreeView::setCurrentAlbums(), Digikam::TagTreeView::setCurrentAlbums(), and slotSearchTextSettingsChanged().

setEnableContextMenu()

void Digikam::AbstractAlbumTreeView::setEnableContextMenu

(

const bool

enable

)

Determines the global decision to show a popup menu or not. More detailed decision at which position a menu can be shown and where not can be made by implementing showContextMenuAt.

Parameters

enable

if true, a context menu can be shown

References Digikam::AbstractAlbumTreeView::Private::enableContextMenu.

Referenced by Digikam::AbstractAlbumTreeViewSelectComboBox::addCheckUncheckContextMenuActions(), Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView(), Digikam::EditableSearchTreeView::EditableSearchTreeView(), and Digikam::TagFolderView::TagFolderView().

setEntryPrefix()

void Digikam::StateSavingObject::setEntryPrefix ( const QString &  prefix )

virtualinherited

Define a prefix that will be used for every entry in the config group. The default prefix is empty.

You can re-implement this method to pass the prefix set here to child objects. Don't forget to call this method in your implementation.

Parameters

prefix

the prefix to use for the config entries

References prefix.

setExpandNewCurrentItem()

void Digikam::AbstractAlbumTreeView::setExpandNewCurrentItem

(

const bool

doThat

)

Expand an item when making it the new current item

References Digikam::AbstractAlbumTreeView::Private::expandNewCurrent.

setExpandOnSingleClick()

void Digikam::AbstractAlbumTreeView::setExpandOnSingleClick

(

const bool

doThat

)

Enable expanding of tree items on single click on the item (default: off)

References Digikam::AbstractAlbumTreeView::Private::expandOnSingleClick.

Referenced by Digikam::TagCheckView::TagCheckView().

setSearchTextSettings

void Digikam::AbstractAlbumTreeView::setSearchTextSettings ( const SearchTextSettings &  settings )

slot

References m_albumFilterModel, and Digikam::AlbumFilterModel::setSearchTextSettings().

setSelectAlbumOnClick()

void Digikam::AbstractAlbumTreeView::setSelectAlbumOnClick

(

const bool

selectOnClick

)

Sets whether to select an album on click via the album manager or not.

Parameters

selectOnClick

if true, a click on an item automatically sets this item as the current album in the album manager

References Digikam::AbstractAlbumTreeView::Private::selectAlbumOnClick.

Referenced by Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView(), Digikam::EditableSearchTreeView::EditableSearchTreeView(), Digikam::TagCheckView::TagCheckView(), Digikam::TagFolderView::TagFolderView(), and Digikam::TagMngrTreeView::TagMngrTreeView().

setSelectOnContextMenu()

void Digikam::AbstractAlbumTreeView::setSelectOnContextMenu

(

const bool

select

)

Sets whether to select the album under the mouse cursor on a context menu request (so that the album is shown using the album manager) or not

Defaults to true.

Parameters

select

true if a context menu request shall select the album

References Digikam::AbstractAlbumTreeView::Private::selectOnContextMenu.

Referenced by Digikam::TagCheckView::TagCheckView().

setStateSavingDepth()

void Digikam::StateSavingObject::setStateSavingDepth ( const StateSavingDepth  depth )

inherited

Sets the depth used for state saving or loading.

Parameters

depth

new depth to use

showContextMenuAt()

bool Digikam::AbstractAlbumTreeView::showContextMenuAt ( QContextMenuEvent *  event, Album *  albumForEvent  )

protectedvirtual

Hook method to implement that determines if a context menu shall be displayed for the given event at the position coded in the event.

Parameters

event	context menu event to react on
albumForEvent	the album at the mouse position or null if there is no album at that position

Returns

true if a context menu shall be displayed at the event coordinates, else false

Referenced by Digikam::TagFolderView::contextMenuEvent().

slotCollapseAllNodes

void Digikam::AbstractAlbumTreeView::slotCollapseAllNodes ( )

slot

slotCollapseAllNodes - collapse all nodes without root node

References m_albumFilterModel, and Digikam::AlbumFilterModel::rootAlbumIndex().

Referenced by Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView(), and Digikam::TagMngrTreeView::setContexMenuItems().

slotCollapseNode

void Digikam::AbstractAlbumTreeView::slotCollapseNode ( )

slot

slotCollapseNode - collapse recursively selected nodes

Referenced by Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView(), and Digikam::TagFolderView::setContexMenuItems().

slotCurrentChanged

void Digikam::AbstractAlbumTreeView::slotCurrentChanged ( )

protectedslot

References Digikam::AlbumFilterModel::albumForIndex(), currentAlbumChanged(), and m_albumFilterModel.

Referenced by setAlbumFilterModel().

slotExpandNode

void Digikam::AbstractAlbumTreeView::slotExpandNode ( )

slot

slotExpandNode - expands recursively selected nodes

Referenced by Digikam::TagFolderView::addCustomContextMenuActions(), Digikam::AlbumSelectionTreeView::AlbumSelectionTreeView(), Digikam::TagFolderView::setContexMenuItems(), and Digikam::TagMngrTreeView::setContexMenuItems().

slotRootAlbumAvailable

void Digikam::AbstractAlbumTreeView::slotRootAlbumAvailable ( )

protectedvirtualslot

override if implemented behavior is not as intended

References m_albumFilterModel, and Digikam::AlbumFilterModel::rootAlbumIndex().

Referenced by setAlbumModel().

slotSearchTextSettingsAboutToChange

void Digikam::AbstractAlbumTreeView::slotSearchTextSettingsAboutToChange ( bool  searched, bool  willSearch  )

protectedslot

References Digikam::AbstractAlbumTreeView::Private::lastSelectedAlbum, m_albumFilterModel, and Digikam::AbstractAlbumTreeView::Private::searchBackup.

Referenced by setAlbumFilterModel().

slotSearchTextSettingsChanged

void Digikam::AbstractAlbumTreeView::slotSearchTextSettingsChanged ( bool  wasSearching, bool  searching  )

protectedslot

References expandMatches(), Digikam::AlbumFilterModel::indexForAlbum(), Digikam::AbstractAlbumTreeView::Private::lastSelectedAlbum, m_albumFilterModel, Digikam::AbstractAlbumTreeView::Private::searchBackup, and setCurrentAlbums().

Referenced by setAlbumFilterModel().

slotSelectionChanged

void Digikam::AbstractAlbumTreeView::slotSelectionChanged ( )

protectedslot

References Digikam::AlbumManager::instance(), m_albumFilterModel, Digikam::AbstractAlbumTreeView::Private::selectAlbumOnClick, and Digikam::AlbumManager::setCurrentAlbums().

Referenced by setAlbumFilterModel().

startDrag()

void Digikam::AbstractAlbumTreeView::startDrag ( Qt::DropActions  supportedActions )

overrideprotected

References Digikam::CopyAction, m_albumFilterModel, and pixmapForDrag().

viewportEvent()

bool Digikam::AbstractAlbumTreeView::viewportEvent ( QEvent *  event )

override

For internal use only.

Referenced by Digikam::AbstractAlbumTreeViewSelectComboBox::sendViewportEventToView().

Member Data Documentation

m_albumFilterModel

AlbumFilterModel* Digikam::AbstractAlbumTreeView::m_albumFilterModel

protected

Referenced by albumFilterModel(), Digikam::AbstractCheckableAlbumTreeView::albumFilterModel(), Digikam::AlbumTreeView::albumForIndex(), Digikam::DateTreeView::albumForIndex(), Digikam::TagTreeView::albumForIndex(), Digikam::AlbumTreeView::currentAlbum(), Digikam::DateTreeView::currentAlbum(), Digikam::SearchTreeView::currentAlbum(), Digikam::TagTreeView::currentAlbum(), dragMoveEvent(), dropEvent(), expandMatches(), mousePressEvent(), Digikam::AbstractCountingAlbumTreeView::rowsInserted(), selectedItems(), setAlbumFilterModel(), setAlbumModel(), Digikam::TagTreeView::setAlbumModel(), setSearchTextSettings(), slotCollapseAllNodes(), slotCurrentChanged(), slotRootAlbumAvailable(), slotSearchTextSettingsAboutToChange(), slotSearchTextSettingsChanged(), slotSelectionChanged(), and startDrag().

m_albumModel

AbstractSpecificAlbumModel* Digikam::AbstractAlbumTreeView::m_albumModel

protected

Referenced by albumModel(), Digikam::AbstractCheckableAlbumTreeView::albumModel(), Digikam::AlbumTreeView::albumModel(), Digikam::DateTreeView::albumModel(), Digikam::SearchTreeView::albumModel(), Digikam::TagTreeView::albumModel(), dragEnterEvent(), dragMoveEvent(), dropEvent(), Digikam::AbstractCheckableAlbumTreeView::middleButtonPressed(), setAlbumFilterModel(), setAlbumModel(), Digikam::AlbumTreeView::setAlbumModel(), and Digikam::TagTreeView::setAlbumModel().

m_checkOnMiddleClick

bool Digikam::AbstractAlbumTreeView::m_checkOnMiddleClick

protected

Referenced by Digikam::AbstractCheckableAlbumTreeView::AbstractCheckableAlbumTreeView(), mousePressEvent(), and Digikam::AbstractCheckableAlbumTreeView::setCheckOnMiddleClick().

m_dragDropHandler

AlbumModelDragDropHandler* Digikam::AbstractAlbumTreeView::m_dragDropHandler

protected

Referenced by Digikam::AlbumTreeView::setAlbumModel(), and Digikam::TagTreeView::setAlbumModel().

m_flags

Flags Digikam::AbstractAlbumTreeView::m_flags

protected

Referenced by Digikam::AbstractCountingAlbumTreeView::setAlbumModel().

m_lastScrollBarValue

int Digikam::AbstractAlbumTreeView::m_lastScrollBarValue

protected

m_restoreCheckState

bool Digikam::AbstractAlbumTreeView::m_restoreCheckState

protected

Referenced by Digikam::AbstractCheckableAlbumTreeView::AbstractCheckableAlbumTreeView(), Digikam::AbstractCheckableAlbumTreeView::doLoadState(), Digikam::AbstractCheckableAlbumTreeView::doSaveState(), Digikam::AbstractCheckableAlbumTreeView::isRestoreCheckState(), and Digikam::AbstractCheckableAlbumTreeView::setRestoreCheckState().

---

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

• core/libs/album/treeview/abstractalbumtreeview.h
• core/libs/album/treeview/abstractalbumtreeview.cpp