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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/codeeditors/qgscodeeditorpython.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsCodeEditorPython : QgsCodeEditor
{
%Docstring(signature="appended")
A Python editor based on QScintilla2. Adds syntax highlighting and code
autocompletion.
.. note::
may not be available in Python bindings, depending on platform support
%End
%TypeHeaderCode
#include "qgscodeeditorpython.h"
%End
public:
QgsCodeEditorPython( QWidget *parent /TransferThis/ = 0, const QList<QString> &filenames = QList<QString>(), QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor, QgsCodeEditor::Flags flags = QgsCodeEditor::Flag::CodeFolding );
%Docstring
Construct a new Python editor.
:param parent: The parent QWidget
:param filenames: The list of apis files to load for the Python lexer
:param mode: code editor mode (since QGIS 3.30)
:param flags: code editor flags (since QGIS 3.32)
%End
virtual Qgis::ScriptLanguage language() const;
virtual Qgis::ScriptLanguageCapabilities languageCapabilities() const;
void loadAPIs( const QList<QString> &filenames );
%Docstring
Load APIs from one or more files
:param filenames: The list of apis files to load for the Python lexer
%End
bool loadScript( const QString &script );
%Docstring
Loads a ``script`` file.
%End
bool isCursorInsideStringLiteralOrComment() const;
%Docstring
Check whether the current cursor position is inside a string literal or
a comment
.. versionadded:: 3.30
%End
QString characterBeforeCursor() const;
%Docstring
Returns the character before the cursor, or an empty string if cursor is
set at start
.. versionadded:: 3.30
%End
QString characterAfterCursor() const;
%Docstring
Returns the character after the cursor, or an empty string if the cursor
is set at end
.. versionadded:: 3.30
%End
void updateCapabilities();
%Docstring
Updates the editor capabilities.
.. versionadded:: 3.32
%End
virtual bool checkSyntax();
public slots:
void searchSelectedTextInPyQGISDocs();
%Docstring
Searches the selected text in the official PyQGIS online documentation.
.. versionadded:: 3.16
%End
virtual void toggleComment();
%Docstring
Toggle comment for the selected text.
.. versionadded:: 3.30
%End
protected:
virtual void initializeLexer();
virtual void keyPressEvent( QKeyEvent *event );
virtual QString reformatCodeString( const QString &string );
virtual void populateContextMenu( QMenu *menu );
protected slots:
void autoComplete();
%Docstring
Triggers the autocompletion popup.
.. versionadded:: 3.16
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/codeeditors/qgscodeeditorpython.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
