digiKam
Digikam::GPSSearchSideBarWidget Class Reference
+ Inheritance diagram for Digikam::GPSSearchSideBarWidget:

Public Types

enum  StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }
 

Signals

void requestActiveTab (SidebarWidget *)
 
void signalMapSoloItems (const QList< qlonglong > &, const QString &)
 
void signalNotificationError (const QString &message, int type)
 

Public Member Functions

void applySettings () override
 
void changeAlbumFromHistory (const QList< Album * > &album) override
 
void doLoadState () override
 
void doSaveState () override
 
const QString getCaption () override
 
const QIcon getIcon () override
 
StateSavingDepth getStateSavingDepth () const
 
 GPSSearchSideBarWidget (QWidget *const parent, SearchModel *const searchModel, SearchModificationHelper *const searchModificationHelper, ItemFilterModel *const imageFilterModel, QItemSelectionModel *const itemSelectionModel)
 
void loadState ()
 
void saveState ()
 
void setActive (bool active) override
 
virtual void setConfigGroup (const KConfigGroup &group)
 
virtual void setEntryPrefix (const QString &prefix)
 
void setStateSavingDepth (const StateSavingDepth depth)
 
 ~GPSSearchSideBarWidget () 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

◆ GPSSearchSideBarWidget()

Digikam::GPSSearchSideBarWidget::GPSSearchSideBarWidget ( QWidget *const  parent,
SearchModel *const  searchModel,
SearchModificationHelper *const  searchModificationHelper,
ItemFilterModel *const  imageFilterModel,
QItemSelectionModel *const  itemSelectionModel 
)
explicit

◆ ~GPSSearchSideBarWidget()

Digikam::GPSSearchSideBarWidget::~GPSSearchSideBarWidget ( )
override

Member Function Documentation

◆ applySettings()

void Digikam::GPSSearchSideBarWidget::applySettings ( )
overridevirtual

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

Implements Digikam::SidebarWidget.

◆ changeAlbumFromHistory()

void Digikam::GPSSearchSideBarWidget::changeAlbumFromHistory ( const QList< Album * > &  album)
overridevirtual

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

Implements Digikam::SidebarWidget.

◆ doLoadState()

void Digikam::GPSSearchSideBarWidget::doLoadState ( )
overridevirtual

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

Implements Digikam::StateSavingObject.

◆ doSaveState()

void Digikam::GPSSearchSideBarWidget::doSaveState ( )
overridevirtual

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

Implements Digikam::StateSavingObject.

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

const QString Digikam::GPSSearchSideBarWidget::getCaption ( )
overridevirtual

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

Returns
localized title string

Implements Digikam::SidebarWidget.

◆ 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(), GPSSearchSideBarWidget(), Digikam::LabelsSideBarWidget::LabelsSideBarWidget(), Digikam::PeopleSideBarWidget::PeopleSideBarWidget(), Digikam::SearchSideBarWidget::SearchSideBarWidget(), Digikam::TagsManager::setupUi(), Digikam::TagViewSideBarWidget::TagViewSideBarWidget(), and Digikam::TimelineSideBarWidget::TimelineSideBarWidget().

◆ getIcon()

const QIcon Digikam::GPSSearchSideBarWidget::getIcon ( )
overridevirtual

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

Returns
pixmap icon

Implements Digikam::SidebarWidget.

◆ 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

◆ requestActiveTab

void Digikam::SidebarWidget::requestActiveTab ( SidebarWidget )
signalinherited

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

◆ saveState()

◆ setActive()

void Digikam::GPSSearchSideBarWidget::setActive ( bool  active)
overridevirtual

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

Implements Digikam::SidebarWidget.

◆ 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

◆ signalMapSoloItems

void Digikam::GPSSearchSideBarWidget::signalMapSoloItems ( const QList< qlonglong > &  ,
const QString &   
)
signal

Referenced by GPSSearchSideBarWidget().

◆ signalNotificationError

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

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: