ShowFoto::ShowfotoStackViewSideBar Class Reference

Inheritance diagram for ShowFoto::ShowfotoStackViewSideBar:

Public Types
enum	StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }

Signals
void	signalAddFavorite ()
void	signalClearItemsList ()
void	signalLoadContentsFromFiles (const QStringList &files, const QString &current)
void	signalRemoveItemInfos (const QList< ShowfotoItemInfo > &infos)
void	signalShowfotoItemInfoActivated (const ShowfotoItemInfo &info)

Public Member Functions
QUrl	currentUrl () const
void	doLoadState () override
void	doSaveState () override
const QString	getCaption ()
const QIcon	getIcon ()
StateSavingDepth	getStateSavingDepth () const
int	iconSize () const
void	loadState ()
QList< QAction * >	pluginActions () const
void	registerPluginActions (const QList< DPluginAction * > &actions)
void	saveState ()
virtual void	setConfigGroup (const KConfigGroup &group)
virtual void	setEntryPrefix (const QString &prefix)
void	setSortOrder (int order)
void	setSortRole (int role)
void	setStateSavingDepth (const StateSavingDepth depth)
void	setThumbbar (ShowfotoThumbnailBar *const thumbbar)
	ShowfotoStackViewSideBar (Showfoto *const parent)
int	sortOrder () const
int	sortRole () const
QList< QUrl >	urls () const
	~ShowfotoStackViewSideBar () override

Protected Member Functions
QString	entryName (const QString &base) const
KConfigGroup	getConfigGroup () const

Member Enumeration Documentation

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

ShowfotoStackViewSideBar()

ShowFoto::ShowfotoStackViewSideBar::ShowfotoStackViewSideBar ( Showfoto *const  parent )

explicit

References signalAddFavorite(), signalClearItemsList(), signalLoadContentsFromFiles(), signalRemoveItemInfos(), and signalShowfotoItemInfoActivated().

~ShowfotoStackViewSideBar()

ShowFoto::ShowfotoStackViewSideBar::~ShowfotoStackViewSideBar ( )

override

Member Function Documentation

currentUrl()

QUrl ShowFoto::ShowfotoStackViewSideBar::currentUrl

(

)

const

doLoadState()

void ShowFoto::ShowfotoStackViewSideBar::doLoadState ( )

overridevirtual

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

Implements Digikam::StateSavingObject.

References Digikam::StateSavingObject::entryName(), Digikam::StateSavingObject::getConfigGroup(), iconSize(), and ShowFoto::ShowfotoStackViewList::SizeSmall.

doSaveState()

void ShowFoto::ShowfotoStackViewSideBar::doSaveState ( )

overridevirtual

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

Implements Digikam::StateSavingObject.

References Digikam::StateSavingObject::entryName(), and Digikam::StateSavingObject::getConfigGroup().

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(), Digikam::AbstractAlbumTreeView::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(), doLoadState(), Digikam::FaceScanWidget::doLoadState(), Digikam::FuzzySearchView::doLoadState(), Digikam::GPSSearchView::doLoadState(), Digikam::FilterSideBarWidget::doSaveState(), Digikam::AbstractAlbumTreeView::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(), doSaveState(), Digikam::FaceScanWidget::doSaveState(), Digikam::FuzzySearchView::doSaveState(), and Digikam::GPSSearchView::doSaveState().

getCaption()

const QString ShowFoto::ShowfotoStackViewSideBar::getCaption

(

)

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(), Digikam::AbstractAlbumTreeView::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(), 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(), Digikam::AbstractAlbumTreeView::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(), 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().

getIcon()

const QIcon ShowFoto::ShowfotoStackViewSideBar::getIcon

(

)

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

iconSize()

int ShowFoto::ShowfotoStackViewSideBar::iconSize

(

)

const

Referenced by doLoadState().

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().

pluginActions()

QList< QAction * > ShowFoto::ShowfotoStackViewSideBar::pluginActions

(

)

const

registerPluginActions()

void ShowFoto::ShowfotoStackViewSideBar::registerPluginActions

(

const QList< DPluginAction * > &

actions

)

Referenced by ShowFoto::Showfoto::Showfoto().

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().

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().

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.

setSortOrder()

void ShowFoto::ShowfotoStackViewSideBar::setSortOrder

(

int

order

)

setSortRole()

void ShowFoto::ShowfotoStackViewSideBar::setSortRole

(

int

role

)

setStateSavingDepth()

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

inherited

Sets the depth used for state saving or loading.

Parameters

depth

new depth to use

setThumbbar()

void ShowFoto::ShowfotoStackViewSideBar::setThumbbar

(

ShowfotoThumbnailBar *const

thumbbar

)

signalAddFavorite

void ShowFoto::ShowfotoStackViewSideBar::signalAddFavorite ( )

signal

Referenced by ShowfotoStackViewSideBar().

signalClearItemsList

void ShowFoto::ShowfotoStackViewSideBar::signalClearItemsList ( )

signal

Referenced by ShowfotoStackViewSideBar().

signalLoadContentsFromFiles

void ShowFoto::ShowfotoStackViewSideBar::signalLoadContentsFromFiles ( const QStringList &  files, const QString &  current  )

signal

Referenced by ShowfotoStackViewSideBar().

signalRemoveItemInfos

void ShowFoto::ShowfotoStackViewSideBar::signalRemoveItemInfos ( const QList< ShowfotoItemInfo > &  infos )

signal

Referenced by ShowfotoStackViewSideBar().

signalShowfotoItemInfoActivated

void ShowFoto::ShowfotoStackViewSideBar::signalShowfotoItemInfoActivated ( const ShowfotoItemInfo &  info )

signal

Referenced by ShowfotoStackViewSideBar().

sortOrder()

int ShowFoto::ShowfotoStackViewSideBar::sortOrder

(

)

const

sortRole()

int ShowFoto::ShowfotoStackViewSideBar::sortRole

(

)

const

urls()

QList< QUrl > ShowFoto::ShowfotoStackViewSideBar::urls

(

)

const

---

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

• core/showfoto/stackview/showfotostackviewsidebar.h
• core/showfoto/stackview/showfotostackviewsidebar.cpp