KateCommandBar Class Reference

#include <katecommandbar.h>

Inheritance diagram for KateCommandBar:

Public Member Functions
	KateCommandBar (QWidget *parent=nullptr)
void	updateBar (const QList< KisKActionCollection * > &actions, int totalActions)
void	updateViewGeometry ()

Protected Member Functions
bool	eventFilter (QObject *obj, QEvent *event) override

Private Slots
void	reselectFirst ()
void	slotReturnPressed ()

Private Attributes
QVector< KisKActionCollection * >	m_disposableActionCollections
QLineEdit *	m_lineEdit
CommandModel *	m_model
CommandBarFilterModel *	m_proxyModel
QTreeView *	m_treeView

Detailed Description

Definition at line 18 of file katecommandbar.h.

Constructor & Destructor Documentation

KateCommandBar()

KateCommandBar::KateCommandBar

(

QWidget *

parent = nullptr

)

Definition at line 241 of file katecommandbar.cpp.

    : QMenu(parent)
{
    QVBoxLayout *layout = new QVBoxLayout();
    layout->setSpacing(0);
    layout->setContentsMargins(4, 4, 4, 4);
    setLayout(layout);
 
    m_lineEdit = new QLineEdit(this);
    setFocusProxy(m_lineEdit);
 
    layout->addWidget(m_lineEdit);
 
    m_treeView = new QTreeView();
    layout->addWidget(m_treeView, 1);
    m_treeView->setTextElideMode(Qt::ElideMiddle);
    m_treeView->setUniformRowHeights(true);
 
    m_model = new CommandModel(this);
 
    CommandBarStyleDelegate *delegate = new CommandBarStyleDelegate(this);
    ShortcutStyleDelegate *del = new ShortcutStyleDelegate(this);
    m_treeView->setItemDelegateForColumn(0, delegate);
    m_treeView->setItemDelegateForColumn(1, del);
 
    m_proxyModel = new CommandBarFilterModel(this);
    m_proxyModel->setFilterRole(Qt::DisplayRole);
    m_proxyModel->setSortRole(CommandModel::Score);
    m_proxyModel->setFilterKeyColumn(0);
 
    connect(m_lineEdit, &QLineEdit::returnPressed, this, &KateCommandBar::slotReturnPressed);
    connect(m_lineEdit, &QLineEdit::textChanged, m_proxyModel, &CommandBarFilterModel::setFilterString);
    connect(m_lineEdit, &QLineEdit::textChanged, delegate, &CommandBarStyleDelegate::setFilterString);
    connect(m_lineEdit, &QLineEdit::textChanged, this, [this]() {
        m_treeView->viewport()->update();
        reselectFirst();
    });
    connect(m_treeView, &QTreeView::clicked, this, &KateCommandBar::slotReturnPressed);
 
    m_proxyModel->setSourceModel(m_model);
    m_treeView->setSortingEnabled(true);
    m_treeView->setModel(m_proxyModel);
 
    m_treeView->installEventFilter(this);
    m_lineEdit->installEventFilter(this);
 
    m_treeView->setHeaderHidden(true);
    m_treeView->setRootIsDecorated(false);
    m_treeView->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    m_treeView->setSelectionMode(QTreeView::SingleSelection);
 
    setHidden(true);
}

References connect(), m_lineEdit, m_model, m_proxyModel, m_treeView, reselectFirst(), CommandModel::Score, CommandBarFilterModel::setFilterString(), CommandBarStyleDelegate::setFilterString(), and slotReturnPressed().

Member Function Documentation

eventFilter()

bool KateCommandBar::eventFilter ( QObject * obj, QEvent * event )

overrideprotected

Definition at line 331 of file katecommandbar.cpp.

{
    // catch key presses + shortcut overrides to allow to have ESC as application wide shortcut, too, see bug 409856
    if (event->type() == QEvent::KeyPress || event->type() == QEvent::ShortcutOverride) {
        QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
        if (obj == m_lineEdit) {
            const bool forward2list = (keyEvent->key() == Qt::Key_Up) || (keyEvent->key() == Qt::Key_Down) || (keyEvent->key() == Qt::Key_PageUp)
                || (keyEvent->key() == Qt::Key_PageDown);
            if (forward2list) {
                QCoreApplication::sendEvent(m_treeView, event);
                return true;
            }
 
            if (keyEvent->key() == Qt::Key_Escape) {
                m_lineEdit->clear();
                keyEvent->accept();
                hide();
                return true;
            }
        } else {
            const bool forward2input = (keyEvent->key() != Qt::Key_Up) && (keyEvent->key() != Qt::Key_Down) && (keyEvent->key() != Qt::Key_PageUp)
                && (keyEvent->key() != Qt::Key_PageDown) && (keyEvent->key() != Qt::Key_Tab) && (keyEvent->key() != Qt::Key_Backtab);
            if (forward2input) {
                QCoreApplication::sendEvent(m_lineEdit, event);
                return true;
            }
        }
    }
 
    // hide on focus out, if neither input field nor list have focus!
    else if (event->type() == QEvent::FocusOut && !(m_lineEdit->hasFocus() || m_treeView->hasFocus())) {
        m_lineEdit->clear();
        hide();
        return true;
    }
 
    return QWidget::eventFilter(obj, event);
}

References m_lineEdit, and m_treeView.

reselectFirst

void KateCommandBar::reselectFirst ( )

privateslot

Definition at line 404 of file katecommandbar.cpp.

{
    QModelIndex index = m_proxyModel->index(0, 0);
    m_treeView->setCurrentIndex(index);
}

References m_proxyModel, and m_treeView.

slotReturnPressed

void KateCommandBar::slotReturnPressed ( )

privateslot

Definition at line 370 of file katecommandbar.cpp.

{
    auto act = m_proxyModel->data(m_treeView->currentIndex(), Qt::UserRole).value<QAction *>();
    if (act) {
        // if the action is a menu, we take all its actions
        // and reload our dialog with these instead.
        if (auto menu = act->menu()) {
            auto menuActions = menu->actions();
            QVector<QPair<QString, QAction *>> list;
            list.reserve(menuActions.size());
 
            // if there are no actions, trigger load actions
            // this happens with some menus that are loaded on demand
            if (menuActions.size() == 0) {
                Q_EMIT menu->aboutToShow();
                menuActions = menu->actions();
            }
 
            for (auto menuAction : std::as_const(menuActions)) {
                if (menuAction) {
                    list.append({KLocalizedString::removeAcceleratorMarker(act->text()), menuAction});
                }
            }
            m_model->refresh(list);
            m_lineEdit->clear();
            return;
        } else {
            act->trigger();
        }
    }
    m_lineEdit->clear();
    hide();
}

References m_lineEdit, m_model, m_proxyModel, m_treeView, and CommandModel::refresh().

updateBar()

void KateCommandBar::updateBar	(	const QList< KisKActionCollection * > &	actions,
		int	totalActions )

Definition at line 295 of file katecommandbar.cpp.

{
    qDeleteAll(m_disposableActionCollections);
    m_disposableActionCollections.clear();
 
    QVector<QPair<QString, QAction *>> actionList;
    actionList.reserve(totalActions);
 
    for (const auto collection : actionCollections) {
 
        if (collection->componentName().contains("disposable")) {
            m_disposableActionCollections << collection;
        }
 
        const QList<QAction *> collectionActions = collection->actions();
        const QString componentName = collection->componentDisplayName();
        for (const auto action : collectionActions) {
            // sanity + empty check ensures displayable actions and removes ourself
            // from the action list
            if (action && action->isEnabled() && !action->text().isEmpty()) {
                actionList.append({componentName, action});
            }
        }
    }
 
 
 
 
    m_model->refresh(std::move(actionList));
    reselectFirst();
 
    updateViewGeometry();
    show();
    setFocus();
}

References m_disposableActionCollections, m_model, CommandModel::refresh(), reselectFirst(), and updateViewGeometry().

updateViewGeometry()

void KateCommandBar::updateViewGeometry

(

)

Definition at line 410 of file katecommandbar.cpp.

{
    m_treeView->resizeColumnToContents(0);
    m_treeView->resizeColumnToContents(1);
 
    const QSize centralSize = parentWidget()->size();
 
    // width: 2.4 of editor, height: 1/2 of editor
    const QSize viewMaxSize(centralSize.width() / 2.4, centralSize.height() / 2);
 
    // Position should be central over window
    const int xPos = std::max(0, (centralSize.width() - viewMaxSize.width()) / 2);
    const int yPos = std::max(0, (centralSize.height() - viewMaxSize.height()) * 1 / 4);
 
    const QPoint p(xPos, yPos);
    move(p + parentWidget()->pos());
 
    this->setFixedSize(viewMaxSize);
}

References m_treeView, and p.

Member Data Documentation

m_disposableActionCollections

QVector<KisKActionCollection *> KateCommandBar::m_disposableActionCollections

private

Definition at line 40 of file katecommandbar.h.

m_lineEdit

QLineEdit* KateCommandBar::m_lineEdit

private

Definition at line 37 of file katecommandbar.h.

m_model

CommandModel* KateCommandBar::m_model

private

Definition at line 38 of file katecommandbar.h.

m_proxyModel

CommandBarFilterModel* KateCommandBar::m_proxyModel

private

Definition at line 39 of file katecommandbar.h.

m_treeView

QTreeView* KateCommandBar::m_treeView

private

Definition at line 36 of file katecommandbar.h.

---

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

• libs/widgetutils/katecommandbar.h
• libs/widgetutils/katecommandbar.cpp