1// This is the SIP interface definition for QsciAPIs. 2// 3// Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com> 4// 5// This file is part of QScintilla. 6// 7// This file may be used under the terms of the GNU General Public License 8// version 3.0 as published by the Free Software Foundation and appearing in 9// the file LICENSE included in the packaging of this file. Please review the 10// following information to ensure the GNU General Public License version 3.0 11// requirements will be met: http://www.gnu.org/copyleft/gpl.html. 12// 13// If you do not wish to use this file under the terms of the GPL version 3.0 14// then you may purchase a commercial license. For more information contact 15// info@riverbankcomputing.com. 16// 17// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE 18// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 19 20 21class QsciAPIs : QsciAbstractAPIs 22{ 23%TypeHeaderCode 24#include <Qsci/qsciapis.h> 25%End 26 27public: 28 QsciAPIs(QsciLexer *lexer /TransferThis/); 29 virtual ~QsciAPIs(); 30 31 void add(const QString &entry); 32 void clear(); 33 bool load(const QString &fname); 34 void remove(const QString &entry); 35 void prepare(); 36 void cancelPreparation(); 37 QString defaultPreparedName() const; 38 bool isPrepared(const QString &filename = QString()) const; 39 bool loadPrepared(const QString &filename = QString()); 40 bool savePrepared(const QString &filename = QString()) const; 41 virtual bool event(QEvent *e); 42 QStringList installedAPIFiles() const; 43 44 virtual void updateAutoCompletionList(const QStringList &context, 45 QStringList &list /In, Out/); 46 virtual void autoCompletionSelected(const QString &selection); 47 48 virtual QStringList callTips(const QStringList &context, int commas, 49 QsciScintilla::CallTipsStyle style, QList<int> &shifts); 50 51signals: 52 void apiPreparationCancelled(); 53 void apiPreparationStarted(); 54 void apiPreparationFinished(); 55 56private: 57 QsciAPIs(const QsciAPIs &); 58}; 59