#include <KisShortcutsDialog.h>

Inheritance diagram for KisShortcutsDialog:

Classes
class	KisShortcutsDialogPrivate

Public Member Functions
QList< KisKActionCollection * >	actionCollections () const

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

void	allDefault ()

void	exportConfiguration (const QString &path) const

void	importConfiguration (const QString &path)

	KisShortcutsDialog (KisShortcutsEditor::ActionTypes types=defaultActionTypes, KisShortcutsEditor::LetterShortcuts allowLetterShortcuts=KisShortcutsEditor::LetterShortcutsAllowed, QWidget *parent=0)

void	loadCustomShortcuts (const QString &path)

void	save ()

void	saveCustomShortcuts (const QString &path) const

QSize	sizeHint () const override

void	undo ()

	~KisShortcutsDialog () override

Private Attributes
class KisShortcutsDialogPrivate *const	d

Detailed Description

Definition at line 86 of file KisShortcutsDialog.h.

Constructor & Destructor Documentation

◆ KisShortcutsDialog()

KisShortcutsDialog::KisShortcutsDialog	(	KisShortcutsEditor::ActionTypes	types = defaultActionTypes,
		KisShortcutsEditor::LetterShortcuts	allowLetterShortcuts = KisShortcutsEditor::LetterShortcutsAllowed,
		QWidget *	parent = 0 )

explicit

Constructs a KisShortcutsDialog. Mostly UI boilerplate.

Parameters

types	the action types
allowLetterShortcuts	set to KisShortcutsEditor::LetterShortcutsDisallowed if unmodified alphanumeric keys ('A', '1', etc.) are not permissible shortcuts.
parent	the parent widget to attach to

There is some legacy support for global (i.e. desktop-wide) shortcuts that should probably be removed.

Definition at line 38 of file KisShortcutsDialog.cpp.

    : QWidget(parent)
    , d(new KisShortcutsDialogPrivate(this))
{
 
    d->m_shortcutsEditor = new KisShortcutsEditor(this, types, allowLetterShortcuts);
 
    /*  Construct & Connect UI  */
    QVBoxLayout *mainLayout = new QVBoxLayout(this);
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->addWidget(d->m_shortcutsEditor);
    QHBoxLayout *bottomLayout = new QHBoxLayout;
    d->m_schemeEditor = new KisKShortcutSchemesEditor(this);
    connect(d->m_schemeEditor, SIGNAL(shortcutsSchemeChanged(QString)),
            this, SLOT(changeShortcutScheme(QString)));
    bottomLayout->addLayout(d->m_schemeEditor);
    QPushButton *printButton = new QPushButton;
    KGuiItem::assign(printButton, KStandardGuiItem::print());
 
    QDialogButtonBox *buttonBox = new QDialogButtonBox(this);
    buttonBox->addButton(printButton, QDialogButtonBox::ActionRole);
    bottomLayout->addWidget(buttonBox);
    mainLayout->addLayout(bottomLayout);
    connect(printButton, SIGNAL(clicked()), d->m_shortcutsEditor, SLOT(printShortcuts()));
 
    KConfigGroup group(KSharedConfig::openConfig(), "KisShortcutsDialog Settings");
    resize(group.readEntry("Dialog Size", sizeHint()));
}

References connect(), d, KisShortcutsDialog::KisShortcutsDialogPrivate::m_schemeEditor, KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor, and sizeHint().

◆ ~KisShortcutsDialog()

KisShortcutsDialog::~KisShortcutsDialog ( )

override

Definition at line 69 of file KisShortcutsDialog.cpp.

{
    KConfigGroup group(KSharedConfig::openConfig(), "KisShortcutsDialog Settings");
    group.writeEntry("Dialog Size", size());
    delete d;
}

References d.

Member Function Documentation

◆ actionCollections()

QList< KisKActionCollection * > KisShortcutsDialog::actionCollections ( ) const

Returns: the list of action collections that are available for configuration in the dialog.

Definition at line 88 of file KisShortcutsDialog.cpp.

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

References d, and KisShortcutsDialog::KisShortcutsDialogPrivate::m_collections.

◆ addCollection()

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

Add all actions of the collection to the ones displayed and configured by the dialog. This is where the business happens.

Parameters

collection	the action collection.
title	the title associated with the collection.

Definition at line 76 of file KisShortcutsDialog.cpp.

{
    d->m_shortcutsEditor->addCollection(collection, title);
    d->m_collections.insert(title, collection);
}

References KisShortcutsEditor::addCollection(), d, KisShortcutsDialog::KisShortcutsDialogPrivate::m_collections, and KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor.

◆ allDefault()

void KisShortcutsDialog::allDefault ( )

Definition at line 98 of file KisShortcutsDialog.cpp.

{
    d->m_shortcutsEditor->allDefault();
}

References KisShortcutsEditor::allDefault(), d, and KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor.

◆ exportConfiguration()

void KisShortcutsDialog::exportConfiguration ( const QString & path ) const

Exports shortcut scheme file to path

Definition at line 114 of file KisShortcutsDialog.cpp.

{
    auto config = KSharedConfig::openConfig(path);
    d->m_shortcutsEditor->exportConfiguration(config.data());
}

References d, KisShortcutsEditor::exportConfiguration(), and KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor.

◆ importConfiguration()

void KisShortcutsDialog::importConfiguration ( const QString & path )

Import shortcut scheme file from path

Definition at line 108 of file KisShortcutsDialog.cpp.

{
    auto config = KSharedConfig::openConfig(path);
    d->m_shortcutsEditor->importConfiguration(config.data(), true);
}

References d, KisShortcutsEditor::importConfiguration(), and KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor.

◆ loadCustomShortcuts()

void KisShortcutsDialog::loadCustomShortcuts ( const QString & path )

Import custom shortcuts from path

Definition at line 127 of file KisShortcutsDialog.cpp.

{
    auto config = KSharedConfig::openConfig(path);
    d->m_shortcutsEditor->importConfiguration(config.data(), false);
}

References d, KisShortcutsEditor::importConfiguration(), and KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor.

◆ save()

void KisShortcutsDialog::save ( )

Called when the "OK" button in the main configuration page is pressed.

Definition at line 83 of file KisShortcutsDialog.cpp.

{
    d->save();
}

References d, and KisShortcutsDialog::KisShortcutsDialogPrivate::save().

◆ saveCustomShortcuts()

void KisShortcutsDialog::saveCustomShortcuts ( const QString & path ) const

Exports custom shortcuts to path

Definition at line 120 of file KisShortcutsDialog.cpp.

{
    auto cg = KSharedConfig::openConfig(path)->group(QStringLiteral("Shortcuts"));
    d->m_shortcutsEditor->saveShortcuts(&cg);
    d->m_shortcutsEditor->commit();
}

References KisShortcutsEditor::commit(), d, KisShortcutsDialog::KisShortcutsDialogPrivate::m_shortcutsEditor, and KisShortcutsEditor::saveShortcuts().

◆ sizeHint()

QSize KisShortcutsDialog::sizeHint ( ) const

override

See also: QWidget::sizeHint()

Definition at line 93 of file KisShortcutsDialog.cpp.

{
    return QSize(600, 480);
}

◆ undo()

void KisShortcutsDialog::undo ( )

Definition at line 103 of file KisShortcutsDialog.cpp.

{
    d->undo();
}

References d, and KisShortcutsDialog::KisShortcutsDialogPrivate::undo().

Member Data Documentation

◆ d

class KisShortcutsDialogPrivate* const KisShortcutsDialog::d

private

Definition at line 160 of file KisShortcutsDialog.h.

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

libs/widgetutils/xmlgui/KisShortcutsDialog.h
libs/widgetutils/xmlgui/KisShortcutsDialog.cpp

Classes

Public Member Functions

Private Attributes