KisResourceTaggingManager Class Reference

The KisResourceTaggingManager class is a helper class for KisResourceItemChooser for tagChooser and tagFilter widgets. More...

#include <KisResourceTaggingManager.h>

Inheritance diagram for KisResourceTaggingManager:

Classes
class	Private

Public Member Functions
void	contextMenuRequested (KoResourceSP currentResource, QPoint pos)
	contextMenuRequested method to get the context menu
	KisResourceTaggingManager (QString resourceType, KisTagFilterResourceProxyModel *model, QWidget *parent)
	KisResourceTaggingManager standard constructor of the KisResourceTaggingManager class.
void	showTaggingBar (bool show)
	showTaggingBar method to show or hide the tag chooser bar and the tag filter
KisTagChooserWidget *	tagChooserWidget ()
	tagChooserWidget method to get the tag chooser widget
KisTagFilterWidget *	tagFilterWidget ()
	tagFilterWidget method to get the tag filter widget
	~KisResourceTaggingManager () override
	~KisResourceTaggingManager destructor

Private Slots
void	slotFilterByTagChanged (const bool filterByTag)
	slotFilterByTagChanged slot for the "filter by tag" checkbox being checked or unchecked by the user
void	tagChooserIndexChanged (const KisTagSP tag)
	tagChooserIndexChanged slot for the signal that the tag chosen in the tags combobox changed
void	tagSearchLineEditTextChanged (const QString &lineEditText)
	tagSearchLineEditTextChanged slot for the signal that the text in the filter changed

Private Attributes
Private *const	d

Detailed Description

The KisResourceTaggingManager class is a helper class for KisResourceItemChooser for tagChooser and tagFilter widgets.

It takes care of exchanging information about tags between KisTagChooserWidget and KisTagFilterWidget. It makes sure that the correct tag is put in the resource model proxy that is used in the KisResourceItemChooser. Historically it also managed a list of tags; now KisTagModel is taking care of it.

Definition at line 43 of file KisResourceTaggingManager.h.

Constructor & Destructor Documentation

KisResourceTaggingManager()

KisResourceTaggingManager::KisResourceTaggingManager ( QString resourceType, KisTagFilterResourceProxyModel * model, QWidget * parent )

explicit

KisResourceTaggingManager standard constructor of the KisResourceTaggingManager class.

Parameters

resourceType	resource type of the resources that will be dealt with
model	proxy model that is used to show only the resources tagged with a specific tag
parent	parent widget

Definition at line 58 of file KisResourceTaggingManager.cpp.

    : QObject(parent)
    , d(new Private())
{
    d->model = model;
    d->resourceType = resourceType;
    d->tagModel = new KisTagModel(resourceType);
    d->tagChooser = new KisTagChooserWidget(d->tagModel, resourceType, parent);
    d->tagFilter = new KisTagFilterWidget(d->tagModel, parent);
 
    d->model->setFilterInCurrentTag(d->tagFilter->isFilterByTagChecked());
 
    connect(d->tagChooser, SIGNAL(sigTagChosen(KisTagSP)), this, SLOT(tagChooserIndexChanged(KisTagSP)));
 
    connect(d->tagFilter, SIGNAL(filterByTagChanged(bool)), this, SLOT(slotFilterByTagChanged(bool)));
    connect(d->tagFilter, SIGNAL(filterTextChanged(QString)), this, SLOT(tagSearchLineEditTextChanged(QString)));
 
    connect(d->tagChooser, SIGNAL(sigTagChosen(KisTagSP)), d->tagFilter, SLOT(clear()));
}

References connect(), d, KisTagFilterWidget::isFilterByTagChecked(), KisResourceTaggingManager::Private::model, KisResourceTaggingManager::Private::resourceType, slotFilterByTagChanged(), KisResourceTaggingManager::Private::tagChooser, tagChooserIndexChanged(), KisResourceTaggingManager::Private::tagFilter, KisResourceTaggingManager::Private::tagModel, and tagSearchLineEditTextChanged().

~KisResourceTaggingManager()

KisResourceTaggingManager::~KisResourceTaggingManager ( )

override

~KisResourceTaggingManager destructor

Definition at line 79 of file KisResourceTaggingManager.cpp.

{
    delete d->tagModel;
    delete d;
}

References d, and KisResourceTaggingManager::Private::tagModel.

Member Function Documentation

contextMenuRequested()

void KisResourceTaggingManager::contextMenuRequested	(	KoResourceSP	currentResource,
		QPoint	pos )

contextMenuRequested method to get the context menu

Parameters

currentResource	current selected resource
pos	position of the mouse cursor where the context menu should be created

Definition at line 110 of file KisResourceTaggingManager.cpp.

{
    // No visible tag chooser usually means no intended tag interaction,
    // context menu makes no sense then either
    if (!resource || !d->tagChooser->isVisible())
        return;
 
    KisResourceItemChooserContextMenu menu(resource, d->tagChooser->currentlySelectedTag(), d->tagChooser);
    menu.exec(pos);
 
}

References KisTagChooserWidget::currentlySelectedTag(), d, and KisResourceTaggingManager::Private::tagChooser.

showTaggingBar()

void KisResourceTaggingManager::showTaggingBar

(

bool

show

)

showTaggingBar method to show or hide the tag chooser bar and the tag filter

Parameters

show	if true, the bars should be shown; if false, they should be hidden

Definition at line 85 of file KisResourceTaggingManager.cpp.

{
    show ? d->tagFilter->show() : d->tagFilter->hide();
    show ? d->tagChooser->show() : d->tagChooser->hide();
 
    KConfigGroup group =  KSharedConfig::openConfig()->group("SelectedTags");
    QString tag = group.readEntry<QString>(d->resourceType, "All");
    d->tagChooser->setCurrentItem(tag);
}

References d, KisResourceTaggingManager::Private::resourceType, KisTagChooserWidget::setCurrentItem(), KisResourceTaggingManager::Private::tagChooser, and KisResourceTaggingManager::Private::tagFilter.

slotFilterByTagChanged

void KisResourceTaggingManager::slotFilterByTagChanged ( const bool filterByTag )

privateslot

slotFilterByTagChanged slot for the "filter by tag" checkbox being checked or unchecked by the user

Parameters

filterByTag

current state of the checkbox

It updates the filter in the filter proxy model to honor the "filter by tag" setting correctly.

Definition at line 105 of file KisResourceTaggingManager.cpp.

{
    d->model->setFilterInCurrentTag(filterByTag);
}

References d, and KisResourceTaggingManager::Private::model.

tagChooserIndexChanged

void KisResourceTaggingManager::tagChooserIndexChanged ( const KisTagSP tag )

privateslot

tagChooserIndexChanged slot for the signal that the tag chosen in the tags combobox changed

Parameters

tag	the currently chosen tag

It puts the current tag in the filter proxy model to get only the resources filtered out by the tag.

Definition at line 95 of file KisResourceTaggingManager.cpp.

{
    d->model->setTagFilter(tag);
}

References d, and KisResourceTaggingManager::Private::model.

tagChooserWidget()

KisTagChooserWidget * KisResourceTaggingManager::tagChooserWidget

(

)

tagChooserWidget method to get the tag chooser widget

Returns

tag chooser widget

Definition at line 122 of file KisResourceTaggingManager.cpp.

{
    return d->tagChooser;
}

References d, and KisResourceTaggingManager::Private::tagChooser.

tagFilterWidget()

KisTagFilterWidget * KisResourceTaggingManager::tagFilterWidget

(

)

tagFilterWidget method to get the tag filter widget

Returns

tag filter widget

Definition at line 127 of file KisResourceTaggingManager.cpp.

{
    return d->tagFilter;
}

References d, and KisResourceTaggingManager::Private::tagFilter.

tagSearchLineEditTextChanged

void KisResourceTaggingManager::tagSearchLineEditTextChanged ( const QString & lineEditText )

privateslot

tagSearchLineEditTextChanged slot for the signal that the text in the filter changed

Parameters

lineEditText

the current text in the filter box

It updates the filter in the filter proxy model.

Definition at line 100 of file KisResourceTaggingManager.cpp.

{
    d->model->setSearchText(lineEditText);
}

References d, and KisResourceTaggingManager::Private::model.

Member Data Documentation

d

Private* const KisResourceTaggingManager::d

private

Definition at line 108 of file KisResourceTaggingManager.h.

---

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

• libs/resourcewidgets/KisResourceTaggingManager.h
• libs/resourcewidgets/KisResourceTaggingManager.cpp