codecompletioninterface.h

/*  SPDX-License-Identifier: LGPL-2.0-or-later

    Copyright (C) 2005-2006 Hamish Rodda <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KTEXTEDITOR_CODECOMPLETIONINTERFACE_H
#define KTEXTEDITOR_CODECOMPLETIONINTERFACE_H

#include <QObject>
#include <ktexteditor/range.h>
#include <ktexteditor/codecompletionmodel.h>
#include <ktexteditor_export.h>

namespace KTextEditor
{
class CodeCompletionModel;

class KTEXTEDITOR_EXPORT CodeCompletionInterface
{
public:
    virtual ~CodeCompletionInterface();

    virtual bool isCompletionActive() const = 0;

    virtual void startCompletion(const Range &word, CodeCompletionModel *model) = 0;

    virtual void abortCompletion() = 0;

    virtual void forceCompletion() = 0;

    virtual void registerCompletionModel(CodeCompletionModel *model) = 0;

    virtual void unregisterCompletionModel(CodeCompletionModel *model) = 0;

    virtual bool isAutomaticInvocationEnabled() const = 0;

    virtual void setAutomaticInvocationEnabled(bool enabled = true) = 0;

    // Q_SIGNALS:
    // void completionExecuted(KTextEditor::View* view, const KTextEditor::Cursor& position, KTextEditor::CodeCompletionModel* model, int row);
    // void completionAborted(KTextEditor::View* view);
};

class KTEXTEDITOR_EXPORT CodeCompletionInterfaceV2 : public CodeCompletionInterface
{
    // KF6: Merge KTextEditor::CodeCompletionInterfaceV2 into KTextEditor::CodeCompletionInterface
public:
    virtual ~CodeCompletionInterfaceV2();
    virtual void startCompletion(const Range &word, const QList<CodeCompletionModel *> &models = QList<CodeCompletionModel *>(), CodeCompletionModel::InvocationType invocationType = CodeCompletionModel::ManualInvocation) = 0;
    using CodeCompletionInterface::startCompletion;

    virtual QList<CodeCompletionModel*> codeCompletionModels() const = 0;
};

}

Q_DECLARE_INTERFACE(KTextEditor::CodeCompletionInterface, "org.kde.KTextEditor.CodeCompletionInterface")
Q_DECLARE_INTERFACE(KTextEditor::CodeCompletionInterfaceV2, "org.kde.KTextEditor.CodeCompletionInterfaceV2")

#endif // KTEXTEDITOR_CODECOMPLETIONINTERFACE_H