-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgscodeeditorpython.h
89 lines (70 loc) · 2.47 KB
/
qgscodeeditorpython.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/***************************************************************************
qgscodeeditorpython.h - A Python editor based on QScintilla
--------------------------------------
Date : 06-Oct-2013
Copyright : (C) 2013 by Salvatore Larosa
Email : lrssvtml (at) gmail (dot) com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSCODEEDITORPYTHON_H
#define QGSCODEEDITORPYTHON_H
#include "qgscodeeditor.h"
#include "qgis_sip.h"
#include "qgis_gui.h"
SIP_IF_MODULE( HAVE_QSCI_SIP )
/**
* \ingroup gui
* A Python editor based on QScintilla2. Adds syntax highlighting and
* code autocompletion.
* \note may not be available in Python bindings, depending on platform support
* \since QGIS 2.6
*/
class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor
{
Q_OBJECT
public:
/**
* Construct a new Python editor.
*
* \param parent The parent QWidget
* \param filenames The list of apis files to load for the Python lexer
* \since QGIS 2.6
*/
QgsCodeEditorPython( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QList<QString> &filenames = QList<QString>() );
/**
* Load APIs from one or more files
* \param filenames The list of apis files to load for the Python lexer
*/
void loadAPIs( const QList<QString> &filenames );
/**
* Load a script file
* \param script The script file to load
*/
bool loadScript( const QString &script );
public slots:
/**
* Searches the selected text in the official PyQGIS online documentation.
*
* \since QGIS 3.16
*/
void searchSelectedTextInPyQGISDocs();
protected:
void initializeLexer() override;
protected slots:
/**
* Triggers the autocompletion popup.
*
* \since QGIS 3.16
*/
void autoComplete();
private:
QList<QString> mAPISFilesList;
QString mPapFile;
};
#endif