digiKam
ShowFoto::ShowfotoFolderViewSideBar Class Reference
+ Inheritance diagram for ShowFoto::ShowfotoFolderViewSideBar:

Public Types

enum  StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }
 

Public Slots

void slotAppendContents ()
 
void slotGoHome ()
 
void slotGoUp ()
 
void slotLoadContents ()
 
void slotRedo ()
 
void slotUndo ()
 

Signals

void signalAddBookmark ()
 
void signalAppendContentsFromFiles (const QStringList &files, const QString &current)
 
void signalLoadContentsFromFiles (const QStringList &files, const QString &current)
 
void signalLoadContentsFromPath (const QString &path)
 
void signalSetup ()
 

Public Member Functions

QString currentFolder () const
 
QString currentPath () const
 
void doLoadState () override
 
void doSaveState () override
 
const QString getCaption ()
 
const QIcon getIcon ()
 
StateSavingDepth getStateSavingDepth () const
 
void loadContents (const QModelIndex &index, bool append=false)
 
void loadState ()
 
QList< QAction * > pluginActions () const
 
void registerPluginActions (const QList< DPluginAction * > &actions)
 
void saveState ()
 
virtual void setConfigGroup (const KConfigGroup &group)
 
void setCurrentPath (const QString &newPathNative)
 
void setCurrentPathWithoutUndo (const QString &newPath)
 
virtual void setEntryPrefix (const QString &prefix)
 
void setSortOrder (int order)
 
void setSortRole (int role)
 
void setStateSavingDepth (const StateSavingDepth depth)
 
 ShowfotoFolderViewSideBar (Showfoto *const parent)
 
 ~ShowfotoFolderViewSideBar () override
 

Protected Member Functions

QString entryName (const QString &base) const
 
KConfigGroup getConfigGroup () const
 

Member Enumeration Documentation

◆ StateSavingDepth

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

◆ ShowfotoFolderViewSideBar()

ShowFoto::ShowfotoFolderViewSideBar::ShowfotoFolderViewSideBar ( Showfoto *const  parent)
explicit

◆ ~ShowfotoFolderViewSideBar()

ShowFoto::ShowfotoFolderViewSideBar::~ShowfotoFolderViewSideBar ( )
override

Member Function Documentation

◆ currentFolder()

QString ShowFoto::ShowfotoFolderViewSideBar::currentFolder ( ) const

◆ currentPath()

QString ShowFoto::ShowfotoFolderViewSideBar::currentPath ( ) const

◆ doLoadState()

void ShowFoto::ShowfotoFolderViewSideBar::doLoadState ( )
overridevirtual

◆ doSaveState()

void ShowFoto::ShowfotoFolderViewSideBar::doSaveState ( )
overridevirtual

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

Implements Digikam::StateSavingObject.

References currentFolder(), 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
baseoriginal 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(), doLoadState(), ShowFoto::ShowfotoStackViewSideBar::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(), doSaveState(), ShowFoto::ShowfotoStackViewSideBar::doSaveState(), Digikam::FaceScanWidget::doSaveState(), Digikam::FuzzySearchView::doSaveState(), and Digikam::GPSSearchView::doSaveState().

◆ getCaption()

const QString ShowFoto::ShowfotoFolderViewSideBar::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(), 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(), 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(), 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().

◆ getIcon()

const QIcon ShowFoto::ShowfotoFolderViewSideBar::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

◆ loadContents()

void ShowFoto::ShowfotoFolderViewSideBar::loadContents ( const QModelIndex &  index,
bool  append = false 
)

◆ loadState()

void Digikam::StateSavingObject::loadState ( )
inherited

◆ pluginActions()

QList< QAction * > ShowFoto::ShowfotoFolderViewSideBar::pluginActions ( ) const

◆ registerPluginActions()

void ShowFoto::ShowfotoFolderViewSideBar::registerPluginActions ( const QList< DPluginAction * > &  actions)

◆ saveState()

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

◆ setCurrentPath()

void ShowFoto::ShowfotoFolderViewSideBar::setCurrentPath ( const QString &  newPathNative)

Referenced by loadContents(), slotGoHome(), and slotGoUp().

◆ setCurrentPathWithoutUndo()

void ShowFoto::ShowfotoFolderViewSideBar::setCurrentPathWithoutUndo ( const QString &  newPath)

References currentFolder().

Referenced by doLoadState().

◆ 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
prefixthe prefix to use for the config entries

References prefix.

◆ setSortOrder()

void ShowFoto::ShowfotoFolderViewSideBar::setSortOrder ( int  order)

◆ setSortRole()

void ShowFoto::ShowfotoFolderViewSideBar::setSortRole ( int  role)

◆ setStateSavingDepth()

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

Sets the depth used for state saving or loading.

Parameters
depthnew depth to use

◆ signalAddBookmark

void ShowFoto::ShowfotoFolderViewSideBar::signalAddBookmark ( )
signal

◆ signalAppendContentsFromFiles

void ShowFoto::ShowfotoFolderViewSideBar::signalAppendContentsFromFiles ( const QStringList &  files,
const QString &  current 
)
signal

Referenced by loadContents().

◆ signalLoadContentsFromFiles

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

Referenced by loadContents().

◆ signalLoadContentsFromPath

void ShowFoto::ShowfotoFolderViewSideBar::signalLoadContentsFromPath ( const QString &  path)
signal

◆ signalSetup

void ShowFoto::ShowfotoFolderViewSideBar::signalSetup ( )
signal

◆ slotAppendContents

void ShowFoto::ShowfotoFolderViewSideBar::slotAppendContents ( )
slot

References currentPath(), and loadContents().

Referenced by ShowfotoFolderViewSideBar().

◆ slotGoHome

void ShowFoto::ShowfotoFolderViewSideBar::slotGoHome ( )
slot

References setCurrentPath().

Referenced by ShowfotoFolderViewSideBar().

◆ slotGoUp

void ShowFoto::ShowfotoFolderViewSideBar::slotGoUp ( )
slot

◆ slotLoadContents

void ShowFoto::ShowfotoFolderViewSideBar::slotLoadContents ( )
slot

References currentPath(), and loadContents().

Referenced by ShowfotoFolderViewSideBar().

◆ slotRedo

void ShowFoto::ShowfotoFolderViewSideBar::slotRedo ( )
slot

◆ slotUndo

void ShowFoto::ShowfotoFolderViewSideBar::slotUndo ( )
slot

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