pilotclient/src/blackgui/models/keyboardkeylistmodel.cpp

/* Copyright (C) 2013
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms
 * contained in the LICENSE file.
 */

#include "keyboardkeylistmodel.h"
#include "blackmisc/blackmiscfreefunctions.h"
#include <QMetaProperty>
#include <QComboBox>
#include <QTableView>
#include <QEvent>
#include <QKeyEvent>

using namespace BlackMisc::Settings;
using namespace BlackMisc::Hardware;

namespace BlackGui
{
    namespace Models
    {
        /*
         * Constructor
         */
        CKeyboardKeyListModel::CKeyboardKeyListModel(QObject *parent) :
            CListModelBase<CSettingKeyboardHotkey, CSettingKeyboardHotkeyList>("ViewKeyboardKeyList", parent)
        {
            const bool editable = true;
            this->m_columns.addColumn(CColumn("key", CSettingKeyboardHotkey::IndexKeyAsStringRepresentation, new CStringFormatter(), editable));
            this->m_columns.addColumn(CColumn("modifier 1", CSettingKeyboardHotkey::IndexModifier1AsString, new CStringFormatter(), editable));
            this->m_columns.addColumn(CColumn("modifier 2", CSettingKeyboardHotkey::IndexModifier2AsString, new CStringFormatter(), editable));
            this->m_columns.addColumn(CColumn::standardString("function", CSettingKeyboardHotkey::IndexFunctionAsString));

            this->setSortColumnByPropertyIndex(CSettingKeyboardHotkey::IndexFunctionAsString);
            this->m_sortOrder = Qt::AscendingOrder;

            // force strings for translation in resource files
            (void)QT_TRANSLATE_NOOP("ViewKeyboardKeyList", "modifier 1");
            (void)QT_TRANSLATE_NOOP("ViewKeyboardKeyList", "modifier 2");
            (void)QT_TRANSLATE_NOOP("ViewKeyboardKeyList", "function");
            (void)QT_TRANSLATE_NOOP("ViewKeyboardKeyList", "key");
        }

        /*
         * Display icons
         */
        QVariant CKeyboardKeyListModel::data(const QModelIndex &modelIndex, int role) const
        {
            // shortcut, fast check
            return CListModelBase::data(modelIndex, role);
        }

        bool CKeyboardKeyListModel::setData(const QModelIndex &index, const QVariant &value, int role)
        {
            if (role == Qt::EditRole)
            {
                CSettingKeyboardHotkey::ColumnIndex pi = this->modelIndexToPropertyIndex(index).frontCasted<CSettingKeyboardHotkey::ColumnIndex>();
                if (pi == CSettingKeyboardHotkey::IndexModifier1 || pi == CSettingKeyboardHotkey::IndexModifier2 || pi == CSettingKeyboardHotkey::IndexModifier1AsString || pi == CSettingKeyboardHotkey::IndexModifier2AsString)
                {
                    if (index.row() >= this->m_container.size()) return true;
                    CSettingKeyboardHotkey key = this->m_container[index.row()];
                    key.setPropertyByIndex(value, pi);
                    key.cleanup();
                    this->m_container[index.row()] = key;
                    return true;
                }
                else if (pi == CSettingKeyboardHotkey::IndexKey || pi == CSettingKeyboardHotkey::IndexKeyAsString || pi == CSettingKeyboardHotkey::IndexKeyAsStringRepresentation)
                {
                    Q_ASSERT(value.canConvert<CSettingKeyboardHotkey>());
                    if (index.row() >= this->m_container.size()) return true;
                    CSettingKeyboardHotkey key = this->m_container[index.row()];
                    key.setPropertyByIndex(value, CSettingKeyboardHotkey::IndexObject);
                    key.cleanup();
                    this->m_container[index.row()] = key;
                    return true;
                }
            }
            return CListModelBase::setData(index, value, role);
        }

        QWidget *CKeyboardKeyItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const
        {
            const CKeyboardKeyListModel *model = this->model();
            Q_ASSERT(model);

            if (index.row() < model->rowCount())
            {
                CSettingKeyboardHotkey::ColumnIndex pi = model->modelIndexToPropertyIndex(index).frontCasted<CSettingKeyboardHotkey::ColumnIndex>();
                if (pi == CSettingKeyboardHotkey::IndexModifier1 || pi == CSettingKeyboardHotkey::IndexModifier2 || pi == CSettingKeyboardHotkey::IndexModifier1AsString || pi == CSettingKeyboardHotkey::IndexModifier2AsString)
                {
                    CSettingKeyboardHotkey key = model->at(index);
                    QString v = (pi == CSettingKeyboardHotkey::IndexModifier1 || pi == CSettingKeyboardHotkey::IndexModifier1AsString) ? key.getModifier1AsString() : key.getModifier2AsString();
                    QComboBox *edit = new QComboBox(parent);
                    edit->addItems(CSettingKeyboardHotkey::modifiers());
                    edit->setCurrentText(v);
                    return edit;
                }
                else if (pi == CSettingKeyboardHotkey::IndexKey || pi == CSettingKeyboardHotkey::IndexKeyAsString || pi == CSettingKeyboardHotkey::IndexKeyAsStringRepresentation)
                {
                    CSettingKeyboardHotkey hotkey = model->at(index);
                    CKeyboardLineEdit *edit = new CKeyboardLineEdit(hotkey, parent);
                    edit->setText(hotkey.getKey().getKeyAsString());
                    return edit;
                }
            }
            return QItemDelegate::createEditor(parent, option, index);
        }

        void CKeyboardKeyItemDelegate::setEditorData(QWidget *editor, const QModelIndex &index) const
        {
            QItemDelegate::setEditorData(editor, index);
        }

        void CKeyboardKeyItemDelegate::setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const
        {
            // with our own line edit we have a special treatment
            // otherwise (comboboxes) standard handling via QItemDelegate
            CKeyboardLineEdit *lineEdit = qobject_cast<CKeyboardLineEdit *>(editor);
            if (lineEdit)
                model->setData(index, lineEdit->getKey().toQVariant() , Qt::EditRole);
            else
                QItemDelegate::setModelData(editor, model, index);
        }

        void CKeyboardKeyItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const
        {
            QItemDelegate::updateEditorGeometry(editor, option, index);
        }

        const CKeyboardKeyListModel *CKeyboardKeyItemDelegate::model() const
        {
            if (this->parent())
            {
                QTableView *tableView = dynamic_cast<QTableView *>(this->parent());
                if (tableView)
                {
                    return dynamic_cast<CKeyboardKeyListModel *>(tableView->model());
                }
            }
            return nullptr;
        }

        void CKeyboardLineEdit::keyPressEvent(QKeyEvent *event)
        {
            const Qt::Key k = static_cast<Qt::Key>(event->key());
            if (k == Qt::Key_Shift || k == Qt::Key_Control || k == Qt::Key_Meta || k == Qt::Key_Alt || k == Qt::Key_CapsLock || k == Qt::Key_NumLock || k == Qt::Key_ScrollLock) return;
            BlackMisc::Hardware::CKeyboardKey key;
            key.setKey(k);
            this->m_hotkey.setKey(key);
            this->setText(CSettingKeyboardHotkey::toStringRepresentation(event->key()));
        }

    }
} // namespace