Digikam::GPSSearchView Class Reference

Inheritance diagram for Digikam::GPSSearchView:

Public Types
enum	StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }

Public Slots
void	slotClearImages ()
void	slotRefreshMap ()

Signals
void	signalMapSoloItems (const QList< qlonglong > &idList, const QString &id)

Public Member Functions
void	changeAlbumFromHistory (SAlbum *const album)
void	doLoadState () override
void	doSaveState () override
StateSavingDepth	getStateSavingDepth () const
	GPSSearchView (QWidget *const parent, SearchModel *const searchModel, SearchModificationHelper *const searchModificationHelper, ItemFilterModel *const imageFilterModel, QItemSelectionModel *const itemSelectionModel)
	Constructor. More...
void	loadState ()
void	saveState ()
void	setActive (bool state)
	Sets the widget active or inactive. More...
void	setConfigGroup (const KConfigGroup &group) override
virtual void	setEntryPrefix (const QString &prefix)
void	setStateSavingDepth (const StateSavingDepth depth)
	~GPSSearchView () 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

GPSSearchView()

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

explicit

Constructor.

Parameters

parent	the parent object.
searchModel	The model that stores the searches.
imageFilterModel	The image model used by displaying the selected images on map.
itemSelectionModel	The selection model corresponding to the imageFilterModel.

construct a second row of control actions below the control widget

References Digikam::AbstractAlbumModel::AlbumIdRole, Digikam::AbstractAlbumModel::AlbumTitleRole, Digikam::DatabaseSearch::MapSearch, Digikam::MouseModeFilter, Digikam::MouseModePan, Digikam::MouseModeRegionSelection, Digikam::MouseModeRegionSelectionFromIcon, Digikam::MouseModeSelectThumbnail, Digikam::MouseModeZoomIntoGroup, Digikam::DHBox::setContentsMargins(), and Digikam::DHBox::setSpacing().

~GPSSearchView()

Digikam::GPSSearchView::~GPSSearchView ( )

override

Member Function Documentation

changeAlbumFromHistory()

void Digikam::GPSSearchView::changeAlbumFromHistory

(

SAlbum *const

album

)

doLoadState()

void Digikam::GPSSearchView::doLoadState ( )

overridevirtual

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

Implements Digikam::StateSavingObject.

References Digikam::AlbumManager::clearCurrentAlbums(), Digikam::StateSavingObject::entryName(), Digikam::StateSavingObject::getConfigGroup(), and Digikam::AlbumManager::instance().

doSaveState()

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

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

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

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

void Digikam::GPSSearchView::setActive

(

bool

state

)

Sets the widget active or inactive.

Called when the GPSSearch tab becomes the current/not current tab.

Parameters

state

When true, the widget is enabled.

References Digikam::AlbumManager::instance(), Digikam::AlbumManager::setCurrentAlbums(), signalMapSoloItems(), and slotClearImages().

setConfigGroup()

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

overridevirtual

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 from Digikam::StateSavingObject.

References Digikam::StateSavingObject::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.

setStateSavingDepth()

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

inherited

Sets the depth used for state saving or loading.

Parameters

depth

new depth to use

signalMapSoloItems

void Digikam::GPSSearchView::signalMapSoloItems ( const QList< qlonglong > &  idList, const QString &  id  )

signal

Referenced by setActive().

slotClearImages

void Digikam::GPSSearchView::slotClearImages ( )

slot

Referenced by setActive().

slotRefreshMap

void Digikam::GPSSearchView::slotRefreshMap ( )

slot

---

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

• core/utilities/geolocation/mapsearches/gpssearchview.h
• core/utilities/geolocation/mapsearches/gpssearchview.cpp