digiKam
Public Types | Signals | Public Member Functions | Protected Member Functions | List of all members
Digikam::SidebarWidget Class Referenceabstract
+ Inheritance diagram for Digikam::SidebarWidget:

Public Types

enum  StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }
 

Signals

void requestActiveTab (SidebarWidget *)
 
void signalNotificationError (const QString &message, int type)
 

Public Member Functions

virtual void applySettings ()=0
 
virtual void changeAlbumFromHistory (const QList< Album * > &album)=0
 
virtual const QString getCaption ()=0
 
virtual const QIcon getIcon ()=0
 
StateSavingDepth getStateSavingDepth () const
 
void loadState ()
 
void saveState ()
 
virtual void setActive (bool active)=0
 
virtual void setConfigGroup (const KConfigGroup &group)
 
virtual void setEntryPrefix (const QString &prefix)
 
void setStateSavingDepth (const StateSavingDepth depth)
 
 SidebarWidget (QWidget *const parent)
 
 ~SidebarWidget () override
 

Protected Member Functions

virtual void doLoadState ()=0
 
virtual void doSaveState ()=0
 
QString entryName (const QString &base) const
 
KConfigGroup getConfigGroup () const
 

Detailed Description

Abstract base class for widgets that are use in one of digikams's sidebars.

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

◆ SidebarWidget()

Digikam::SidebarWidget::SidebarWidget ( QWidget *const  parent)
explicit

Constructor.

Parameters
parentthe parent of this widget, may be null

◆ ~SidebarWidget()

Digikam::SidebarWidget::~SidebarWidget ( )
override

Destructor.

Member Function Documentation

◆ applySettings()

virtual void Digikam::SidebarWidget::applySettings ( )
pure virtual

This method is invoked when the application settings should be (re-) applied to this widget.

Implemented in Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, and Digikam::AlbumFolderViewSideBarWidget.

Referenced by Digikam::ItemIconView::applySettings().

◆ changeAlbumFromHistory()

virtual void Digikam::SidebarWidget::changeAlbumFromHistory ( const QList< Album * > &  album)
pure virtual

This is called on this widget when the history requires to move back to the specified album

Implemented in Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, and Digikam::AlbumFolderViewSideBarWidget.

◆ doLoadState()

virtual void Digikam::StateSavingObject::doLoadState ( )
protectedpure virtualinherited

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

Implemented in Digikam::GPSSearchView, Digikam::FuzzySearchView, Digikam::FaceScanWidget, ShowFoto::ShowfotoStackViewSideBar, ShowFoto::ShowfotoFolderViewSideBar, Digikam::SearchTextBar, Digikam::Sidebar, Digikam::TagCheckView, Digikam::TagsManager, Digikam::ItemPropertiesSideBarDB, Digikam::ItemPropertiesSideBar, Digikam::ImportItemPropertiesSideBarImport, Digikam::LabelsTreeView, Digikam::AbstractCheckableAlbumTreeView, Digikam::AbstractAlbumTreeView, Digikam::TableView, Digikam::MapWidgetView, Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, Digikam::AlbumFolderViewSideBarWidget, Digikam::FilterSideBarWidget, and Digikam::DateFolderView.

Referenced by Digikam::StateSavingObject::loadState().

◆ doSaveState()

virtual void Digikam::StateSavingObject::doSaveState ( )
protectedpure virtualinherited

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

Implemented in Digikam::GPSSearchView, Digikam::FuzzySearchView, Digikam::FaceScanWidget, ShowFoto::ShowfotoStackViewSideBar, ShowFoto::ShowfotoFolderViewSideBar, Digikam::SearchTextBar, Digikam::Sidebar, Digikam::TagCheckView, Digikam::TagsManager, Digikam::ItemPropertiesSideBarDB, Digikam::ItemPropertiesSideBar, Digikam::ImportItemPropertiesSideBarImport, Digikam::LabelsTreeView, Digikam::AbstractCheckableAlbumTreeView, Digikam::AbstractAlbumTreeView, Digikam::TableView, Digikam::MapWidgetView, Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, Digikam::AlbumFolderViewSideBarWidget, Digikam::FilterSideBarWidget, and Digikam::DateFolderView.

Referenced by Digikam::StateSavingObject::saveState().

◆ 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(), ShowFoto::ShowfotoFolderViewSideBar::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(), ShowFoto::ShowfotoFolderViewSideBar::doSaveState(), ShowFoto::ShowfotoStackViewSideBar::doSaveState(), Digikam::FaceScanWidget::doSaveState(), Digikam::FuzzySearchView::doSaveState(), and Digikam::GPSSearchView::doSaveState().

◆ getCaption()

virtual const QString Digikam::SidebarWidget::getCaption ( )
pure virtual

Must be implemented to return the title of this sidebar's tab.

Returns
localized title string

Implemented in Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, and Digikam::AlbumFolderViewSideBarWidget.

Referenced by Digikam::ItemIconView::ItemIconView().

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

◆ getIcon()

virtual const QIcon Digikam::SidebarWidget::getIcon ( )
pure virtual

Must be implemented and return the icon that shall be visible for this sidebar widget.

Returns
pixmap icon

Implemented in Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, and Digikam::AlbumFolderViewSideBarWidget.

Referenced by Digikam::ItemIconView::ItemIconView().

◆ 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

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

◆ requestActiveTab

void Digikam::SidebarWidget::requestActiveTab ( SidebarWidget *  )
signal

This signal can be emitted if this sidebar widget wants to be the one that is active.

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

◆ setActive()

virtual void Digikam::SidebarWidget::setActive ( bool  active)
pure virtual

This method is called if the visible sidebar widget is changed.

Parameters
activeif true, this widget is the new active widget, if false another widget is active

Implemented in Digikam::TimelineSideBarWidget, Digikam::TagViewSideBarWidget, Digikam::SearchSideBarWidget, Digikam::PeopleSideBarWidget, Digikam::LabelsSideBarWidget, Digikam::GPSSearchSideBarWidget, Digikam::FuzzySearchSideBarWidget, Digikam::DateFolderViewSideBarWidget, and Digikam::AlbumFolderViewSideBarWidget.

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

◆ 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.

◆ setStateSavingDepth()

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

Sets the depth used for state saving or loading.

Parameters
depthnew depth to use

◆ signalNotificationError

void Digikam::SidebarWidget::signalNotificationError ( const QString &  message,
int  type 
)
signal

To dispatch error message to temporized pop-up notification widget hosted with icon-view.

Referenced by Digikam::FuzzySearchSideBarWidget::FuzzySearchSideBarWidget(), and Digikam::PeopleSideBarWidget::setActive().

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