forked from qt-creator/qt-creator
56baf8c058
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>
134 lines
4.2 KiB
C++
134 lines
4.2 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 "iassistproposalwidget.h"
|
|
|
|
#include "assistinterface.h"
|
|
|
|
using namespace TextEditor;
|
|
|
|
/*!
|
|
\class TextEditor::IAssistProposalWidget
|
|
\brief The IAssistProposalWidget class acts as an interface for widgets that display
|
|
assist proposals.
|
|
\ingroup CodeAssist
|
|
|
|
Known implenters of this interface are FunctionHintProposalWidget and GenericProposalWidget.
|
|
The former is recommeded to be used when assisting function calls constructs (overloads
|
|
and parameters) while the latter is quite generic so that it could be used to propose
|
|
snippets, refactoring operations (quickfixes), and contextual content (the member of class
|
|
or a string existent in the document, for example).
|
|
|
|
In general this API tries to be as decoupled as possible from the base text editor.
|
|
This is in order to make the design a bit more generic and allow code assist to be
|
|
pluggable into different types of documents (there are still issues to be treated).
|
|
|
|
This is class is part of the CodeAssist API.
|
|
|
|
\sa IAssistProposal
|
|
*/
|
|
|
|
IAssistProposalWidget::IAssistProposalWidget()
|
|
: QFrame(nullptr, Qt::Popup)
|
|
{}
|
|
|
|
void IAssistProposalWidget::updateProposal(std::unique_ptr<AssistInterface> &&interface)
|
|
{
|
|
filterProposal(interface->textAt(m_basePosition, interface->position() - m_basePosition));
|
|
}
|
|
|
|
IAssistProposalWidget::~IAssistProposalWidget() = default;
|
|
|
|
int IAssistProposalWidget::basePosition() const
|
|
{
|
|
return m_basePosition;
|
|
}
|
|
|
|
void IAssistProposalWidget::setBasePosition(int basePosition)
|
|
{
|
|
m_basePosition = basePosition;
|
|
}
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::setAssistant(CodeAssistant *assistant)
|
|
|
|
Sets the code assistant which is the owner of this widget. This is used so that the code
|
|
assistant can be notified when changes on the underlying widget happen.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::setReason(AssistReason reason)
|
|
|
|
Sets the reason which triggered the assist.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::setUnderlyingWidget(const QWidget *underlyingWidget)
|
|
|
|
Sets the underlying widget upon which this proposal operates.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::setModel(IAssistProposalModel *model)
|
|
|
|
Sets the model.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::setDisplayRect(const QRect &rect)
|
|
|
|
Sets the \a rect on which this widget should be displayed.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::showProposal(const QString &prefix)
|
|
|
|
Shows the proposal. The \a prefix is the string comprised from the character at the base
|
|
position of the proposal until the character immediately after the cursor at the moment
|
|
the proposal is displayed.
|
|
|
|
\sa IAssistProposal::basePosition()
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::updateProposal(const QString &prefix)
|
|
|
|
Updates the proposal base on the give \a prefix.
|
|
|
|
\sa showProposal()
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::closeProposal()
|
|
|
|
Closes the proposal.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::setIsSynchronized(bool isSync)
|
|
|
|
Sets whether this widget is synchronized. If a widget is synchronized it means that from
|
|
the moment a proposal started being computed until the moment it is actually displayed,
|
|
there was no content input into the underlying widget.
|
|
|
|
A widget is not synchronized in the case a proposal is computed in a separate thread and
|
|
in the meanwhile (while it is still being processed) content is input into the underlying
|
|
widget.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::prefixExpanded(const QString &newPrefix)
|
|
|
|
The signal is emitted whenever this widget automatically expands the prefix of the proposal.
|
|
This can happen if all available proposal items share the same prefix and if the proposal's
|
|
model supports prefix expansion.
|
|
|
|
\sa GenericProposalModel::supportsPrefixExpansion()
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::IAssistProposalWidget::proposalItemActivated(AssistProposalItem *proposalItem)
|
|
|
|
This signal is emitted whenever \a proposalItem is chosen to be applied.
|
|
*/
|