KisShortcutsEditor Class Reference

Widget for configuration of KAccel and KGlobalAccel. More...

#include <KisShortcutsEditor.h>

Inheritance diagram for KisShortcutsEditor:

Public Types
enum	ActionType {   WidgetAction = Qt::WidgetShortcut , WindowAction = Qt::WindowShortcut , ApplicationAction = Qt::ApplicationShortcut , GlobalAction = 4 ,   AllActions = 0xffffffff }
enum	LetterShortcuts { LetterShortcutsDisallowed = 0 , LetterShortcutsAllowed }

Public Slots
void	allDefault ()
void	printShortcuts () const
void	resizeColumns ()
void	searchUpdated (QString s)
void	slotScrollerStateChanged (QScroller::State state)

Signals
void	keyChange ()

Public Member Functions
ActionTypes	actionTypes () const
void	addCollection (KisKActionCollection *, const QString &title=QString())
void	clearCollections ()
void	clearConfiguration ()
void	clearSearch ()
void	commit ()
void	exportConfiguration (KConfigBase *config) const
void	importConfiguration (KConfigBase *config, bool isScheme)
bool	isModified () const
	KisShortcutsEditor (QWidget *parent, ActionTypes actionTypes=AllActions, LetterShortcuts allowLetterShortcuts=LetterShortcutsAllowed)
void	save ()
void	saveShortcuts (KConfigGroup *config=0) const
void	setActionTypes (ActionTypes actionTypes)
void	undo ()
	~KisShortcutsEditor () override
	Destructor.

Properties
ActionTypes	actionTypes

Private Attributes
KisShortcutsEditorPrivate *const	d

Friends
class	KisShortcutsDialog
class	KisShortcutsEditorPrivate

Detailed Description

Widget for configuration of KAccel and KGlobalAccel.

WARNING: KisShortcutsEditor expects that the list of existing shortcuts is already free of conflicts. If it is not, nothing will crash, but your users won't like the resulting behavior.

TODO: Find the right place to check for conflicts.

Configure dictionaries of key/action associations for KActions, including global shortcuts.

The class takes care of all aspects of configuration, including handling key conflicts internally. Connect to the allDefault() slot if you want to set all configurable shortcuts to their default values.

See also

KShortcutsDialog

Author

Nicolas Hadacek hadac.nosp@m.ek@v.nosp@m.ia.ec.nosp@m.p.fr

Hamish Rodda rodda.nosp@m.@kde.nosp@m..org (KDE 4 porting)

Michael Jansen kde@m.nosp@m.icha.nosp@m.el-ja.nosp@m.nsen.nosp@m..biz

Definition at line 55 of file KisShortcutsEditor.h.

Member Enumeration Documentation

ActionType

enum KisShortcutsEditor::ActionType

Enumerator
WidgetAction	Actions which are triggered by any keypress in a widget which has the action added to it.
WindowAction	Actions which are triggered by any keypress in a window which has the action added to it or its child widget(s)
ApplicationAction	Actions which are triggered by any keypress in the application.
GlobalAction	Actions which are triggered by any keypress in the windowing system.
AllActions	All actions.

Definition at line 69 of file KisShortcutsEditor.h.

                    {
        WidgetAction      = Qt::WidgetShortcut      /*0*/,
        WindowAction      = Qt::WindowShortcut      /*1*/,
        ApplicationAction = Qt::ApplicationShortcut /*2*/,
        GlobalAction      = 4,
        AllActions        = 0xffffffff
    };

LetterShortcuts

enum KisShortcutsEditor::LetterShortcuts

Enumerator
LetterShortcutsDisallowed	Shortcuts without a modifier are not allowed, so 'A' would not be valid, whereas 'Ctrl+A' would be. This only applies to printable characters, however. 'F1', 'Insert' etc. could still be used.
LetterShortcutsAllowed	Letter shortcuts are allowed.

Definition at line 83 of file KisShortcutsEditor.h.

                         {
        LetterShortcutsDisallowed = 0,
        LetterShortcutsAllowed
    };

Constructor & Destructor Documentation

KisShortcutsEditor()

KisShortcutsEditor::KisShortcutsEditor ( QWidget * parent, ActionTypes actionTypes = AllActions, LetterShortcuts allowLetterShortcuts = LetterShortcutsAllowed )

explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Creates a key chooser without a starting action collection.

Parameters

parent	parent widget
actionTypes	types of actions to display in this widget.
allowLetterShortcuts	set to LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.

Definition at line 48 of file KisShortcutsEditor.cpp.

    : QWidget(parent)
    , d(new KisShortcutsEditorPrivate(this))
{
    d->initGUI(actionType, allowLetterShortcuts);
}

~KisShortcutsEditor()

KisShortcutsEditor::~KisShortcutsEditor ( )

override

Destructor.

Definition at line 55 of file KisShortcutsEditor.cpp.

{
    delete d;
}

References d.

Member Function Documentation

actionTypes()

KisShortcutsEditor::ActionTypes KisShortcutsEditor::actionTypes

(

)

const

Returns

The types of actions currently displayed in this widget.

Since

5.0

Definition at line 297 of file KisShortcutsEditor.cpp.

{
    return d->actionTypes;
}

References KisShortcutsEditorPrivate::actionTypes, and d.

addCollection()

void KisShortcutsEditor::addCollection	(	KisKActionCollection *	collection,
		const QString &	title = QString() )

Note: the reason this is so damn complicated is because it's supposed to support having multiple applications running inside of each other through KisParts. That means we have to be able to separate sections within each configuration file.

Insert an action collection, i.e. add all its actions to the ones already associated with the KisShortcutsEditor object.

Parameters

collection	the action collection.
title	subtree title of this collection of shortcut.

Forward this action collection to the delegate which will do conflict checking. This replaces existing collections in the delegate.

Definition at line 88 of file KisShortcutsEditor.cpp.

{
    // KXmlGui add action collections unconditionally. If some plugin doesn't
    // provide actions we don't want to create empty subgroups.
    if (collection->isEmpty()) {
        return;
    }
 
    // Pause updating.
    setUpdatesEnabled(false);
 
 
    d->actionCollections.append(collection);
    d->delegate->setCheckActionCollections(d->actionCollections);
 
 
    // Determine how we should label this collection in the widget.
    QString collectionTitle;
    if (!title.isEmpty()) {
      collectionTitle = title;
    } else {
      // Use the programName (Translated).
      collectionTitle = collection->componentDisplayName();
    }
 
    // Create the collection root node.
    QTreeWidgetItem *hierarchy[3];
    hierarchy[KisShortcutsEditorPrivate::Root] = d->ui.list->invisibleRootItem();
    hierarchy[KisShortcutsEditorPrivate::Program] =
      d->findOrMakeItem(hierarchy[KisShortcutsEditorPrivate::Root], collectionTitle);
    hierarchy[KisShortcutsEditorPrivate::Action] = 0;
 
    // Remember which actions we have seen. We will be adding categorized
    // actions first, so this will help us keep track of which actions haven't
    // been categorized yet, so we can add them as uncategorized at the end.
    QSet<QAction *> actionsSeen;
 
    // Add a subtree for each category? Perhaps easier to think that this
    // doesn't exist. Basically you add KisKActionCategory as a QObject child of
    // KisKActionCollection, and then tag objects as belonging to the category.
    foreach (KisKActionCategory *category, collection->categories()) {
 
        // Don't display empty categories.
        if (category->actions().isEmpty()) {
            continue;
        }
 
        hierarchy[KisShortcutsEditorPrivate::Action] =
          d->findOrMakeItem(hierarchy[KisShortcutsEditorPrivate::Program], category->text());
 
        // Add every item from the category.
        foreach (QAction *action, category->actions()) {
            actionsSeen.insert(action);
            d->addAction(action, hierarchy, KisShortcutsEditorPrivate::Action);
        }
 
        // Fold in each KisKActionCategory by default.
        hierarchy[KisShortcutsEditorPrivate::Action]->setExpanded(false);
 
    }
 
    // Finally, tack on any uncategorized actions.
    foreach (QAction *action, collection->actions()) {
        if (!actionsSeen.contains(action)) {
            d->addAction(action, hierarchy, KisShortcutsEditorPrivate::Program);
        }
    }
 
    // sort the list
    d->ui.list->sortItems(Name, Qt::AscendingOrder);
 
    // Now turn on updating again.
    setUpdatesEnabled(true);
 
    QTimer::singleShot(0, this, SLOT(resizeColumns()));
}

References KisShortcutsEditorPrivate::Action, KisShortcutsEditorPrivate::actionCollections, KisKActionCategory::actions(), KisKActionCollection::actions(), KisShortcutsEditorPrivate::addAction(), KisKActionCollection::categories(), KisKActionCollection::componentDisplayName(), d, KisShortcutsEditorPrivate::delegate, KisShortcutsEditorPrivate::findOrMakeItem(), KisKActionCollection::isEmpty(), Name, KisShortcutsEditorPrivate::Program, resizeColumns(), KisShortcutsEditorPrivate::Root, KisShortcutsEditorDelegate::setCheckActionCollections(), KisKActionCategory::text, and KisShortcutsEditorPrivate::ui.

allDefault

void KisShortcutsEditor::allDefault ( )

slot

Set all shortcuts to their default values (bindings).

Definition at line 276 of file KisShortcutsEditor.cpp.

{
    d->allDefault();
}

References KisShortcutsEditorPrivate::allDefault(), and d.

clearCollections()

void KisShortcutsEditor::clearCollections

(

)

Removes all action collections from the editor

Definition at line 74 of file KisShortcutsEditor.cpp.

{
    d->delegate->contractAll();
    d->ui.list->clear();
    d->actionCollections.clear();
    QTimer::singleShot(0, this, SLOT(resizeColumns()));
}

References KisShortcutsEditorPrivate::actionCollections, d, KisShortcutsEditorPrivate::delegate, resizeColumns(), and KisShortcutsEditorPrivate::ui.

clearConfiguration()

void KisShortcutsEditor::clearConfiguration

(

)

Removes all configured shortcuts.

Definition at line 169 of file KisShortcutsEditor.cpp.

{
    d->clearConfiguration();
}

References KisShortcutsEditorPrivate::clearConfiguration(), and d.

clearSearch()

void KisShortcutsEditor::clearSearch

(

)

Clears search area

Definition at line 82 of file KisShortcutsEditor.cpp.

{
    d->ui.searchFilter->searchLine()->clear();
}

References d, and KisShortcutsEditorPrivate::ui.

commit()

void KisShortcutsEditor::commit

(

)

Update the dialog entries without saving.

Since

4.2

Definition at line 251 of file KisShortcutsEditor.cpp.

{
    for (QTreeWidgetItemIterator it(d->ui.list); (*it); ++it) {
        if (KisShortcutsEditorItem *item = dynamic_cast<KisShortcutsEditorItem *>(*it)) {
            item->commit();
        }
    }
}

References d, and KisShortcutsEditorPrivate::ui.

exportConfiguration()

void KisShortcutsEditor::exportConfiguration

(

KConfigBase *

config

)

const

Write the current shortcuts to a new scheme to configuration file

Parameters

config

Config object to save to.

Definition at line 204 of file KisShortcutsEditor.cpp.

{
    Q_ASSERT(config);
    if (!config) {
        return;
    }
 
    if (d->actionTypes) {
        KConfigGroup group(config,QStringLiteral("Shortcuts"));
        foreach (KisKActionCollection *collection, d->actionCollections) {
            collection->writeSettings(&group, true);
        }
    }
 
    KisActionRegistry::instance()->notifySettingsUpdated();
}

References KisShortcutsEditorPrivate::actionCollections, KisShortcutsEditorPrivate::actionTypes, d, KisActionRegistry::instance(), KisActionRegistry::notifySettingsUpdated(), and KisKActionCollection::writeSettings().

importConfiguration()

void KisShortcutsEditor::importConfiguration	(	KConfigBase *	config,
		bool	isScheme )

Import a shortcut configuration file.

Parameters

config	Config object to load from.
isScheme	true for shortcut scheme, false for custom shortcuts

Definition at line 174 of file KisShortcutsEditor.cpp.

{
    Q_ASSERT(config);
    if (!config) {
        return;
    }
 
    // If this is a shortcut scheme, apply it
    if (isScheme) {
        KisActionRegistry::instance()->applyShortcutScheme(config);
    }
 
    // Update the dialog entry items
    const KConfigGroup schemeShortcuts(config, QStringLiteral("Shortcuts"));
    for (QTreeWidgetItemIterator it(d->ui.list); (*it); ++it) {
 
        if (!(*it)->parent()) {
            continue;
        }
        KisShortcutsEditorItem *item = static_cast<KisShortcutsEditorItem *>(*it);
        const QString actionId = item->data(Id).toString();
        if (!schemeShortcuts.hasKey(actionId))
            continue;
 
        QList<QKeySequence> sc = QKeySequence::listFromString(schemeShortcuts.readEntry(actionId, QString()));
        d->changeKeyShortcut(item, LocalPrimary, primarySequence(sc));
        d->changeKeyShortcut(item, LocalAlternate, alternateSequence(sc));
    }
}

References alternateSequence(), KisActionRegistry::applyShortcutScheme(), KisShortcutsEditorPrivate::changeKeyShortcut(), d, KisShortcutsEditorItem::data(), Id, KisActionRegistry::instance(), LocalAlternate, LocalPrimary, primarySequence(), and KisShortcutsEditorPrivate::ui.

isModified()

bool KisShortcutsEditor::isModified

(

)

const

Returns

true if there are unsaved changes.

Definition at line 60 of file KisShortcutsEditor.cpp.

{
    // Iterate over all items
    QTreeWidgetItemIterator it(d->ui.list, QTreeWidgetItemIterator::NoChildren);
 
    for (; (*it); ++it) {
        KisShortcutsEditorItem *item = dynamic_cast<KisShortcutsEditorItem *>(*it);
        if (item && item->isModified()) {
            return true;
        }
    }
    return false;
}

References d, KisShortcutsEditorItem::isModified(), and KisShortcutsEditorPrivate::ui.

keyChange

void KisShortcutsEditor::keyChange ( )

signal

Emitted when an action's shortcut has been changed.

printShortcuts

void KisShortcutsEditor::printShortcuts ( ) const

slot

Opens a printing dialog to print all the shortcuts

Definition at line 281 of file KisShortcutsEditor.cpp.

{
    d->printShortcuts();
}

References d, and KisShortcutsEditorPrivate::printShortcuts().

resizeColumns

void KisShortcutsEditor::resizeColumns ( )

slot

Resize columns to width required

Definition at line 241 of file KisShortcutsEditor.cpp.

{
    for (int i = 0; i < d->ui.list->columnCount(); i++) {
        d->ui.list->resizeColumnToContents(i);
    }
}

References d, and KisShortcutsEditorPrivate::ui.

save()

void KisShortcutsEditor::save

(

)

Save the changes.

Before saving the changes are committed. This saves the actions to disk. Any KisKActionCollection objects with the xmlFile() value set will be written to an XML file. All other will be written to the application's rc file.

Definition at line 260 of file KisShortcutsEditor.cpp.

{
    saveShortcuts();
    commit(); // Not doing this would be bad
}

References commit(), and saveShortcuts().

saveShortcuts()

void KisShortcutsEditor::saveShortcuts

(

KConfigGroup *

config = 0

)

const

Write the current custom shortcut settings to the config object.

Parameters

config

Config object to save to. Default is kritashortcutsrc.

Definition at line 221 of file KisShortcutsEditor.cpp.

{
    // This is a horrible mess with pointers...
    KConfigGroup cg;
    if (config == 0) {
        cg = KConfigGroup(KSharedConfig::openConfig("kritashortcutsrc"),
                          QStringLiteral("Shortcuts"));
        config = &cg;
    }
 
    // Clear and reset temporary shortcuts
    config->deleteGroup();
    foreach (KisKActionCollection *collection, d->actionCollections) {
        collection->writeSettings(config, false);
    }
 
    KisActionRegistry::instance()->notifySettingsUpdated();
}

References KisShortcutsEditorPrivate::actionCollections, d, KisActionRegistry::instance(), KisActionRegistry::notifySettingsUpdated(), and KisKActionCollection::writeSettings().

searchUpdated

void KisShortcutsEditor::searchUpdated ( QString s )

slot

Expand or collapse the tree view when the search text changes

Definition at line 286 of file KisShortcutsEditor.cpp.

{
    if (s.isEmpty()) {
        // Reset the tree area
        d->ui.list->collapseAll();
        d->ui.list->expandToDepth(0);
    } else {
        d->ui.list->expandAll();
    }
}

References d, and KisShortcutsEditorPrivate::ui.

setActionTypes()

void KisShortcutsEditor::setActionTypes

(

ActionTypes

actionTypes

)

Sets the types of actions to display in this widget.

Parameters

actionTypes

New types of actions

Since

5.0

Definition at line 302 of file KisShortcutsEditor.cpp.

{
    d->setActionTypes(actionTypes);
}

References actionTypes, d, and KisShortcutsEditorPrivate::setActionTypes().

slotScrollerStateChanged

void KisShortcutsEditor::slotScrollerStateChanged ( QScroller::State state )

inlineslot

Definition at line 230 of file KisShortcutsEditor.h.

{KisKineticScroller::updateCursor(this, state);}

References KisKineticScroller::updateCursor().

undo()

void KisShortcutsEditor::undo

(

)

Undo all change made since the last commit().

Definition at line 266 of file KisShortcutsEditor.cpp.

{
    // TODO: is this working?
    for (QTreeWidgetItemIterator it(d->ui.list); (*it); ++it) {
        if (KisShortcutsEditorItem *item = dynamic_cast<KisShortcutsEditorItem *>(*it)) {
            item->undo();
        }
    }
}

References d, and KisShortcutsEditorPrivate::ui.

Friends And Related Symbol Documentation

KisShortcutsDialog

friend class KisShortcutsDialog

friend

Definition at line 236 of file KisShortcutsEditor.h.

KisShortcutsEditorPrivate

friend class KisShortcutsEditorPrivate

friend

Definition at line 237 of file KisShortcutsEditor.h.

Member Data Documentation

d

KisShortcutsEditorPrivate* const KisShortcutsEditor::d

private

Definition at line 238 of file KisShortcutsEditor.h.

Property Documentation

actionTypes

ActionTypes KisShortcutsEditor::actionTypes

readwrite

Definition at line 58 of file KisShortcutsEditor.h.

---

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

• libs/widgetutils/xmlgui/KisShortcutsEditor.h
• libs/widgetutils/xmlgui/KisShortcutsEditor.cpp