KisTagToolButton Class Reference

The KisTagToolButton class manages the logic of the tag management popup. More...

#include <KisTagToolButton.h>

Inheritance diagram for KisTagToolButton:

Classes
class	Private

Signals
void	deletionOfCurrentTagRequested ()
	deletionOfCurrentTagRequested signals to KisTagChooserWidget to delete the current tag
void	newTagRequested (const QString &tagName)
	newTagRequested signals to the KisTagChooserWidget to create a new tag
void	popupMenuAboutToShow ()
	popupMenuAboutToShow signals that the tags popup will be shown soon.
void	renamingOfCurrentTagRequested (const QString &tagName)
	renamingOfCurrentTagRequested signals to KisTagChooserWidget to rename the current tag
void	undeletionOfTagRequested (const KisTagSP tag)
	undeletionOfTagRequested signals to KisTagChooserWidget to undelete the mentioned tag

Private Slots
void	onTagUndeleteClicked ()
	onTagUndeleteClicked is called when the user

Private Member Functions
	KisTagToolButton (QWidget *parent=0)
void	loadIcon ()
	updates icon file when loading and changing themes
void	readOnlyMode (bool activate)
	readOnlyMode sets the mode of the popup
void	setCurrentTag (const KisTagSP tag)
void	setUndeletionCandidate (const KisTagSP deletedTag)
	setUndeletionCandidate sets a new item in the deleted tags list
KisTagSP	undeletionCandidate () const
	~KisTagToolButton () override

Private Attributes
Private *const	d

Friends
class	KisTagChooserWidget

Detailed Description

The KisTagToolButton class manages the logic of the tag management popup.

This class is responsible for the GUI for creating, renaming and removing tags. Since both renaming and removing is context-dependent (it depends on which tag is currently selected in the combobox), all actions Q_EMIT signals to the TagChooserWidget for it to handle actual creating, renaming and removal of tags in the KisTagModel.

Definition at line 32 of file KisTagToolButton.h.

Constructor & Destructor Documentation

KisTagToolButton()

KisTagToolButton::KisTagToolButton ( QWidget * parent = 0 )

explicitprivate

Definition at line 44 of file KisTagToolButton.cpp.

    : QWidget(parent)
    , d(new Private())
{
    QGridLayout* buttonLayout = new QGridLayout(this);
    buttonLayout->setContentsMargins(0, 0, 0, 0);
    buttonLayout->setSpacing(0);
 
    d->tagToolButton = new QToolButton(this);
    loadIcon();
    d->tagToolButton->setText(i18n("Tag"));
    d->tagToolButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    d->tagToolButton->setToolTip(i18nc("@info:tooltip", "<qt>Show the tag box options.</qt>"));
    d->tagToolButton->setPopupMode(QToolButton::InstantPopup);
    d->tagToolButton->setEnabled(true);
 
    QMenu* popup = new QMenu(this);
 
    KisMenuStyleDontCloseOnAlt *menuStyle = new KisMenuStyleDontCloseOnAlt(popup->style());
    menuStyle->setParent(popup);
    popup->setStyle(menuStyle);
 
    d->addTagAction = new UserInputTagAction(popup);
    d->addTagAction->setPlaceholderText(i18n("New tag"));
    d->addTagAction->setIcon(koIcon("document-new"));
    d->addTagAction->setCloseParentOnTrigger(true);
    popup->addAction(d->addTagAction);
 
    connect(d->addTagAction, SIGNAL(triggered(QString)), this, SIGNAL(newTagRequested(QString)));
 
    d->renameTagAction = new UserInputTagAction(popup);
    d->renameTagAction->setPlaceholderText(i18n("Rename tag"));
    d->renameTagAction->setIcon(koIcon("edit-rename"));
    d->renameTagAction->setCloseParentOnTrigger(true);
    popup->addAction(d->renameTagAction);
 
    connect(d->renameTagAction, SIGNAL(triggered(QString)), this, SIGNAL(renamingOfCurrentTagRequested(QString)));
 
    popup->addSeparator();
 
    d->deleteTagAction = new QAction(popup);
    d->deleteTagAction->setText(i18n("Delete this tag"));
    d->deleteTagAction->setIcon(koIcon("edit-delete"));
    popup->addAction(d->deleteTagAction);
 
    connect(d->deleteTagAction, SIGNAL(triggered()), this, SIGNAL(deletionOfCurrentTagRequested()));
 
    popup->addSeparator();
 
    d->undeleteTagAction = new QAction(popup);
    d->undeleteTagAction->setIcon(koIcon("edit-redo"));
    d->undeleteTagAction->setVisible(false);
    popup->addAction(d->undeleteTagAction);
 
    connect(d->undeleteTagAction, SIGNAL(triggered()), this, SLOT(onTagUndeleteClicked()));
 
    connect(popup, SIGNAL(aboutToShow()), this, SIGNAL(popupMenuAboutToShow()));
 
    d->tagToolButton->setMenu(popup);
    buttonLayout->addWidget(d->tagToolButton);
}

References KisTagToolButton::Private::addTagAction, connect(), d, KisTagToolButton::Private::deleteTagAction, deletionOfCurrentTagRequested(), koIcon, loadIcon(), newTagRequested(), onTagUndeleteClicked(), popupMenuAboutToShow(), KisTagToolButton::Private::renameTagAction, renamingOfCurrentTagRequested(), LineEditAction::setCloseParentOnTrigger(), LineEditAction::setIcon(), LineEditAction::setPlaceholderText(), KisTagToolButton::Private::tagToolButton, and KisTagToolButton::Private::undeleteTagAction.

~KisTagToolButton()

KisTagToolButton::~KisTagToolButton ( )

overrideprivate

Definition at line 106 of file KisTagToolButton.cpp.

{
    delete d;
}

References d.

Member Function Documentation

deletionOfCurrentTagRequested

void KisTagToolButton::deletionOfCurrentTagRequested ( )

signal

deletionOfCurrentTagRequested signals to KisTagChooserWidget to delete the current tag

Since KisTagToolButton doesn't know which tag is current or which KisTagModel it should be using, it signals KisTagChooserWidget to do remove the current tag.

loadIcon()

void KisTagToolButton::loadIcon ( )

private

updates icon file when loading and changing themes

Definition at line 141 of file KisTagToolButton.cpp.

{
    d->tagToolButton->setIcon(koIcon("bookmarks"));
}

References d, koIcon, and KisTagToolButton::Private::tagToolButton.

newTagRequested

void KisTagToolButton::newTagRequested ( const QString & tagName )

signal

newTagRequested signals to the KisTagChooserWidget to create a new tag

Parameters

tag	tag name written by the user (other fields are not used)

Since KisTagToolButton doesn't know which KisTagModel it should be using (because it doesn't know the resourceType) and for the consistency, it signals KisTagChooserWidget to create a new tag with the name written by the user.

onTagUndeleteClicked

void KisTagToolButton::onTagUndeleteClicked ( )

privateslot

onTagUndeleteClicked is called when the user

Definition at line 146 of file KisTagToolButton.cpp.

{
    Q_EMIT undeletionOfTagRequested(d->undeleteCandidate);
}

References d, KisTagToolButton::Private::undeleteCandidate, and undeletionOfTagRequested().

popupMenuAboutToShow

void KisTagToolButton::popupMenuAboutToShow ( )

signal

popupMenuAboutToShow signals that the tags popup will be shown soon.

It is used by

See also

KisTagChooserWidget

readOnlyMode()

void KisTagToolButton::readOnlyMode ( bool activate )

private

readOnlyMode sets the mode of the popup

If the mode is read-only, then renaming and removal of the tag is not accessible (the textbox and the buttons are hidden).

Parameters

activate

if true, then the popup is in the read-only mode.

Definition at line 111 of file KisTagToolButton.cpp.

{
    activate = !activate;
    d->renameTagAction->setVisible(activate);
    d->deleteTagAction->setVisible(activate);
}

References d, KisTagToolButton::Private::deleteTagAction, KisTagToolButton::Private::renameTagAction, and LineEditAction::setVisible().

renamingOfCurrentTagRequested

void KisTagToolButton::renamingOfCurrentTagRequested ( const QString & tagName )

signal

renamingOfCurrentTagRequested signals to KisTagChooserWidget to rename the current tag

Parameters

tag	tag name written by the user (other fields are not used)

Since KisTagToolButton doesn't know which tag is current or which KisTagModel it should be using, it signals KisTagChooserWidget to do rename the current tag to the name written by the user.

setCurrentTag()

void KisTagToolButton::setCurrentTag ( const KisTagSP tag )

private

Definition at line 135 of file KisTagToolButton.cpp.

{
    d->currentTag = tag;
    d->deleteTagAction->setProperty("currentTag", QVariant::fromValue<KisTagSP>(tag));
}

References KisTagToolButton::Private::currentTag, d, and KisTagToolButton::Private::deleteTagAction.

setUndeletionCandidate()

void KisTagToolButton::setUndeletionCandidate ( const KisTagSP deletedTag )

private

setUndeletionCandidate sets a new item in the deleted tags list

Tags are never deleted fully, they are only marked inactive. Undeletion means marking them as active again. This function adds new tags for the user to be able to undelete them (mark active in the database).

Parameters

deletedTag

tag that can be undeleted (activated again)

Definition at line 118 of file KisTagToolButton.cpp.

{
    if (deletedTag.isNull() || deletedTag->name().isEmpty()) {
        d->undeleteTagAction->setVisible(false);
        d->undeleteCandidate.clear();
    } else {
        d->undeleteCandidate = deletedTag;
        d->undeleteTagAction->setText(i18n("Undelete") +" "+ deletedTag->name());
        d->undeleteTagAction->setVisible(true);
    }
}

References d, KisTagToolButton::Private::undeleteCandidate, and KisTagToolButton::Private::undeleteTagAction.

undeletionCandidate()

KisTagSP KisTagToolButton::undeletionCandidate ( ) const

private

Definition at line 130 of file KisTagToolButton.cpp.

{
    return d->undeleteCandidate;
}

References d, and KisTagToolButton::Private::undeleteCandidate.

undeletionOfTagRequested

void KisTagToolButton::undeletionOfTagRequested ( const KisTagSP tag )

signal

undeletionOfTagRequested signals to KisTagChooserWidget to undelete the mentioned tag

Parameters

tag	tag to be undeleted (marked active again)

Tags are never deleted fully, they are only marked inactive. Undeletion means marking them as active again. This function signals to KisTagChooserWidget that a tag mentioned in the argument should be activated.

Friends And Related Symbol Documentation

KisTagChooserWidget

friend class KisTagChooserWidget

friend

Definition at line 116 of file KisTagToolButton.h.

Member Data Documentation

d

Private* const KisTagToolButton::d

private

Definition at line 115 of file KisTagToolButton.h.

---

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

• libs/resourcewidgets/KisTagToolButton.h
• libs/resourcewidgets/KisTagToolButton.cpp