QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
qgscodeeditorpython.h
Go to the documentation of this file.
1/***************************************************************************
2 qgscodeeditorpython.h - A Python editor based on QScintilla
3 --------------------------------------
4 Date : 06-Oct-2013
5 Copyright : (C) 2013 by Salvatore Larosa
6 Email : lrssvtml (at) gmail (dot) com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSCODEEDITORPYTHON_H
17#define QGSCODEEDITORPYTHON_H
18
19#include "qgscodeeditor.h"
20#include "qgis_sip.h"
21#include "qgis_gui.h"
22#include <Qsci/qscilexerpython.h>
23
26
27SIP_IF_MODULE( HAVE_QSCI_SIP )
28
29#ifndef SIP_RUN
31class QgsQsciLexerPython : public QsciLexerPython
32{
33 Q_OBJECT
34 public:
35
36 QgsQsciLexerPython( QObject *parent = nullptr );
37
38 const char *keywords( int set ) const override;
39
40};
42#endif
43
50class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor
51{
52 Q_OBJECT
53
54 public:
55
56#ifndef SIP_RUN
58 static inline QgsSettingsTreeNode *sTreePythonCodeEditor = QgsCodeEditor::sTreeCodeEditor->createChildNode( QStringLiteral( "python" ) );
59 static const QgsSettingsEntryString *settingCodeFormatter;
60 static const QgsSettingsEntryInteger *settingMaxLineLength;
61 static const QgsSettingsEntryBool *settingSortImports;
62 static const QgsSettingsEntryInteger *settingAutopep8Level;
63 static const QgsSettingsEntryBool *settingBlackNormalizeQuotes;
64 static const QgsSettingsEntryString *settingExternalPythonEditorCommand;
66#endif
67
76 QgsCodeEditorPython( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QList<QString> &filenames = QList<QString>(),
78
79 Qgis::ScriptLanguage language() const override;
81
86 void loadAPIs( const QList<QString> &filenames );
87
91 bool loadScript( const QString &script );
92
98 bool isCursorInsideStringLiteralOrComment() const;
99
105 QString characterBeforeCursor() const;
106
112 QString characterAfterCursor() const;
113
119 void updateCapabilities();
120
121 bool checkSyntax() override;
122
123 public slots:
124
130 void searchSelectedTextInPyQGISDocs();
131
137 void toggleComment() override;
138
139 protected:
140
141 void initializeLexer() override;
142 virtual void keyPressEvent( QKeyEvent *event ) override;
143 QString reformatCodeString( const QString &string ) override;
144 void populateContextMenu( QMenu *menu ) override;
145
146 protected slots:
147
153 void autoComplete();
154
155 private:
156
157 QList<QString> mAPISFilesList;
158 QString mPapFile;
159
161
162 static const QMap<QString, QString> sCompletionPairs;
163
164 // Only used for selected text
165 static const QStringList sCompletionSingleCharacters;
166
167};
168
169#endif
ScriptLanguage
Scripting languages.
Definition qgis.h:3884
QFlags< ScriptLanguageCapability > ScriptLanguageCapabilities
Script language capabilities.
Definition qgis.h:3919
A Python editor based on QScintilla2.
A text editor based on QScintilla2.
Mode
Code editor modes.
@ ScriptEditor
Standard mode, allows for display and edit of entire scripts.
virtual void toggleComment()
Toggle comment for the selected text.
void keyPressEvent(QKeyEvent *event) override
virtual void populateContextMenu(QMenu *menu)
Called when the context menu for the widget is about to be shown, after it has been fully populated w...
QFlags< Flag > Flags
Flags controlling behavior of code editor.
static QgsSettingsTreeNode * sTreeCodeEditor
virtual Qgis::ScriptLanguageCapabilities languageCapabilities() const
Returns the associated scripting language capabilities.
virtual void initializeLexer()
Called when the dialect specific code lexer needs to be initialized (or reinitialized).
@ CodeFolding
Indicates that code folding should be enabled for the editor.
virtual Qgis::ScriptLanguage language() const
Returns the associated scripting language.
virtual QString reformatCodeString(const QString &string)
Applies code reformatting to a string and returns the result.
virtual bool checkSyntax()
Applies syntax checking to the editor.
A boolean settings entry.
An integer settings entry.
A string settings entry.
QgsSettingsTreeNode is a tree node for the settings tree to help organizing and introspecting the tre...
QgsSettingsTreeNode * createChildNode(const QString &key)
Creates a normal tree node It will return the existing child node if it exists at the given key.
#define SIP_IF_MODULE(condition)
Definition qgis_sip.h:28
#define SIP_TRANSFERTHIS
Definition qgis_sip.h:53