digiKam Developer Documentation
Professional Photo Management with the Power of Open Source
Loading...
Searching...
No Matches
Digikam::FilterSideBarWidget Class Reference

Sidebar widget containing the all filter widgets. More...

+ Inheritance diagram for Digikam::FilterSideBarWidget:

Public Slots

void slotFilterMatchesForText (bool)
 
void slotResetFilters ()
 Resets all selected filters.
 

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)
 Emitted if the selected filter has changed.
 

Public Member Functions

 FilterSideBarWidget (QWidget *const parent, TagModel *const tagFilterModel)
 Constructor.
 
 ~FilterSideBarWidget () override
 Destructor.
 
void doLoadState () override
 Implement this hook method for state loading.
 
void doSaveState () override
 Implement this hook method for state saving.
 
void setConfigGroup (const KConfigGroup &group) override
 Sets a dedicated config group that will be used to store and reload the state from.
 
void setFocusToTextFilter ()
 
- Public Member Functions inherited from Digikam::DVBox
 DVBox (QWidget *const parent=nullptr)
 
- Public Member Functions inherited from Digikam::DHBox
 DHBox (QWidget *const parent=nullptr)
 
QSize minimumSizeHint () const override
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setSpacing (int space)
 
void setStretchFactor (QWidget *const widget, int stretch)
 
QSize sizeHint () const override
 
- Public Member Functions inherited from Digikam::StateSavingObject
 StateSavingObject (QObject *const host)
 Constructor.
 
virtual ~StateSavingObject ()
 Destructor.
 
StateSavingDepth getStateSavingDepth () const
 Returns the depth used for state saving or loading.
 
void loadState ()
 Invokes loading the class' state.
 
void saveState ()
 Invokes saving the class' state.
 
virtual void setEntryPrefix (const QString &prefix)
 Define a prefix that will be used for every entry in the config group.
 
void setStateSavingDepth (const StateSavingDepth depth)
 Sets the depth used for state saving or loading.
 

Additional Inherited Members

- Public Types inherited from Digikam::StateSavingObject
enum  StateSavingDepth { INSTANCE , DIRECT_CHILDREN , RECURSIVE }
 This enum defines the "depth" of the StateSavingObject::loadState() and StateSavingObject::saveState() methods. More...
 
- Protected Member Functions inherited from Digikam::DHBox
 DHBox (bool vertical, QWidget *const parent)
 
void childEvent (QChildEvent *e) override
 
- Protected Member Functions inherited from Digikam::StateSavingObject
QString entryName (const QString &base) const
 Always use this method to create config group entry names.
 
KConfigGroup getConfigGroup () const
 Returns the config group that must be used for state saving and loading.
 

Detailed Description

Author
jwienke

Constructor & Destructor Documentation

◆ FilterSideBarWidget()

Digikam::FilterSideBarWidget::FilterSideBarWidget ( QWidget *const  parent,
TagModel *const  tagFilterModel 
)
explicit
Parameters
parentthe parent for qt parent child mechanism
tagFilterModeltag model to work on

Member Function Documentation

◆ doLoadState()

void Digikam::FilterSideBarWidget::doLoadState ( )
overridevirtual

Use getConfigGroup() and entryName() for the implementation.

Implements Digikam::StateSavingObject.

◆ doSaveState()

void Digikam::FilterSideBarWidget::doSaveState ( )
overridevirtual

Use getConfigGroup() and entryName() for the implementation.

Implements Digikam::StateSavingObject.

◆ setConfigGroup()

void Digikam::FilterSideBarWidget::setConfigGroup ( const KConfigGroup &  group)
overridevirtual

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.

◆ 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
Parameters
includedTagsa list of included tag ids
excludedTagsa list of excluded tag ids
matchingCondcondition to join the selected tags
showUnTaggedif this is true, only photos without a tag shall be shown
clTagIdsa list of color label tag ids
plTagIdsa list of pick label tag ids