KisResourceItemChooserContextMenu Class Reference

The KisResourceItemChooserContextMenu class is responsible for the context menu in ResourceItemChooser. More...

#include <KisResourceItemChooserContextMenu.h>

Inheritance diagram for KisResourceItemChooserContextMenu:

Public Slots
void	addResourceExistingTag (const KisTagSP tag, KoResourceSP resource)
	addResourceExistingTag slot for a signal from the action to add the tag to the resource
void	removeResourceExistingTag (const KisTagSP tag, KoResourceSP resource)
	removeResourceExistingTag slot for a signal from the action to remove the tag from the resource

Signals
void	resourceAssignmentToNewTagRequested (const QString &tag, KoResourceSP resource)
	Emitted when a resource should be added to a new tag, which will need to be created.
void	resourceTagAdditionRequested (const KisTagSP tag, KoResourceSP resource)
	Emitted when a resource should be added to an existing tag.
void	resourceTagRemovalRequested (KoResourceSP resource, const KisTagSP tag)
	Emitted when a resource should be removed from an existing tag.

Public Member Functions
	KisResourceItemChooserContextMenu (KoResourceSP resource, const KisTagSP currentlySelectedTag, KisTagChooserWidget *tagChooser)
	KisResourceItemChooserContextMenu the constructor for the KisResourceItemChooserContextMenu class.
	~KisResourceItemChooserContextMenu () override
	the destructor

Private Attributes
KisTagChooserWidget *	m_tagChooserWidget {0}
KisTagModel *	m_tagModel {0}
	m_tagModel data model for tags (for tagging and untagging resources and create lists of tags)

Detailed Description

The KisResourceItemChooserContextMenu class is responsible for the context menu in ResourceItemChooser.

The context menu for the resource item in the resource item chooser (see: main area in the Brush Presets docker) contains actions to tag and untag the selected resource. In case of tagging the user can choose to create a new tag or select one of the existing ones. In case of untagging the user can untag from the current selected tag (in the combobox) or from some other tags. This class needs to provide correct lists of tags and take into account that "All" and "All Untagged" (and possibly other generated tags) are special and the user cannot untag the resource from it.

Definition at line 34 of file KisResourceItemChooserContextMenu.h.

Constructor & Destructor Documentation

KisResourceItemChooserContextMenu()

KisResourceItemChooserContextMenu::KisResourceItemChooserContextMenu ( KoResourceSP resource, const KisTagSP currentlySelectedTag, KisTagChooserWidget * tagChooser )

explicit

KisResourceItemChooserContextMenu the constructor for the KisResourceItemChooserContextMenu class.

Parameters

resource	the resource that the context menu is called for
currentlySelectedTag	the currently selected tag in the combobox over the resource item chooser

Definition at line 29 of file KisResourceItemChooserContextMenu.cpp.

    : m_tagChooserWidget(tagChooser)
{
    QImage image = resource->image();
    QIcon icon(QPixmap::fromImage(image));
    QAction *label = new QAction(resource->name(), this);
    label->setIcon(icon);
 
    addAction(label);
 
    QMenu *removableTagsMenu;
    QMenu *assignableTagsMenu;
 
    m_tagModel = new KisTagModel(resource->resourceType().first);
    m_tagModel->sort(KisAllTagsModel::Name);
    KisResourceModel resourceModel(resource->resourceType().first);
    KisTagResourceModel tagResourceModel(resource->resourceType().first);
 
    tagResourceModel.setResourcesFilter(QVector<KoResourceSP>() << resource);
    tagResourceModel.sort(KisAllTagResourceModel::TagName);
 
    QList<KisTagSP> removableTags;
    for (int i = 0; i < tagResourceModel.rowCount(); ++i) {
        KisTagSP tag = tagResourceModel.data(tagResourceModel.index(i, 0), Qt::UserRole + KisAllTagResourceModel::Tag).value<KisTagSP>();
        if (!tag.isNull() && tag->valid() && !isSpecialTag(tag)) {
            removableTags << tag;
        }
    }
 
    QList<KisTagSP> assignableTags;
    for (int i = 0; i < m_tagModel->rowCount(); i++) {
        QModelIndex index = m_tagModel->index(i, 0);
        KisTagSP tag = m_tagModel->tagForIndex(index);
         if (!tag.isNull() && tag->valid() && !isSpecialTag(tag)) {
             assignableTags << tag;
         }
     }
 
    CompareWithOtherTagFunctor comparer(currentlySelectedTag);
 
    bool currentTagInRemovables = !currentlySelectedTag.isNull();
    currentTagInRemovables = currentTagInRemovables
            && (std::find_if(removableTags.begin(), removableTags.end(), comparer) != removableTags.end());
 
    assignableTagsMenu = addMenu(koIcon("list-add"),i18n("Assign to tag"));
 
    if (!removableTags.isEmpty()) {
        addSeparator();
        KisTagSP currentTag = currentlySelectedTag;
 
        if (!currentTag.isNull() && currentTagInRemovables) {
            // remove the current tag from both "Remove from tag: " and "Assign to tag: " lists
            removableTags.erase(std::remove_if(removableTags.begin(),
                                               removableTags.end(),
                                               comparer),
                                removableTags.end());
            assignableTags.erase(std::remove_if(assignableTags.begin(),
                                                assignableTags.end(),
                                                comparer),
                                 assignableTags.end());
 
            SimpleExistingTagAction *removeTagAction = new SimpleExistingTagAction(resource, currentTag, this);
            removeTagAction->setText(i18n("Remove from this tag"));
            removeTagAction->setIcon(koIcon("list-remove"));
 
            connect(removeTagAction, SIGNAL(triggered(const KisTagSP, KoResourceSP)),
                    this, SLOT(removeResourceExistingTag(const KisTagSP, KoResourceSP)));
            addAction(removeTagAction);
        }
 
        if (!removableTags.isEmpty()) {
            removableTagsMenu = addMenu(koIcon("list-remove"),i18n("Remove from other tag"));
 
            KisTagSP empty;
            CompareWithOtherTagFunctor compareWithRemovable(empty);
            foreach (const KisTagSP tag, removableTags) {
 
                if (tag.isNull()) {
                    continue;
                }
 
                compareWithRemovable.setReferenceTag(tag);
                assignableTags.erase(std::remove_if(assignableTags.begin(),
                                                    assignableTags.end(),
                                                    compareWithRemovable),
                                     assignableTags.end());
 
                SimpleExistingTagAction *removeTagAction = new SimpleExistingTagAction(resource, tag, this);
 
                connect(removeTagAction, SIGNAL(triggered(const KisTagSP, KoResourceSP)),
                        this, SLOT(removeResourceExistingTag(const KisTagSP, KoResourceSP)));
                removableTagsMenu->addAction(removeTagAction);
            }
        }
 
    }
 
    foreach (const KisTagSP &tag, assignableTags) {
        if (tag.isNull()) {
            continue;
        }
 
        SimpleExistingTagAction * addTagAction = new SimpleExistingTagAction(resource, tag, this);
 
        connect(addTagAction, SIGNAL(triggered(const KisTagSP, KoResourceSP)),
                this, SLOT(addResourceExistingTag(const KisTagSP, KoResourceSP)));
 
        assignableTagsMenu->addAction(addTagAction);
    }
 
    assignableTagsMenu->addSeparator();
 
    NewTagResourceAction *addNewTagAction = new NewTagResourceAction(resource, this);
    connect(addNewTagAction, SIGNAL(triggered(QString, KoResourceSP)), m_tagChooserWidget, SLOT(addTag(QString, KoResourceSP)));
 
    assignableTagsMenu->addAction(addNewTagAction);
 
}

References addResourceExistingTag(), connect(), isSpecialTag(), koIcon, m_tagChooserWidget, m_tagModel, KisAllTagsModel::Name, removeResourceExistingTag(), CompareWithOtherTagFunctor::setReferenceTag(), KisTagResourceModel::setResourcesFilter(), KisAllTagResourceModel::Tag, KisTagModel::tagForIndex(), and KisAllTagResourceModel::TagName.

~KisResourceItemChooserContextMenu()

KisResourceItemChooserContextMenu::~KisResourceItemChooserContextMenu ( )

override

the destructor

Definition at line 150 of file KisResourceItemChooserContextMenu.cpp.

{
    delete m_tagModel;
}

References m_tagModel.

Member Function Documentation

addResourceExistingTag

void KisResourceItemChooserContextMenu::addResourceExistingTag ( const KisTagSP tag, KoResourceSP resource )

slot

addResourceExistingTag slot for a signal from the action to add the tag to the resource

Parameters

resource	resource that the tag needs to be add to
tag	tag that needs to be add to the resource

Definition at line 161 of file KisResourceItemChooserContextMenu.cpp.

{
    KisTagResourceModel tagResourceModel(resource->resourceType().first);
    tagResourceModel.tagResources(tag, QVector<int>() << resource->resourceId());
}

References KisTagResourceModel::tagResources().

removeResourceExistingTag

void KisResourceItemChooserContextMenu::removeResourceExistingTag ( const KisTagSP tag, KoResourceSP resource )

slot

removeResourceExistingTag slot for a signal from the action to remove the tag from the resource

Parameters

resource	resource that the tag needs to be removed from
tag	tag that needs to be removed from the resource

Definition at line 155 of file KisResourceItemChooserContextMenu.cpp.

{
    KisTagResourceModel tagResourceModel(resource->resourceType().first);
    tagResourceModel.untagResources(tag, QVector<int>() << resource->resourceId());
}

References KisTagResourceModel::untagResources().

resourceAssignmentToNewTagRequested

void KisResourceItemChooserContextMenu::resourceAssignmentToNewTagRequested ( const QString & tag, KoResourceSP resource )

signal

Emitted when a resource should be added to a new tag, which will need to be created.

resourceTagAdditionRequested

void KisResourceItemChooserContextMenu::resourceTagAdditionRequested ( const KisTagSP tag, KoResourceSP resource )

signal

Emitted when a resource should be added to an existing tag.

resourceTagRemovalRequested

void KisResourceItemChooserContextMenu::resourceTagRemovalRequested ( KoResourceSP resource, const KisTagSP tag )

signal

Emitted when a resource should be removed from an existing tag.

Member Data Documentation

m_tagChooserWidget

KisTagChooserWidget* KisResourceItemChooserContextMenu::m_tagChooserWidget {0}

private

Definition at line 81 of file KisResourceItemChooserContextMenu.h.

{0};

m_tagModel

KisTagModel* KisResourceItemChooserContextMenu::m_tagModel {0}

private

m_tagModel data model for tags (for tagging and untagging resources and create lists of tags)

Definition at line 80 of file KisResourceItemChooserContextMenu.h.

{0};

---

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

• libs/resourcewidgets/KisResourceItemChooserContextMenu.h
• libs/resourcewidgets/KisResourceItemChooserContextMenu.cpp