Files
qt-creator/src/plugins/texteditor/codeassist/assistproposalitem.cpp
Kai Köhne 56baf8c058 Remove GPL-3.0+ from license identifiers
Since we also license under GPL-3.0 WITH Qt-GPL-exception-1.0,
this applies only to a hypothetical newer version of GPL, that doesn't
exist yet. If such a version emerges, we can still decide to relicense...

While at it, replace (deprecated) GPL-3.0 with more explicit GPL-3.0-only

Change was done by running

  find . -type f -exec perl -pi -e "s/LicenseRef-Qt-Commercial OR GPL-3.0\+ OR GPL-3.0 WITH Qt-GPL-exception-1.0/LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0/g" {} \;

Change-Id: I5097e6ce8d10233993ee30d7e25120e2659eb10b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-01-06 11:15:13 +00:00

142 lines
3.3 KiB
C++

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "assistproposalitem.h"
#include <texteditor/quickfix.h>
#include <texteditor/snippets/snippet.h>
#include <texteditor/texteditor.h>
#include <QTextCursor>
namespace TextEditor {
/*!
\class TextEditor::AssistProposalItem
\brief The AssistProposalItem class acts as an interface for representing an assist
proposal item.
\ingroup CodeAssist
This is class is part of the CodeAssist API.
*/
/*!
\fn bool TextEditor::AssistProposalItem::implicitlyApplies() const
Returns whether this item should implicitly apply in the case it is the only proposal
item available.
*/
/*!
\fn bool TextEditor::AssistProposalItem::prematurelyApplies(const QChar &c) const
Returns whether the character \a c causes this item to be applied.
*/
/*!
\fn void TextEditor::AssistProposalItem::apply(BaseTextEditor *editor, int basePosition) const
This is the place to implement the actual application of the item.
*/
void AssistProposalItem::setIcon(const QIcon &icon)
{
m_icon = icon;
}
QIcon AssistProposalItem::icon() const
{
return m_icon;
}
void AssistProposalItem::setText(const QString &text)
{
m_text = text;
}
QString AssistProposalItem::text() const
{
return m_text;
}
void AssistProposalItem::setDetail(const QString &detail)
{
m_detail = detail;
}
QString AssistProposalItem::detail() const
{
return m_detail;
}
void AssistProposalItem::setData(const QVariant &var)
{
m_data = var;
}
const QVariant &AssistProposalItem::data() const
{
return m_data;
}
bool AssistProposalItem::isSnippet() const
{
return data().canConvert<QString>();
}
bool AssistProposalItem::isValid() const
{
return m_data.isValid();
}
quint64 AssistProposalItem::hash() const
{
return 0;
}
bool AssistProposalItem::implicitlyApplies() const
{
return !data().canConvert<QString>() && !data().canConvert<QuickFixOperation::Ptr>();
}
bool AssistProposalItem::prematurelyApplies(const QChar &c) const
{
Q_UNUSED(c)
return false;
}
void AssistProposalItem::apply(TextDocumentManipulatorInterface &manipulator, int basePosition) const
{
if (data().canConvert<QString>()) {
applySnippet(manipulator, basePosition);
} else if (data().canConvert<QuickFixOperation::Ptr>()) {
applyQuickFix(manipulator, basePosition);
} else {
applyContextualContent(manipulator, basePosition);
manipulator.encourageApply();
}
}
void AssistProposalItem::applyContextualContent(TextDocumentManipulatorInterface &manipulator, int basePosition) const
{
const int currentPosition = manipulator.currentPosition();
manipulator.replace(basePosition, currentPosition - basePosition, text());
}
void AssistProposalItem::applySnippet(TextDocumentManipulatorInterface &manipulator, int basePosition) const
{
manipulator.insertCodeSnippet(basePosition, data().toString(), &Snippet::parse);
}
void AssistProposalItem::applyQuickFix(TextDocumentManipulatorInterface &manipulator, int basePosition) const
{
Q_UNUSED(manipulator)
Q_UNUSED(basePosition)
QuickFixOperation::Ptr op = data().value<QuickFixOperation::Ptr>();
op->perform();
}
} // namespace TextEditor