KisSelectLayerAction Class Reference

Select Layer implementation of KisAbstractInputAction. More...

#include <kis_select_layer_action.h>

Inheritance diagram for KisSelectLayerAction:

Classes
class	Private

Public Types
enum	LayerSelectionMode { LayerSelectionMode_TopLayer , LayerSelectionMode_AllLayers , LayerSelectionMode_Ask }
enum	SelectionOverrideMode { SelectionOverrideMode_Replace , SelectionOverrideMode_Add }

Public Member Functions
void	activate (int shortcut) override
void	begin (int shortcut, QEvent *event) override
void	deactivate (int shortcut) override
void	inputEvent (QEvent *event) override
	KisSelectLayerAction ()
int	priority () const override
	~KisSelectLayerAction () override
Public Member Functions inherited from KisAbstractInputAction
virtual bool	canIgnoreModifiers () const
virtual QString	description () const
virtual void	end (QEvent *event)
virtual QString	id () const
virtual KisInputActionGroup	inputActionGroup (int shortcut) const
virtual bool	isAvailable () const
virtual bool	isShortcutRequired (int shortcut) const
	KisAbstractInputAction (const QString &id)
virtual QString	name () const
virtual QHash< QString, int >	shortcutIndexes () const
virtual bool	supportsHiResInputEvents (int shortcut) const
virtual	~KisAbstractInputAction ()

Private Attributes
Private *const	d

Additional Inherited Members
Public Attributes inherited from KisAbstractInputAction
QString	description
QString	id
QHash< QString, int >	indexes
QPointF	lastCursorPosition
QString	name
QPointF	startCursorPosition
Static Public Attributes inherited from KisAbstractInputAction
static KisInputManager *	inputManager
Protected Member Functions inherited from KisAbstractInputAction
virtual void	cursorMoved (const QPointF &lastPos, const QPointF &pos)
virtual void	cursorMovedAbsolute (const QPointF &startPos, const QPointF &pos)
QPoint	eventPos (const QEvent *event)
QPointF	eventPosF (const QEvent *event)
KisInputManager *	inputManager () const
void	setDescription (const QString &description)
void	setName (const QString &name)
void	setShortcutIndexes (const QHash< QString, int > &indexes)

Detailed Description

Select Layer implementation of KisAbstractInputAction.

The Select Layer action selects a layer under a cursor.

Definition at line 17 of file kis_select_layer_action.h.

Member Enumeration Documentation

LayerSelectionMode

enum KisSelectLayerAction::LayerSelectionMode

Enumerator
LayerSelectionMode_TopLayer
LayerSelectionMode_AllLayers
LayerSelectionMode_Ask

Definition at line 20 of file kis_select_layer_action.h.

    {
        LayerSelectionMode_TopLayer,
        LayerSelectionMode_AllLayers,
        LayerSelectionMode_Ask
    };

SelectionOverrideMode

enum KisSelectLayerAction::SelectionOverrideMode

Enumerator
SelectionOverrideMode_Replace
SelectionOverrideMode_Add

Definition at line 27 of file kis_select_layer_action.h.

    {
        SelectionOverrideMode_Replace,
        SelectionOverrideMode_Add
    };

Constructor & Destructor Documentation

KisSelectLayerAction()

KisSelectLayerAction::KisSelectLayerAction ( )

explicit

Definition at line 112 of file kis_select_layer_action.cpp.

    : KisAbstractInputAction("Select Layer")
    , d(new Private(this))
{
    setName(i18n("Select Layer"));
    setDescription(i18n("Select layers under the cursor position"));
 
    QHash<QString, int> shortcuts;
    shortcuts.insert(i18n("Select Top Layer (Replace Selection)"),
                     d->makeShortcut(LayerSelectionMode_TopLayer, SelectionOverrideMode_Replace));
    shortcuts.insert(i18n("Select All Layers (Replace Selection)"),
                     d->makeShortcut(LayerSelectionMode_AllLayers, SelectionOverrideMode_Replace));
    shortcuts.insert(i18n("Select from Menu (Replace Selection)"),
                     d->makeShortcut(LayerSelectionMode_Ask, SelectionOverrideMode_Replace));
    shortcuts.insert(i18n("Select Top Layer (Add to Selection)"),
                     d->makeShortcut(LayerSelectionMode_TopLayer, SelectionOverrideMode_Add));
    shortcuts.insert(i18n("Select All Layers (Add to Selection)"),
                     d->makeShortcut(LayerSelectionMode_AllLayers, SelectionOverrideMode_Add));
    shortcuts.insert(i18n("Select from Menu (Add to Selection)"),
                     d->makeShortcut(LayerSelectionMode_Ask, SelectionOverrideMode_Add));
    setShortcutIndexes(shortcuts);
}

References d, LayerSelectionMode_AllLayers, LayerSelectionMode_Ask, LayerSelectionMode_TopLayer, KisSelectLayerAction::Private::makeShortcut(), SelectionOverrideMode_Add, SelectionOverrideMode_Replace, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), and KisAbstractInputAction::setShortcutIndexes().

~KisSelectLayerAction()

KisSelectLayerAction::~KisSelectLayerAction ( )

override

Definition at line 135 of file kis_select_layer_action.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activate()

void KisSelectLayerAction::activate ( int shortcut )

overridevirtual

The method is called when the action is yet to be started, that is, e.g. the user has pressed all the modifiers for the action but hasn't started painting yet. This method is a right place to show the user what is going to happen, e.g. change the cursor.

Reimplemented from KisAbstractInputAction.

Definition at line 145 of file kis_select_layer_action.cpp.

{
    Q_UNUSED(shortcut);
    QApplication::setOverrideCursor(KisCursor::pickLayerCursor());
}

References KisCursor::pickLayerCursor().

begin()

void KisSelectLayerAction::begin ( int shortcut, QEvent * event )

overridevirtual

Begin the action.

Parameters

shortcut	The index of the behaviour to trigger.
event	The mouse event that has triggered this action. Is null for keyboard-activated actions.

Reimplemented from KisAbstractInputAction.

Definition at line 157 of file kis_select_layer_action.cpp.

{
    KisAbstractInputAction::begin(shortcut, event);
 
    d->shortcut = shortcut;
    inputEvent(event);
}

References KisAbstractInputAction::begin(), d, inputEvent(), and KisSelectLayerAction::Private::shortcut.

deactivate()

void KisSelectLayerAction::deactivate ( int shortcut )

overridevirtual

The method is called when the action is not a candidate for the starting anymore. The action should revert everything that was done in activate() method.

See also

activate()

Reimplemented from KisAbstractInputAction.

Definition at line 151 of file kis_select_layer_action.cpp.

{
    Q_UNUSED(shortcut);
    QApplication::restoreOverrideCursor();
}

inputEvent()

void KisSelectLayerAction::inputEvent ( QEvent * event )

overridevirtual

Process an input event.

By default handles MouseMove events and passes the data to a convenience cursorMoved() method

Parameters

event

An event to process.

Reimplemented from KisAbstractInputAction.

Definition at line 165 of file kis_select_layer_action.cpp.

{
    // Event not recognized
    if (!event || (event->type() != QEvent::MouseMove && event->type() != QEvent::TabletMove &&
                   event->type() != QTouchEvent::TouchUpdate && event->type() != QEvent::MouseButtonPress &&
                   event->type() != QEvent::TabletPress && event->type() != QTouchEvent::TouchBegin)) {
        return;
    }
 
    const int layerSelectionMode = d->layerSelectionMode(d->shortcut);
    const int selectionOverrideMode = d->selectionOverrideMode(d->shortcut);
 
    // Shortcut not recognized
    KIS_SAFE_ASSERT_RECOVER_RETURN(
        (layerSelectionMode == LayerSelectionMode_TopLayer ||
         layerSelectionMode == LayerSelectionMode_AllLayers ||
         layerSelectionMode == LayerSelectionMode_Ask) &&
        (selectionOverrideMode == SelectionOverrideMode_Replace ||
         selectionOverrideMode == SelectionOverrideMode_Add)
    );
 
    QPoint pos =
        inputManager()->canvas()->
        coordinatesConverter()->widgetToImage(eventPosF(event)).toPoint();
 
    // First make a list with the nodes to be selected
    KisNodeList nodesToSelect;
 
    if (layerSelectionMode == LayerSelectionMode_TopLayer) {
        KisNodeSP foundNode = KisToolUtils::findNode(inputManager()->canvas()->image()->root(), pos, false);
        if (!foundNode) {
            return;
        }
        nodesToSelect.append(foundNode);
    } else {
        // Retrieve group nodes only if the mode is LayerSelectionMode_Ask
        const KisNodeList foundNodes = KisToolUtils::findNodes(
                                            inputManager()->canvas()->image()->root()->firstChild(),
                                            pos, false, layerSelectionMode == LayerSelectionMode_Ask);
 
        if (foundNodes.isEmpty()) {
            return;
        }
 
        if (layerSelectionMode == LayerSelectionMode_AllLayers) {
            nodesToSelect = foundNodes;
        } else { //LayerSelectionMode_Ask
            QWidget *canvasWidget = inputManager()->canvas()->canvasWidget();
            QMenu *menu = new QMenu(canvasWidget);
            menu->setAttribute(Qt::WA_DeleteOnClose);
            int numberOfLayers = 0;
 
            // Traverse the list in reverse order so that the menu entries order
            // resembles that of the layer stack
            for (int i = foundNodes.size() - 1; i >= 0; --i) {
                KisNodeSP node = foundNodes[i];
                int indentation = -1;
                {
                    KisNodeSP tempNode = node;
                    while (tempNode->parent()) {
                        ++indentation;
                        tempNode = tempNode->parent();
                    }
                }
                QAction *action = menu->addAction(QString(4 * indentation, ' ') + node->name());
                QObject::connect(action, &QAction::triggered,
                    [this, node, selectionOverrideMode]()
                    {
                        d->selectNode(node, selectionOverrideMode);
                    }
                );
                if (!dynamic_cast<KisGroupLayer*>(node.data())) {
                    ++numberOfLayers;
                }
            }
 
            // Add separator
            menu->addSeparator();
 
            // Add "select all layers" menu item
            {
                QAction *action = menu->addAction(i18nc("Menu entry for the select layer under cursor canvas input action",
                                                        "Select all layers"));
                action->setVisible(numberOfLayers > 1);
                QObject::connect(action, &QAction::triggered,
                    [this, foundNodes, selectionOverrideMode]()
                    {
                        d->selectNodes(foundNodes, selectionOverrideMode, false);
                    }
                );
            }
 
            menu->popup(canvasWidget->mapToGlobal(eventPos(event)));
            return;
        }
    }
 
    // Now select the nodes
    d->selectNodes(nodesToSelect, selectionOverrideMode, true);
}

References Private::canvas, KisInputManager::canvas(), KisCanvas2::canvasWidget, d, KisSharedPtr< T >::data(), KisAbstractInputAction::eventPos(), KisAbstractInputAction::eventPosF(), KisToolUtils::findNode(), KisToolUtils::findNodes(), KisAbstractInputAction::inputManager, KIS_SAFE_ASSERT_RECOVER_RETURN, KisSelectLayerAction::Private::layerSelectionMode(), LayerSelectionMode_AllLayers, LayerSelectionMode_Ask, LayerSelectionMode_TopLayer, KisBaseNode::name(), KisNode::parent, KisSelectLayerAction::Private::selectionOverrideMode(), SelectionOverrideMode_Add, SelectionOverrideMode_Replace, KisSelectLayerAction::Private::selectNode(), KisSelectLayerAction::Private::selectNodes(), and KisSelectLayerAction::Private::shortcut.

priority()

int KisSelectLayerAction::priority ( ) const

overridevirtual

The priority for this action.

Priority determines how "important" the action is and is used to resolve conflicts when multiple actions can be activated.

Reimplemented from KisAbstractInputAction.

Definition at line 140 of file kis_select_layer_action.cpp.

{
    return 5;
}

Member Data Documentation

d

Private* const KisSelectLayerAction::d

private

Definition at line 46 of file kis_select_layer_action.h.

---

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

• libs/ui/input/kis_select_layer_action.h
• libs/ui/input/kis_select_layer_action.cpp