LineEditAction Class Reference

The LineEditAction class defines an action with a user text input. More...

#include <TagActions.h>

Inheritance diagram for LineEditAction:

Public Member Functions
bool	closeParentOnTrigger ()
void	setCloseParentOnTrigger (bool closeParent)
void	setIcon (const QIcon &icon)
void	setPlaceholderText (const QString &clickMessage)
void	setText (const QString &text)
void	setVisible (bool showAction)
	~LineEditAction () override

Protected Slots
virtual void	onTriggered ()
	onTriggered defines additional behaviour for the action
void	slotActionTriggered ()
	slotActionTriggered defines all behaviour expressed when the widget is triggered
QString	userText ()
	userText getter for the text inside the edit box

Protected Member Functions
	LineEditAction (QObject *parent)

Private Attributes
QPushButton *	m_AddButton
bool	m_closeParentOnTrigger
QLineEdit *	m_editBox
QLabel *	m_label

Detailed Description

The LineEditAction class defines an action with a user text input.

A line edit QWidgetAction. Default behavior: Closes its parent upon triggering. This is a base for all tag/resources actions that needs a user text input (for example create new tag or rename tag)

This is a base for all tag/resources actions that needs a user text input (for example create new tag or rename tag). By default it closes its parent upon triggering and clears the content, but it can be disabled.

Definition at line 72 of file TagActions.h.

Constructor & Destructor Documentation

LineEditAction()

LineEditAction::LineEditAction ( QObject * parent )

protected

Definition at line 49 of file TagActions.cpp.

    : QWidgetAction(parent)
    , m_closeParentOnTrigger(false)
{
    QWidget* pWidget = new QWidget (0);
    QHBoxLayout* pLayout = new QHBoxLayout();
    m_label = new QLabel(0);
    m_editBox = new KisPopupSelfActivatingLineEdit(0);
    m_editBox->setClearButtonEnabled(true);
    m_AddButton = new QPushButton();
    m_AddButton->setIcon(koIcon("list-add"));
    pLayout->addWidget(m_label);
    pLayout->addWidget(m_editBox);
    pLayout->addWidget(m_AddButton);
    pWidget->setLayout(pLayout);
    setDefaultWidget(pWidget);
 
    connect(m_editBox, &QLineEdit::returnPressed, this, &LineEditAction::slotActionTriggered);
    connect(m_AddButton, &QPushButton::clicked, this, &LineEditAction::slotActionTriggered);
 
}

References connect(), koIcon, m_AddButton, m_editBox, m_label, and slotActionTriggered().

~LineEditAction()

LineEditAction::~LineEditAction ( )

override

Definition at line 71 of file TagActions.cpp.

{
}

Member Function Documentation

closeParentOnTrigger()

bool LineEditAction::closeParentOnTrigger

(

)

Definition at line 86 of file TagActions.cpp.

{
    return m_closeParentOnTrigger;
}

References m_closeParentOnTrigger.

onTriggered

virtual void LineEditAction::onTriggered ( )

inlineprotectedvirtualslot

onTriggered defines additional behaviour for the action

This function is called in slotActionTriggered() before the widget is closed and cleared.

Definition at line 104 of file TagActions.h.

{}

setCloseParentOnTrigger()

void LineEditAction::setCloseParentOnTrigger

(

bool

closeParent

)

Definition at line 81 of file TagActions.cpp.

{
    m_closeParentOnTrigger = closeParent;
}

References m_closeParentOnTrigger.

setIcon()

void LineEditAction::setIcon

(

const QIcon &

icon

)

Definition at line 75 of file TagActions.cpp.

{
    QPixmap pixmap = QPixmap(icon.pixmap(16,16));
    m_label->setPixmap(pixmap);
}

References m_label.

setPlaceholderText()

void LineEditAction::setPlaceholderText

(

const QString &

clickMessage

)

Definition at line 106 of file TagActions.cpp.

{
    m_editBox->setPlaceholderText(clickMessage);
}

References m_editBox.

setText()

void LineEditAction::setText

(

const QString &

text

)

Definition at line 111 of file TagActions.cpp.

{
    m_editBox->setText(text);
}

References m_editBox.

setVisible()

void LineEditAction::setVisible

(

bool

showAction

)

Definition at line 116 of file TagActions.cpp.

{
    QLayout* currentLayout = defaultWidget()->layout();
 
    this->QAction::setVisible(showAction);
 
    for(int i=0;i<currentLayout->count();i++) {
        currentLayout->itemAt(i)->widget()->setVisible(showAction);
    }
    defaultWidget()->setVisible(showAction);
}

slotActionTriggered

void LineEditAction::slotActionTriggered ( )

protectedslot

slotActionTriggered defines all behaviour expressed when the widget is triggered

It contains logic for closing the widget and calls onTriggered() to make sure behaviours defined in classes inheriting LineEditAction are called.

Definition at line 92 of file TagActions.cpp.

{
    setData(userText());
    QAction::trigger();
    onTriggered();
    if (!m_editBox->text().isEmpty()) {
        if (m_closeParentOnTrigger) {
            this->parentWidget()->close();
            m_editBox->clearFocus();
            m_editBox->clear();
        }
    }
}

References m_closeParentOnTrigger, m_editBox, onTriggered(), and userText().

userText

QString LineEditAction::userText ( )

protectedslot

userText getter for the text inside the edit box

Returns

text inside edit box (user input)

Definition at line 128 of file TagActions.cpp.

{
    return m_editBox->text();
}

References m_editBox.

Member Data Documentation

m_AddButton

QPushButton* LineEditAction::m_AddButton

private

Definition at line 116 of file TagActions.h.

m_closeParentOnTrigger

bool LineEditAction::m_closeParentOnTrigger

private

Definition at line 113 of file TagActions.h.

m_editBox

QLineEdit* LineEditAction::m_editBox

private

Definition at line 115 of file TagActions.h.

m_label

QLabel* LineEditAction::m_label

private

Definition at line 114 of file TagActions.h.

---

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

• libs/resourcewidgets/TagActions.h
• libs/resourcewidgets/TagActions.cpp