apps/konsole/src/KeyBindingEditor.cpp

   1 /*
   2     Copyright 2008 by Robert Knight <robertknight@gmail.com>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17     02110-1301  USA.
  18 */
  19
  20 // Own
  21 #include "KeyBindingEditor.h"
  22
  23 // Qt
  24 #include <QtGui/QHeaderView>
  25 #include <QtGui/QKeyEvent>
  26
  27 #include <KDebug>
  28
  29 // Konsole
  30 #include "ui_KeyBindingEditor.h"
  31 #include "KeyboardTranslator.h"
  32
  33 using namespace Konsole;
  34
  35 KeyBindingEditor::KeyBindingEditor(QWidget* parent)
  36     : QWidget(parent)
  37     , _translator(new KeyboardTranslator( QString() ))
  38 {
  39     _ui = new Ui::KeyBindingEditor();
  40     _ui->setupUi(this);
  41
  42     // description edit
  43     connect( _ui->descriptionEdit , SIGNAL(textChanged(const QString&)) , this , SLOT(setDescription(const QString&)) );
  44
  45     // key bindings table
  46     _ui->keyBindingTable->setColumnCount(2);
  47
  48     QStringList labels;
  49     labels << i18n("Key Combination") << i18n("Output");
  50
  51     _ui->keyBindingTable->setHorizontalHeaderLabels(labels);
  52     _ui->keyBindingTable->horizontalHeader()->setStretchLastSection(true);
  53     _ui->keyBindingTable->verticalHeader()->hide();
  54
  55     // add and remove buttons
  56     _ui->addEntryButton->setIcon( KIcon("list-add") );
  57     _ui->removeEntryButton->setIcon( KIcon("list-remove") );
  58
  59     connect( _ui->removeEntryButton , SIGNAL(clicked()) , this , SLOT(removeSelectedEntry()) );
  60     connect( _ui->addEntryButton , SIGNAL(clicked()) , this , SLOT(addNewEntry()) );
  61
  62     // test area
  63     _ui->testAreaInputEdit->installEventFilter(this);
  64 }
  65
  66 KeyBindingEditor::~KeyBindingEditor()
  67 {
  68     delete _ui;
  69 }
  70
  71 void KeyBindingEditor::removeSelectedEntry()
  72 {
  73     QListIterator<QTableWidgetItem*> iter( _ui->keyBindingTable->selectedItems() );
  74
  75     while ( iter.hasNext() )
  76     {
  77         // get the first item in the row which has the entry
  78         QTableWidgetItem* item = _ui->keyBindingTable->item(iter.next()->row(),0);
  79
  80         KeyboardTranslator::Entry existing = item->data(Qt::UserRole).
  81                                                     value<KeyboardTranslator::Entry>();
  82
  83         _translator->removeEntry(existing);
  84
  85         _ui->keyBindingTable->removeRow( item->row() );
  86     }
  87 }
  88
  89 void KeyBindingEditor::addNewEntry()
  90 {
  91    _ui->keyBindingTable->insertRow( _ui->keyBindingTable->rowCount() );
  92
  93    int newRowCount = _ui->keyBindingTable->rowCount();
  94
  95    // block signals here to avoid triggering bindingTableItemChanged() slot call
  96    _ui->keyBindingTable->blockSignals(true);
  97
  98    _ui->keyBindingTable->setItem(newRowCount-1,0,new QTableWidgetItem() );
  99    _ui->keyBindingTable->setItem(newRowCount-1,1,new QTableWidgetItem() );
 100
 101    _ui->keyBindingTable->blockSignals(false);
 102
 103    // make sure user can see new row
 104    _ui->keyBindingTable->scrollToItem(_ui->keyBindingTable->item(newRowCount-1,0));
 105 }
 106
 107 bool KeyBindingEditor::eventFilter( QObject* watched , QEvent* event )
 108 {
 109     if ( watched == _ui->testAreaInputEdit )
 110     {
 111        if ( event->type() == QEvent::KeyPress )
 112        {
 113             QKeyEvent* keyEvent = (QKeyEvent*)event;
 114
 115             // The state here is currently set to the state that a newly started
 116             // terminal in Konsole will be in ( which is also the same as the
 117             // state just after a reset ), this has 'Ansi' turned on and all other
 118             // states off.
 119             //
 120             // TODO: It may be useful to be able to specify the state in the 'test input'
 121             // area, but preferably not in a way which clutters the UI with lots of
 122             // checkboxes.
 123             //
 124             const KeyboardTranslator::States states = KeyboardTranslator::AnsiState;
 125
 126             KeyboardTranslator::Entry entry = _translator->findEntry( keyEvent->key() ,
 127                                                                       keyEvent->modifiers(),
 128                                                                       states );
 129
 130             if ( !entry.isNull() )
 131             {
 132                 _ui->testAreaInputEdit->setText(entry.conditionToString());
 133                 _ui->testAreaOutputEdit->setText(entry.resultToString(true,keyEvent->modifiers()));
 134             }
 135             else
 136             {
 137                 _ui->testAreaInputEdit->setText(keyEvent->text());
 138                 _ui->testAreaOutputEdit->setText(keyEvent->text());
 139             }
 140
 141             keyEvent->accept();
 142             return true;
 143        }
 144     }
 145     return false;
 146 }
 147
 148 void KeyBindingEditor::setDescription(const QString& newDescription)
 149 {
 150      _ui->descriptionEdit->setText(newDescription);
 151
 152      if ( _translator )
 153          _translator->setDescription(newDescription);
 154 }
 155 QString KeyBindingEditor::description() const
 156 {
 157     return _ui->descriptionEdit->text();
 158 }
 159
 160 void KeyBindingEditor::setup(const KeyboardTranslator* translator)
 161 {
 162     if ( _translator )
 163         delete _translator;
 164
 165     _translator = new KeyboardTranslator(*translator);
 166
 167     // setup description edit
 168     _ui->descriptionEdit->setText(translator->description());
 169
 170     // setup key binding table
 171     setupKeyBindingTable(translator);
 172 }
 173
 174 KeyboardTranslator* KeyBindingEditor::translator() const
 175 {
 176     return _translator;
 177 }
 178
 179 void KeyBindingEditor::bindingTableItemChanged(QTableWidgetItem* item)
 180 {
 181    QTableWidgetItem* key = _ui->keyBindingTable->item( item->row() , 0 );
 182    KeyboardTranslator::Entry existing = key->data(Qt::UserRole).value<KeyboardTranslator::Entry>();
 183
 184    QString condition = key->text();
 185    QString result = _ui->keyBindingTable->item( item->row() , 1 )->text();
 186
 187    KeyboardTranslator::Entry entry = KeyboardTranslatorReader::createEntry(condition,result);
 188    _translator->replaceEntry(existing,entry);
 189
 190     // block signals to prevent this slot from being called repeatedly
 191    _ui->keyBindingTable->blockSignals(true);
 192
 193    key->setData(Qt::UserRole,QVariant::fromValue(entry));
 194
 195    _ui->keyBindingTable->blockSignals(false);
 196 }
 197
 198 void KeyBindingEditor::setupKeyBindingTable(const KeyboardTranslator* translator)
 199 {
 200     disconnect( _ui->keyBindingTable , SIGNAL(itemChanged(QTableWidgetItem*)) , this ,
 201             SLOT(bindingTableItemChanged(QTableWidgetItem*)) );
 202
 203     QList<KeyboardTranslator::Entry> entries = translator->entries();
 204     _ui->keyBindingTable->setRowCount(entries.count());
 205
 206     for ( int row = 0 ; row < entries.count() ; row++ )
 207     {
 208         const KeyboardTranslator::Entry& entry = entries.at(row);
 209
 210         QTableWidgetItem* keyItem = new QTableWidgetItem(entry.conditionToString());
 211         keyItem->setData( Qt::UserRole , QVariant::fromValue(entry) );
 212
 213         QTableWidgetItem* textItem = new QTableWidgetItem(QString(entry.resultToString()));
 214
 215         _ui->keyBindingTable->setItem(row,0,keyItem);
 216         _ui->keyBindingTable->setItem(row,1,textItem);
 217     }
 218     _ui->keyBindingTable->sortItems(0);
 219
 220     connect( _ui->keyBindingTable , SIGNAL(itemChanged(QTableWidgetItem*)) , this ,
 221             SLOT(bindingTableItemChanged(QTableWidgetItem*)) );
 222 }
 223
 224 #include "KeyBindingEditor.moc"
 225