Krita Source Code Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
KisShortcutsEditorPrivate Class Reference

#include <KisShortcutsEditor_p.h>

Public Types

enum  hierarchyLevel { Root = 0 , Program , Action }
 Represents the three hierarchies the dialog displays. More...
 

Public Member Functions

bool addAction (QAction *action, QTreeWidgetItem *hier[], hierarchyLevel level)
 
void allDefault ()
 
void appendToView (uint nList, const QString &title=QString())
 
void capturedShortcut (const QVariant &, const QModelIndex &)
 
void changeKeyShortcut (KisShortcutsEditorItem *item, uint column, const QKeySequence &capture)
 
void clearConfiguration ()
 
QTreeWidgetItem * findOrMakeItem (QTreeWidgetItem *parent, const QString &name)
 
void initGUI (KisShortcutsEditor::ActionTypes actionTypes, KisShortcutsEditor::LetterShortcuts allowLetterShortcuts)
 
 KisShortcutsEditorPrivate (KisShortcutsEditor *q)
 
void printShortcuts () const
 
void setActionTypes (KisShortcutsEditor::ActionTypes actionTypes)
 

Public Attributes

QList< KisKActionCollection * > actionCollections
 
KisShortcutsEditor::ActionTypes actionTypes
 
KisShortcutsEditorDelegate * delegate
 
KisShortcutsEditor * q
 
Ui::KisShortcutsDialog ui
 

Detailed Description

Definition at line 37 of file KisShortcutsEditor_p.h.

Member Enumeration Documentation

◆ hierarchyLevel

enum KisShortcutsEditorPrivate::hierarchyLevel

Represents the three hierarchies the dialog displays.

Enumerator
Root 
Program 
Action 

Definition at line 42 of file KisShortcutsEditor_p.h.

42 {Root = 0, /* Base level node (Tools, Krita...) */
43 Program, /* We use this like "Path Tool, Default Tool," */
44 Action}; /* Individual actions */

Constructor & Destructor Documentation

◆ KisShortcutsEditorPrivate()

KisShortcutsEditorPrivate::KisShortcutsEditorPrivate ( KisShortcutsEditor * q)

Definition at line 44 of file KisShortcutsEditor_p.cpp.

45 : q(q),
46 delegate(0)
47{}
KisShortcutsEditorPrivate::delegate
KisShortcutsEditorDelegate * delegate
Definition KisShortcutsEditor_p.h:90

Member Function Documentation

◆ addAction()

bool KisShortcutsEditorPrivate::addAction ( QAction * action,
QTreeWidgetItem * hier[],
hierarchyLevel level )

Add action at hierarchy level level.

Filters out QActions (TODO: hmm) and unnamed actions before adding.

Returns
true if the actions was successfully added

Definition at line 103 of file KisShortcutsEditor_p.cpp.

104{
105
106 // We cannot handle unnamed actions, even though Qt automatically assigns
107 // them names prefixed by `unnamed-`. Unfortunately those automatic names
108 // are not guaranteed to be the same each time, especially not within
109 // KisParts, so they cannot be reliably saved and loaded.
110 QString actionName = action->objectName();
111 if (actionName.isEmpty() || actionName.startsWith(QStringLiteral("unnamed-"))) {
112 qCritical() << "Skipping action without name " << action->text() << "," << actionName << "!";
113 return false;
114 }
115
116 // Construct the actual treeview items. The work happens here.
117 //
118 // Don't feed the editor raw QActions. This code requires that the
119 // "defaultShortcut" dynamic property be set.
120 //
121 // Note: Krita never sets the property "isShortcutConfigurable".
122 // Perhaps it could be useful.
123 const QVariant value = action->property("isShortcutConfigurable");
124 if (!value.isValid() || value.toBool()) {
125 new KisShortcutsEditorItem((hier[level]), action);
126 return true;
127 }
128
129 return false;
130}
value
float value(const T *src, size_t ch)
Definition JPEGXLImport.cpp:93

References value().

◆ allDefault()

void KisShortcutsEditorPrivate::allDefault ( )

Definition at line 132 of file KisShortcutsEditor_p.cpp.

133{
134 for (QTreeWidgetItemIterator it(ui.list); (*it); ++it) {
135 if (!(*it)->parent() || (*it)->type() != ActionItem) {
136 continue;
137 }
138
139 KisShortcutsEditorItem *item = static_cast<KisShortcutsEditorItem *>(*it);
140 QAction *act = item->m_action;
141
142 QList<QKeySequence> defaultShortcuts = act->property("defaultShortcuts").value<QList<QKeySequence> >();
143 if (act->shortcuts() != defaultShortcuts) {
144 QKeySequence primary = defaultShortcuts.isEmpty() ? QKeySequence() : defaultShortcuts.at(0);
145 QKeySequence alternate = defaultShortcuts.size() <= 1 ? QKeySequence() : defaultShortcuts.at(1);
146 changeKeyShortcut(item, LocalPrimary, primary);
147 changeKeyShortcut(item, LocalAlternate, alternate);
148 }
149 }
150}
ActionItem
@ ActionItem
Definition KisShortcutsDialog_p.h:62
LocalAlternate
@ LocalAlternate
Definition KisShortcutsDialog_p.h:43
LocalPrimary
@ LocalPrimary
Definition KisShortcutsDialog_p.h:42
KisShortcutsEditorItem::m_action
QAction * m_action
The action this item is responsible for.
Definition KisShortcutsEditor_p.h:154
KisShortcutsEditorPrivate::ui
Ui::KisShortcutsDialog ui
Definition KisShortcutsEditor_p.h:87
KisShortcutsEditorPrivate::changeKeyShortcut
void changeKeyShortcut(KisShortcutsEditorItem *item, uint column, const QKeySequence &capture)
Definition KisShortcutsEditor_p.cpp:185

References ActionItem, changeKeyShortcut(), LocalAlternate, LocalPrimary, KisShortcutsEditorItem::m_action, and ui.

◆ appendToView()

void KisShortcutsEditorPrivate::appendToView ( uint nList,
const QString & title = QString() )

◆ capturedShortcut()

void KisShortcutsEditorPrivate::capturedShortcut ( const QVariant & newShortcut,
const QModelIndex & index )

Definition at line 170 of file KisShortcutsEditor_p.cpp.

171{
172 //dispatch to the right handler
173 if (!index.isValid()) {
174 return;
175 }
176 int column = index.column();
177 KisShortcutsEditorItem *item = itemFromIndex(ui.list, index);
178 Q_ASSERT(item);
179
180 if (column >= LocalPrimary && column <= Id) {
181 changeKeyShortcut(item, column, newShortcut.value<QKeySequence>());
182 }
183}
Id
@ Id
Definition KisShortcutsDialog_p.h:44

References changeKeyShortcut(), Id, LocalPrimary, and ui.

◆ changeKeyShortcut()

void KisShortcutsEditorPrivate::changeKeyShortcut ( KisShortcutsEditorItem * item,
uint column,
const QKeySequence & capture )

Definition at line 185 of file KisShortcutsEditor_p.cpp.

186{
187 // The keySequence we get is cleared by KisKKeySequenceWidget. No conflicts.
188 if (capture == item->keySequence(column)) {
189 return;
190 }
191
192 item->setKeySequence(column, capture);
193 q->keyChange();
194 //force view update
195 item->setText(column, capture.toString(QKeySequence::NativeText));
196}
KisShortcutsEditorItem::keySequence
QKeySequence keySequence(uint column) const
Definition KisShortcutsEditorItem.cpp:140
KisShortcutsEditorItem::setKeySequence
void setKeySequence(uint column, const QKeySequence &seq)
Definition KisShortcutsEditorItem.cpp:154

References KisShortcutsEditor::keyChange(), KisShortcutsEditorItem::keySequence(), q, and KisShortcutsEditorItem::setKeySequence().

◆ clearConfiguration()

void KisShortcutsEditorPrivate::clearConfiguration ( )

Definition at line 199 of file KisShortcutsEditor_p.cpp.

200{
201 for (QTreeWidgetItemIterator it(ui.list); (*it); ++it) {
202 if (!(*it)->parent()) {
203 continue;
204 }
205
206 KisShortcutsEditorItem *item = static_cast<KisShortcutsEditorItem *>(*it);
207
208 changeKeyShortcut(item, LocalPrimary, QKeySequence());
209 changeKeyShortcut(item, LocalAlternate, QKeySequence());
210
211 }
212}

References changeKeyShortcut(), LocalAlternate, LocalPrimary, and ui.

◆ findOrMakeItem()

QTreeWidgetItem * KisShortcutsEditorPrivate::findOrMakeItem ( QTreeWidgetItem * parent,
const QString & name )

Definition at line 154 of file KisShortcutsEditor_p.cpp.

155{
156 for (int i = 0; i < parent->childCount(); i++) {
157 QTreeWidgetItem *child = parent->child(i);
158 if (child->text(0) == name) {
159 return child;
160 }
161 }
162 QTreeWidgetItem *ret = new QTreeWidgetItem(parent, NonActionItem);
163 ret->setText(0, name);
164 ui.list->expandItem(ret);
165 ret->setFlags(ret->flags() & ~Qt::ItemIsSelectable);
166 return ret;
167}
NonActionItem
@ NonActionItem
Definition KisShortcutsDialog_p.h:61
KisForestDetail::parent
ChildIterator< value_type, is_const > parent(const ChildIterator< value_type, is_const > &it)
Definition KisForest.h:327

References NonActionItem, and ui.

◆ initGUI()

void KisShortcutsEditorPrivate::initGUI ( KisShortcutsEditor::ActionTypes actionTypes,
KisShortcutsEditor::LetterShortcuts allowLetterShortcuts )

Definition at line 49 of file KisShortcutsEditor_p.cpp.

51{
52 actionTypes = types;
53
54 ui.setupUi(q);
55 q->layout()->setContentsMargins(0, 0, 0, 0);
56 ui.searchFilter->searchLine()->setTreeWidget(ui.list); // Plug into search line
57 ui.list->header()->setSectionResizeMode(QHeaderView::ResizeToContents);
58
59 // Create the Delegate. It is responsible for the KKeySequenceWidgets that
60 // really change the shortcuts.
61 delegate = new KisShortcutsEditorDelegate(
62 ui.list,
63 allowLetterShortcuts == KisShortcutsEditor::LetterShortcutsAllowed);
64
65 ui.list->setItemDelegate(delegate);
66 ui.list->setSelectionBehavior(QAbstractItemView::SelectItems);
67 ui.list->setSelectionMode(QAbstractItemView::SingleSelection);
68 //we have our own editing mechanism
69 ui.list->setEditTriggers(QAbstractItemView::NoEditTriggers);
70 ui.list->setAlternatingRowColors(true);
71
72 QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(ui.list);
73 if (scroller){
74 QObject::connect(scroller, SIGNAL(stateChanged(QScroller::State)),
75 q, SLOT(slotScrollerStateChanged(QScroller::State)));
76 }
77
78 QObject::connect(delegate, SIGNAL(shortcutChanged(QVariant,QModelIndex)),
79 q, SLOT(capturedShortcut(QVariant,QModelIndex)));
80 //hide the editor widget when its item becomes hidden
81 QObject::connect(ui.searchFilter->searchLine(), SIGNAL(hiddenChanged(QTreeWidgetItem*,bool)),
82 delegate, SLOT(hiddenBySearchLine(QTreeWidgetItem*,bool)));
83 //Expand items when searching
84 QObject::connect(ui.searchFilter->searchLine(), SIGNAL(searchUpdated(QString)),
85 q, SLOT(searchUpdated(QString)));
86
87 ui.searchFilter->setFocus();
88}
KisShortcutsEditorPrivate::capturedShortcut
void capturedShortcut(const QVariant &, const QModelIndex &)
Definition KisShortcutsEditor_p.cpp:170
KisShortcutsEditorPrivate::actionTypes
KisShortcutsEditor::ActionTypes actionTypes
Definition KisShortcutsEditor_p.h:89
KisShortcutsEditor::LetterShortcutsAllowed
@ LetterShortcutsAllowed
Letter shortcuts are allowed.
Definition KisShortcutsEditor.h:89
KisKineticScroller::createPreconfiguredScroller
KRITAWIDGETUTILS_EXPORT QScroller * createPreconfiguredScroller(QAbstractScrollArea *target)
Definition KisKineticScroller.cpp:57

References actionTypes, capturedShortcut(), KisKineticScroller::createPreconfiguredScroller(), delegate, KisShortcutsEditor::LetterShortcutsAllowed, q, and ui.

◆ printShortcuts()

void KisShortcutsEditorPrivate::printShortcuts ( ) const

Definition at line 232 of file KisShortcutsEditor_p.cpp.

233{
234 QTreeWidgetItem *root = ui.list->invisibleRootItem();
235 QTextDocument doc;
236
237 doc.setDefaultFont(QFontDatabase::systemFont(QFontDatabase::GeneralFont));
238
239 QTextCursor cursor(&doc);
240 cursor.beginEditBlock();
241 QTextCharFormat headerFormat;
242 headerFormat.setProperty(QTextFormat::FontSizeAdjustment, 3);
243 headerFormat.setFontWeight(QFont::Bold);
244 cursor.insertText(i18nc("header for an applications shortcut list", "Shortcuts for %1",
245 QGuiApplication::applicationDisplayName()),
246 headerFormat);
247 QTextCharFormat componentFormat;
248 componentFormat.setProperty(QTextFormat::FontSizeAdjustment, 2);
249 componentFormat.setFontWeight(QFont::Bold);
250 QTextBlockFormat componentBlockFormat = cursor.blockFormat();
251 componentBlockFormat.setTopMargin(16);
252 componentBlockFormat.setBottomMargin(16);
253
254 QTextTableFormat tableformat;
255 tableformat.setHeaderRowCount(1);
256 tableformat.setCellPadding(4.0);
257 tableformat.setCellSpacing(0);
258 tableformat.setBorderStyle(QTextFrameFormat::BorderStyle_Solid);
259 tableformat.setBorder(0.5);
260
261 QList<QPair<QString, ColumnDesignation> > shortcutTitleToColumn;
262 shortcutTitleToColumn << qMakePair(i18n("Main:"), LocalPrimary);
263 shortcutTitleToColumn << qMakePair(i18n("Alternate:"), LocalAlternate);
264
265 for (int i = 0; i < root->childCount(); i++) {
266 QTreeWidgetItem *item = root->child(i);
267 cursor.insertBlock(componentBlockFormat, componentFormat);
268 cursor.insertText(item->text(0));
269
270 QTextTable *table = cursor.insertTable(1, 3);
271 table->setFormat(tableformat);
272 int currow = 0;
273
274 QTextTableCell cell = table->cellAt(currow, 0);
275 QTextCharFormat format = cell.format();
276 format.setFontWeight(QFont::Bold);
277 cell.setFormat(format);
278 cell.firstCursorPosition().insertText(i18n("Action Name"));
279
280 cell = table->cellAt(currow, 1);
281 cell.setFormat(format);
282 cell.firstCursorPosition().insertText(i18n("Shortcuts"));
283
284 cell = table->cellAt(currow, 2);
285 cell.setFormat(format);
286 cell.firstCursorPosition().insertText(i18n("Description"));
287 currow++;
288
289 for (QTreeWidgetItemIterator it(item); *it; ++it) {
290 if ((*it)->type() != ActionItem) {
291 continue;
292 }
293
294 KisShortcutsEditorItem *editoritem = static_cast<KisShortcutsEditorItem *>(*it);
295 table->insertRows(table->rows(), 1);
296 QVariant data = editoritem->data(Name, Qt::DisplayRole);
297 table->cellAt(currow, 0).firstCursorPosition().insertText(data.toString());
298
299 QTextTable *shortcutTable = 0;
300 for (int k = 0; k < shortcutTitleToColumn.count(); k++) {
301 data = editoritem->data(shortcutTitleToColumn.at(k).second, Qt::DisplayRole);
302 QString key = data.value<QKeySequence>().toString();
303
304 if (!key.isEmpty()) {
305 if (!shortcutTable) {
306 shortcutTable = table->cellAt(currow, 1).firstCursorPosition().insertTable(1, 2);
307 QTextTableFormat shortcutTableFormat = tableformat;
308 shortcutTableFormat.setCellSpacing(0.0);
309 shortcutTableFormat.setHeaderRowCount(0);
310 shortcutTableFormat.setBorder(0.0);
311 shortcutTable->setFormat(shortcutTableFormat);
312 } else {
313 shortcutTable->insertRows(shortcutTable->rows(), 1);
314 }
315 shortcutTable->cellAt(shortcutTable->rows() - 1, 0)\
316 .firstCursorPosition().insertText(shortcutTitleToColumn.at(k).first);
317 shortcutTable->cellAt(shortcutTable->rows() - 1, 1)\
318 .firstCursorPosition().insertText(key);
319 }
320 }
321
322 QAction *action = editoritem->m_action;
323 cell = table->cellAt(currow, 2);
324 format = cell.format();
325 format.setProperty(QTextFormat::FontSizeAdjustment, -1);
326 cell.setFormat(format);
327 cell.firstCursorPosition().insertHtml(action->whatsThis());
328
329 currow++;
330 }
331 cursor.movePosition(QTextCursor::End);
332 }
333 cursor.endEditBlock();
334
335 QPrinter printer;
336 QPrintDialog *dlg = new QPrintDialog(&printer, q);
337 if (dlg->exec() == QDialog::Accepted) {
338 doc.print(&printer);
339 }
340 delete dlg;
341}
Name
@ Name
Definition KisShortcutsDialog_p.h:41
KisShortcutsEditorItem::data
QVariant data(int column, int role=Qt::DisplayRole) const override
Definition KisShortcutsEditorItem.cpp:50
KisDomUtils::toString
QString toString(const QString &value)
Definition kis_dom_utils.h:30

References ActionItem, KisShortcutsEditorItem::data(), LocalAlternate, LocalPrimary, KisShortcutsEditorItem::m_action, Name, q, and ui.

◆ setActionTypes()

void KisShortcutsEditorPrivate::setActionTypes ( KisShortcutsEditor::ActionTypes actionTypes)

Definition at line 90 of file KisShortcutsEditor_p.cpp.

91{
92 if (actionTypes == types) {
93 return;
94 }
95 actionTypes = types;
96
97 // show/hide the sections based on new selection
98 QHeaderView *header = ui.list->header();
99 header->showSection(LocalPrimary);
100 header->showSection(LocalAlternate);
101}

References actionTypes, LocalAlternate, LocalPrimary, and ui.

Member Data Documentation

◆ actionCollections

QList<KisKActionCollection *> KisShortcutsEditorPrivate::actionCollections

Definition at line 84 of file KisShortcutsEditor_p.h.

◆ actionTypes

KisShortcutsEditor::ActionTypes KisShortcutsEditorPrivate::actionTypes

Definition at line 89 of file KisShortcutsEditor_p.h.

◆ delegate

KisShortcutsEditorDelegate* KisShortcutsEditorPrivate::delegate

Definition at line 90 of file KisShortcutsEditor_p.h.

◆ q

KisShortcutsEditor* KisShortcutsEditorPrivate::q

Definition at line 85 of file KisShortcutsEditor_p.h.

◆ ui

Ui::KisShortcutsDialog KisShortcutsEditorPrivate::ui

Definition at line 87 of file KisShortcutsEditor_p.h.

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