KisInputProfile Class Reference

A container class for sets of shortcuts associated with an action. More...

#include <kis_input_profile.h>

Inheritance diagram for KisInputProfile:

Classes
class	Private

Public Slots
void	setName (const QString &name)

Signals
void	nameChanged ()

Public Member Functions
void	addShortcut (KisShortcutConfiguration *shortcut)
QList< KisShortcutConfiguration * >	allShortcuts () const
	KisInputProfile (QObject *parent=0)
QString	name () const
void	removeShortcut (KisShortcutConfiguration *shortcut)
QList< KisShortcutConfiguration * >	shortcutsForAction (KisAbstractInputAction *action) const
	~KisInputProfile () override

Private Attributes
Private *const	d

Detailed Description

A container class for sets of shortcuts associated with an action.

Definition at line 21 of file kis_input_profile.h.

Constructor & Destructor Documentation

KisInputProfile()

KisInputProfile::KisInputProfile

(

QObject *

parent = 0

)

Constructor.

Definition at line 28 of file kis_input_profile.cpp.

    : QObject(parent), d(new Private())
{
 
}

~KisInputProfile()

KisInputProfile::~KisInputProfile ( )

override

Destructor.

Definition at line 34 of file kis_input_profile.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addShortcut()

void KisInputProfile::addShortcut

(

KisShortcutConfiguration *

shortcut

)

Add a shortcut to this profile.

Parameters

shortcut

The shortcut to add.

Definition at line 65 of file kis_input_profile.cpp.

{
    Q_ASSERT(shortcut);
    Q_ASSERT(shortcut->action());
    d->shortcuts.insert(shortcut->action(), shortcut);
}

References KisShortcutConfiguration::action(), d, and KisInputProfile::Private::shortcuts.

allShortcuts()

QList< KisShortcutConfiguration * > KisInputProfile::allShortcuts

(

)

const

Returns

A list of all shortcuts available.

Definition at line 51 of file kis_input_profile.cpp.

{
    return d->shortcuts.values();
}

References d, and KisInputProfile::Private::shortcuts.

name()

QString KisInputProfile::name

(

)

const

Returns

The name of the profile.

Definition at line 39 of file kis_input_profile.cpp.

{
    return d->name;
}

References d, and KisInputProfile::Private::name.

nameChanged

void KisInputProfile::nameChanged ( )

signal

Emitted when the name of this profile changes.

removeShortcut()

void KisInputProfile::removeShortcut

(

KisShortcutConfiguration *

shortcut

)

Remove a shortcut from this profile.

Parameters

shortcut

The shortcut to remove.

Definition at line 72 of file kis_input_profile.cpp.

{
    Q_ASSERT(shortcut);
    Q_ASSERT(shortcut->action());
    d->shortcuts.remove(shortcut->action(), shortcut);
}

References KisShortcutConfiguration::action(), d, and KisInputProfile::Private::shortcuts.

setName

void KisInputProfile::setName ( const QString & name )

slot

Set the name of this profile.

Parameters

name	The name to set.

Definition at line 43 of file kis_input_profile.cpp.

{
    if (d->name != name) {
        d->name = name;
        Q_EMIT nameChanged();
    }
}

References d, KisInputProfile::Private::name, name(), and nameChanged().

shortcutsForAction()

QList< KisShortcutConfiguration * > KisInputProfile::shortcutsForAction

(

KisAbstractInputAction *

action

)

const

Returns

A list of shortcuts associated with the given action.

Parameters

action

The action for which to list the shortcuts.

Definition at line 56 of file kis_input_profile.cpp.

{
    if (d->shortcuts.contains(action)) {
        return d->shortcuts.values(action);
    }
 
    return QList<KisShortcutConfiguration *>();
}

References d, and KisInputProfile::Private::shortcuts.

Member Data Documentation

d

Private* const KisInputProfile::d

private

Definition at line 80 of file kis_input_profile.h.

---

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

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