digiKam
Public Slots | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
Digikam::AbstractSearchGroupContainer Class Referenceabstract
+ Inheritance diagram for Digikam::AbstractSearchGroupContainer:

Public Slots

SearchGroup * addSearchGroup ()
 
void removeSearchGroup (SearchGroup *group)
 

Public Member Functions

 AbstractSearchGroupContainer (QWidget *const parent=nullptr)
 

Protected Slots

void removeSendingSearchGroup ()
 

Protected Member Functions

virtual void addGroupToLayout (SearchGroup *group)=0
 Re-implement: Adds a newly created group to the layout structures. More...
 
virtual SearchGroup * createSearchGroup ()=0
 Re-implement: create and setup a search group. More...
 
void finishReadingGroups ()
 Call when the XML part is finished. More...
 
void readGroup (SearchXmlCachingReader &reader)
 Call when a group element is the current element. More...
 
void startReadingGroups (SearchXmlCachingReader &reader)
 Call before reading the XML part that could contain group elements. More...
 
QList< QRect > startupAnimationAreaOfGroups () const
 Collects the data from the same method of all contained groups (position relative to this widget) More...
 
void writeGroups (SearchXmlWriter &writer) const
 Write contained groups to writer. More...
 

Protected Attributes

int m_groupIndex
 
QList< SearchGroup * > m_groups
 

Constructor & Destructor Documentation

◆ AbstractSearchGroupContainer()

Digikam::AbstractSearchGroupContainer::AbstractSearchGroupContainer ( QWidget *const  parent = nullptr)
explicit

Abstract base class for classes that contain SearchGroups To contain common code of SearchView and SearchGroup, as SearchGroups can have subgroups.

Member Function Documentation

◆ addGroupToLayout()

virtual void Digikam::AbstractSearchGroupContainer::addGroupToLayout ( SearchGroup *  group)
protectedpure virtual

Re-implement: Adds a newly created group to the layout structures.

Implemented in Digikam::SearchView, and Digikam::SearchGroup.

Referenced by addSearchGroup().

◆ addSearchGroup

SearchGroup * Digikam::AbstractSearchGroupContainer::addSearchGroup ( )
slot

References addGroupToLayout(), createSearchGroup(), m_groups, and removeSendingSearchGroup().

Referenced by readGroup(), Digikam::SearchView::setup(), and Digikam::SearchView::slotAddGroupButton().

◆ createSearchGroup()

virtual SearchGroup* Digikam::AbstractSearchGroupContainer::createSearchGroup ( )
protectedpure virtual

Re-implement: create and setup a search group.

Implemented in Digikam::SearchView, and Digikam::SearchGroup.

Referenced by addSearchGroup().

◆ finishReadingGroups()

void Digikam::AbstractSearchGroupContainer::finishReadingGroups ( )
protected

Call when the XML part is finished.

References m_groupIndex, and m_groups.

Referenced by Digikam::SearchView::read(), and Digikam::SearchGroup::read().

◆ readGroup()

void Digikam::AbstractSearchGroupContainer::readGroup ( SearchXmlCachingReader &  reader)
protected

Call when a group element is the current element.

References addSearchGroup(), m_groupIndex, m_groups, and Digikam::SearchGroup::read().

Referenced by Digikam::SearchView::read(), and Digikam::SearchGroup::read().

◆ removeSearchGroup

void Digikam::AbstractSearchGroupContainer::removeSearchGroup ( SearchGroup *  group)
slot

References Digikam::SearchGroup::FirstGroup, Digikam::SearchGroup::groupType(), and m_groups.

Referenced by removeSendingSearchGroup().

◆ removeSendingSearchGroup

void Digikam::AbstractSearchGroupContainer::removeSendingSearchGroup ( )
protectedslot

References removeSearchGroup().

Referenced by addSearchGroup().

◆ startReadingGroups()

void Digikam::AbstractSearchGroupContainer::startReadingGroups ( SearchXmlCachingReader &  reader)
protected

Call before reading the XML part that could contain group elements.

References m_groupIndex.

Referenced by Digikam::SearchView::read(), and Digikam::SearchGroup::read().

◆ startupAnimationAreaOfGroups()

QList< QRect > Digikam::AbstractSearchGroupContainer::startupAnimationAreaOfGroups ( ) const
protected

Collects the data from the same method of all contained groups (position relative to this widget)

References m_groups, and Digikam::SearchGroup::startupAnimationArea().

Referenced by Digikam::SearchView::paintEvent(), and Digikam::SearchGroup::startupAnimationArea().

◆ writeGroups()

void Digikam::AbstractSearchGroupContainer::writeGroups ( SearchXmlWriter &  writer) const
protected

Write contained groups to writer.

References m_groups, and Digikam::SearchGroup::write().

Referenced by Digikam::SearchView::write(), and Digikam::SearchGroup::write().

Member Data Documentation

◆ m_groupIndex

int Digikam::AbstractSearchGroupContainer::m_groupIndex
protected

Referenced by finishReadingGroups(), readGroup(), and startReadingGroups().

◆ m_groups

QList<SearchGroup*> Digikam::AbstractSearchGroupContainer::m_groups
protected

Referenced by addSearchGroup(), Digikam::SearchView::createSearchGroup(), finishReadingGroups(), readGroup(), removeSearchGroup(), Digikam::SearchView::slotResetButton(), startupAnimationAreaOfGroups(), and writeGroups().

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