Digikam::FilterSideBarWidget Class Reference

Inheritance diagram for Digikam::FilterSideBarWidget:

Public Types
enum	StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }

Public Slots
void	slotFilterMatchesForText (bool)
void	slotResetFilters ()

Signals
void	signalGeolocationFilterChanged (ItemFilterSettings::GeolocationCondition)
void	signalMimeTypeFilterChanged (int)
void	signalRatingFilterChanged (int, ItemFilterSettings::RatingCondition, bool)
void	signalSearchTextFilterChanged (const SearchTextFilterSettings &)
void	signalTagFilterChanged (const QList< int > &includedTags, const QList< int > &excludedTags, ItemFilterSettings::MatchingCondition matchingCond, bool showUnTagged, const QList< int > &clTagIds, const QList< int > &plTagIds)

Public Member Functions
void	doLoadState () override
void	doSaveState () override
	FilterSideBarWidget (QWidget *const parent, TagModel *const tagFilterModel)
StateSavingDepth	getStateSavingDepth () const
void	loadState ()
QSize	minimumSizeHint () const override
void	saveState ()
void	setConfigGroup (const KConfigGroup &group) override
void	setContentsMargins (const QMargins &margins)
void	setContentsMargins (int left, int top, int right, int bottom)
virtual void	setEntryPrefix (const QString &prefix)
void	setFocusToTextFilter ()
void	setSpacing (int space)
void	setStateSavingDepth (const StateSavingDepth depth)
void	setStretchFactor (QWidget *const widget, int stretch)
QSize	sizeHint () const override
	~FilterSideBarWidget () override

Protected Member Functions
void	childEvent (QChildEvent *e) override
QString	entryName (const QString &base) const
KConfigGroup	getConfigGroup () const

Detailed Description

Sidebar widget containing the all filter widgets.

Author

jwienke

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

FilterSideBarWidget()

Digikam::FilterSideBarWidget::FilterSideBarWidget ( QWidget *const  parent, TagModel *const  tagFilterModel  )

explicit

Constructor.

Parameters

parent	the parent for qt parent child mechanism
tagFilterModel	tag model to work on

References Digikam::AbstractAlbumModel::AlbumIdRole, Digikam::AbstractAlbumModel::AlbumTitleRole, Digikam::TagPropertyName::person(), signalGeolocationFilterChanged(), signalMimeTypeFilterChanged(), signalRatingFilterChanged(), signalSearchTextFilterChanged(), and Digikam::AlbumFilterModel::StrictFiltering.

~FilterSideBarWidget()

Digikam::FilterSideBarWidget::~FilterSideBarWidget ( )

override

Destructor.

Member Function Documentation

childEvent()

void Digikam::DHBox::childEvent ( QChildEvent *  e )

overrideprotectedinherited

doLoadState()

void Digikam::FilterSideBarWidget::doLoadState ( )

overridevirtual

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

Implements Digikam::StateSavingObject.

References Digikam::SearchTextFilterSettings::All, Digikam::StateSavingObject::entryName(), Digikam::StateSavingObject::getConfigGroup(), Digikam::ApplicationSettings::instance(), and Digikam::ItemFilterSettings::OrCondition.

doSaveState()

void Digikam::FilterSideBarWidget::doSaveState ( )

overridevirtual

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

Implements Digikam::StateSavingObject.

References Digikam::StateSavingObject::entryName(), Digikam::StateSavingObject::getConfigGroup(), Digikam::ApplicationSettings::instance(), and Digikam::ApplicationSettings::setRatingFilterCond().

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

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

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

minimumSizeHint()

QSize Digikam::DHBox::minimumSizeHint ( ) const

overrideinherited

Referenced by Digikam::TransactionItemView::minimumSizeHint().

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

setConfigGroup()

void Digikam::FilterSideBarWidget::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().

setContentsMargins() [1/2]

void Digikam::DHBox::setContentsMargins ( const QMargins &  margins )

inherited

Referenced by DigikamGenericPrintCreatorPlugin::AdvPrintFinalPage::AdvPrintFinalPage(), Digikam::AlbumSelectTabs::AlbumSelectTabs(), Digikam::CaptionEdit::CaptionEdit(), Digikam::ColorLabelWidget::ColorLabelWidget(), Digikam::DFontSelect::DFontSelect(), Digikam::FuzzySearchView::FuzzySearchView(), DigikamGenericGeolocationEditPlugin::GeolocationEdit::GeolocationEdit(), Digikam::GPSSearchView::GPSSearchView(), DigikamGenericHtmlGalleryPlugin::HTMLFinalPage::HTMLFinalPage(), DigikamGenericHtmlGalleryPlugin::HTMLParametersPage::HTMLParametersPage(), DigikamGenericHtmlGalleryPlugin::HTMLThemePage::HTMLThemePage(), Digikam::IccProfilesSettings::IccProfilesSettings(), Digikam::ItemDescEditTab::ItemDescEditTab(), DigikamGenericJAlbumPlugin::JAlbumFinalPage::JAlbumFinalPage(), DigikamGenericSendByMailPlugin::MailFinalPage::MailFinalPage(), Digikam::MediaPlayerView::MediaPlayerView(), Digikam::PickLabelWidget::PickLabelWidget(), Digikam::QueueSettingsView::QueueSettingsView(), Digikam::RatingBox::RatingBox(), Digikam::RatingFilter::RatingFilter(), DigikamBqmWatermarkPlugin::WaterMark::registerSettingsWidget(), Digikam::SetupToolTip::SetupToolTip(), ShowFoto::ShowfotoFolderViewBar::ShowfotoFolderViewBar(), DigikamGenericSlideShowPlugin::SlideToolBar::SlideToolBar(), Digikam::TemplateSelector::TemplateSelector(), Digikam::TextFilter::TextFilter(), Digikam::TimelineSideBarWidget::TimelineSideBarWidget(), Digikam::ToolSettingsView::ToolSettingsView(), Digikam::TransactionItem::TransactionItem(), DigikamGenericVideoSlideShowPlugin::VidSlideFinalPage::VidSlideFinalPage(), and DigikamGenericUnifiedPlugin::WSFinalPage::WSFinalPage().

setContentsMargins() [2/2]

void Digikam::DHBox::setContentsMargins ( int  left, int  top, int  right, int  bottom  )

inherited

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.

setFocusToTextFilter()

void Digikam::FilterSideBarWidget::setFocusToTextFilter

(

)

setSpacing()

void Digikam::DHBox::setSpacing ( int  space )

inherited

Referenced by DigikamGenericPrintCreatorPlugin::AdvPrintFinalPage::AdvPrintFinalPage(), Digikam::AlbumSelectTabs::AlbumSelectTabs(), Digikam::CaptionEdit::CaptionEdit(), Digikam::ColorLabelWidget::ColorLabelWidget(), Digikam::DFontSelect::DFontSelect(), Digikam::FuzzySearchView::FuzzySearchView(), DigikamGenericGeolocationEditPlugin::GeolocationEdit::GeolocationEdit(), Digikam::GPSSearchView::GPSSearchView(), DigikamGenericHtmlGalleryPlugin::HTMLFinalPage::HTMLFinalPage(), DigikamGenericHtmlGalleryPlugin::HTMLParametersPage::HTMLParametersPage(), DigikamGenericHtmlGalleryPlugin::HTMLThemePage::HTMLThemePage(), Digikam::IccProfilesSettings::IccProfilesSettings(), Digikam::ItemDescEditTab::ItemDescEditTab(), DigikamGenericJAlbumPlugin::JAlbumFinalPage::JAlbumFinalPage(), DigikamGenericSendByMailPlugin::MailFinalPage::MailFinalPage(), Digikam::MediaPlayerView::MediaPlayerView(), Digikam::PickLabelWidget::PickLabelWidget(), Digikam::QueueSettingsView::QueueSettingsView(), Digikam::RatingBox::RatingBox(), Digikam::RatingFilter::RatingFilter(), DigikamBqmWatermarkPlugin::WaterMark::registerSettingsWidget(), Digikam::SetupToolTip::SetupToolTip(), Digikam::TemplateSelector::TemplateSelector(), Digikam::TextFilter::TextFilter(), Digikam::TimelineSideBarWidget::TimelineSideBarWidget(), Digikam::ToolSettingsView::ToolSettingsView(), Digikam::TransactionItem::TransactionItem(), DigikamGenericVideoSlideShowPlugin::VidSlideFinalPage::VidSlideFinalPage(), and DigikamGenericUnifiedPlugin::WSFinalPage::WSFinalPage().

setStateSavingDepth()

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

inherited

Sets the depth used for state saving or loading.

Parameters

depth

new depth to use

setStretchFactor()

void Digikam::DHBox::setStretchFactor ( QWidget *const  widget, int  stretch  )

inherited

Referenced by DigikamGenericPrintCreatorPlugin::AdvPrintFinalPage::AdvPrintFinalPage(), DigikamGenericPrintCreatorPlugin::AdvPrintIntroPage::AdvPrintIntroPage(), Digikam::AlbumSelectTabs::AlbumSelectTabs(), Digikam::AssignNameOverlay::createWidget(), Digikam::DFileSelector::DFileSelector(), Digikam::DFontSelect::DFontSelect(), DigikamGenericExpoBlendingPlugin::ExpoBlendingLastPage::ExpoBlendingLastPage(), DigikamGenericExpoBlendingPlugin::ExpoBlendingPreProcessPage::ExpoBlendingPreProcessPage(), DigikamGenericHtmlGalleryPlugin::HTMLFinalPage::HTMLFinalPage(), Digikam::ImageQualitySettings::ImageQualitySettings(), DigikamGenericMetadataEditPlugin::IPTCContent::IPTCContent(), DigikamGenericMetadataEditPlugin::IPTCEnvelope::IPTCEnvelope(), DigikamGenericMetadataEditPlugin::IPTCStatus::IPTCStatus(), DigikamGenericJAlbumPlugin::JAlbumFinalPage::JAlbumFinalPage(), DigikamGenericJAlbumPlugin::JAlbumIntroPage::JAlbumIntroPage(), Digikam::LensFunCameraSelector::LensFunCameraSelector(), DigikamGenericSendByMailPlugin::MailFinalPage::MailFinalPage(), DigikamGenericSendByMailPlugin::MailIntroPage::MailIntroPage(), Digikam::MaintenanceDlg::MaintenanceDlg(), Digikam::MediaPlayerView::MediaPlayerView(), DigikamGenericPanoramaPlugin::PanoLastPage::PanoLastPage(), DigikamGenericPanoramaPlugin::PanoOptimizePage::PanoOptimizePage(), DigikamGenericPanoramaPlugin::PanoPreProcessPage::PanoPreProcessPage(), Digikam::QueueSettingsView::QueueSettingsView(), DigikamBqmAutoCorrectionPlugin::AutoCorrection::registerSettingsWidget(), DigikamBqmChannelMixerPlugin::ChannelMixer::registerSettingsWidget(), DigikamBqmCurvesAdjustPlugin::CurvesAdjust::registerSettingsWidget(), DigikamBqmIccConvertPlugin::IccConvert::registerSettingsWidget(), DigikamBqmUserScriptPlugin::UserScript::registerSettingsWidget(), DigikamBqmWatermarkPlugin::WaterMark::registerSettingsWidget(), Digikam::Restoration::registerSettingsWidget(), DigikamBqmFlipPlugin::Flip::registerSettingsWidget(), DigikamBqmResizePlugin::Resize::registerSettingsWidget(), DigikamBqmRotatePlugin::Rotate::registerSettingsWidget(), Digikam::SetupMime::SetupMime(), Digikam::SetupToolTip::SetupToolTip(), ShowFoto::ShowfotoFolderViewBar::ShowfotoFolderViewBar(), Digikam::TemplateSelector::TemplateSelector(), Digikam::ToolSettingsView::ToolSettingsView(), Digikam::TransactionItem::TransactionItem(), DigikamGenericVideoSlideShowPlugin::VidSlideFinalPage::VidSlideFinalPage(), DigikamGenericUnifiedPlugin::WSFinalPage::WSFinalPage(), DigikamGenericUnifiedPlugin::WSImagesPage::WSImagesPage(), and DigikamGenericUnifiedPlugin::WSIntroPage::WSIntroPage().

signalGeolocationFilterChanged

void Digikam::FilterSideBarWidget::signalGeolocationFilterChanged ( ItemFilterSettings::GeolocationCondition  )

signal

Referenced by FilterSideBarWidget().

signalMimeTypeFilterChanged

void Digikam::FilterSideBarWidget::signalMimeTypeFilterChanged ( int  )

signal

Referenced by FilterSideBarWidget().

signalRatingFilterChanged

void Digikam::FilterSideBarWidget::signalRatingFilterChanged ( int  , ItemFilterSettings::RatingCondition  , bool    )

signal

Referenced by FilterSideBarWidget().

signalSearchTextFilterChanged

void Digikam::FilterSideBarWidget::signalSearchTextFilterChanged ( const SearchTextFilterSettings &  )

signal

Referenced by FilterSideBarWidget().

signalTagFilterChanged

void Digikam::FilterSideBarWidget::signalTagFilterChanged ( const QList< int > &  includedTags, const QList< int > &  excludedTags, ItemFilterSettings::MatchingCondition  matchingCond, bool  showUnTagged, const QList< int > &  clTagIds, const QList< int > &  plTagIds  )

signal

Emitted if the selected filter has changed.

Parameters

includedTags	a list of included tag ids
excludedTags	a list of excluded tag ids
matchingCond	condition to join the selected tags
showUnTagged	if this is true, only photos without a tag shall be shown
clTagIds	a list of color label tag ids
plTagIds	a list of pick label tag ids

sizeHint()

QSize Digikam::DHBox::sizeHint ( void  ) const

overrideinherited

slotFilterMatchesForText

void Digikam::FilterSideBarWidget::slotFilterMatchesForText ( bool  match )

slot

slotResetFilters

void Digikam::FilterSideBarWidget::slotResetFilters ( )

slot

Resets all selected filters.

References Digikam::MimeFilter::AllFiles, Digikam::ItemFilterSettings::GeolocationNoFilter, Digikam::ItemFilterSettings::GreaterEqualCondition, and Digikam::ItemFilterSettings::OrCondition.

---

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

• core/app/filters/filtersidebarwidget.h
• core/app/filters/filtersidebarwidget.cpp