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

Classes

class  Private
 

Public Types

enum  StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }
 

Signals

void signalNotificationError (const QString &message, int type)
 

Public Member Functions

SAlbumcurrentAlbum () const
 
void doLoadState () override
 
void doSaveState () override
 
 FuzzySearchView (SearchModel *const searchModel, SearchModificationHelper *const searchModificationHelper, QWidget *const parent=nullptr)
 
StateSavingDepth getStateSavingDepth () const
 
void loadState ()
 
void newDuplicatesSearch (const QList< PAlbum * > &albums)
 
void newDuplicatesSearch (const QList< TAlbum * > &albums)
 
void saveState ()
 
void setActive (bool val)
 
void setConfigGroup (const KConfigGroup &group) override
 
void setCurrentAlbum (SAlbum *const album)
 
virtual void setEntryPrefix (const QString &prefix)
 
void setItemInfo (const ItemInfo &info)
 
void setStateSavingDepth (const StateSavingDepth depth)
 
 ~FuzzySearchView () override
 

Protected Member Functions

void dragEnterEvent (QDragEnterEvent *e) override
 
void dragMoveEvent (QDragMoveEvent *e) override
 
void dropEvent (QDropEvent *e) override
 
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

◆ FuzzySearchView()

◆ ~FuzzySearchView()

Digikam::FuzzySearchView::~FuzzySearchView ( )
override

Member Function Documentation

◆ currentAlbum()

SAlbum * Digikam::FuzzySearchView::currentAlbum ( ) const

◆ doLoadState()

void Digikam::FuzzySearchView::doLoadState ( )
overridevirtual

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

Implements Digikam::StateSavingObject.

References Digikam::FuzzySearchView::Private::configPenSketchHueEntry, Digikam::FuzzySearchView::Private::configPenSketchSaturationEntry, Digikam::FuzzySearchView::Private::configPenSketchSizeEntry, Digikam::FuzzySearchView::Private::configPenSkethValueEntry, Digikam::FuzzySearchView::Private::configResultSketchItemsEntry, Digikam::FuzzySearchView::Private::configSimilarsMaxThresholdEntry, Digikam::FuzzySearchView::Private::configSimilarsThresholdEntry, Digikam::FuzzySearchView::Private::configTabEntry, Digikam::FuzzySearchView::Private::DUPLICATES, Digikam::StateSavingObject::entryName(), Digikam::FuzzySearchView::Private::fuzzySearchAlbumSelectors, Digikam::StateSavingObject::getConfigGroup(), Digikam::FuzzySearchView::Private::hsSelector, Digikam::DHueSaturationSelector::hue(), Digikam::AlbumSelectors::loadState(), Digikam::StateSavingObject::loadState(), Digikam::FuzzySearchView::Private::penSize, Digikam::FuzzySearchView::Private::resultsSketch, Digikam::DHueSaturationSelector::saturation(), Digikam::FuzzySearchView::Private::searchTreeView, Digikam::DHueSaturationSelector::setHue(), Digikam::DIntRangeBox::setInterval(), Digikam::SketchWidget::setPenWidth(), Digikam::DHueSaturationSelector::setSaturation(), Digikam::FuzzySearchView::Private::similarityRange, Digikam::FuzzySearchView::Private::sketchSearchAlbumSelectors, Digikam::FuzzySearchView::Private::sketchWidget, Digikam::FuzzySearchView::Private::tabWidget, Digikam::DHueSaturationSelector::updateContents(), Digikam::DSelector::value, and Digikam::FuzzySearchView::Private::vSelector.

◆ doSaveState()

void Digikam::FuzzySearchView::doSaveState ( )
overridevirtual

◆ dragEnterEvent()

void Digikam::FuzzySearchView::dragEnterEvent ( QDragEnterEvent *  e)
overrideprotected

◆ dragMoveEvent()

void Digikam::FuzzySearchView::dragMoveEvent ( QDragMoveEvent *  e)
overrideprotected

◆ dropEvent()

◆ 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(), 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(), doSaveState(), and Digikam::GPSSearchView::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(), 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(), 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().

◆ 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

◆ newDuplicatesSearch() [1/2]

◆ newDuplicatesSearch() [2/2]

◆ saveState()

◆ setActive()

◆ setConfigGroup()

void Digikam::FuzzySearchView::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
groupconfig group to use for state saving and restoring

Reimplemented from Digikam::StateSavingObject.

References Digikam::FuzzySearchView::Private::searchTreeView, and Digikam::StateSavingObject::setConfigGroup().

◆ setCurrentAlbum()

void Digikam::FuzzySearchView::setCurrentAlbum ( SAlbum *const  album)

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

◆ setItemInfo()

◆ 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::FuzzySearchView::signalNotificationError ( const QString &  message,
int  type 
)
signal

Referenced by setActive().


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