QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
A text editor based on QScintilla2. More...
#include <qgscodeeditor.h>
Public Types | |
enum class | Flag : int { CodeFolding = 1 << 0 } |
Flags controlling behavior of code editor. More... | |
enum class | MarginRole : int { LineNumbers = 0 , ErrorIndicators = 1 , FoldingControls = 2 } |
Margin roles. More... | |
Public Slots | |
virtual void | moveCursorToEnd () |
Moves the cursor to the end of the document and scrolls to ensure it is visible. More... | |
virtual void | moveCursorToStart () |
Moves the cursor to the start of the document and scrolls to ensure it is visible. More... | |
Public Member Functions | |
QgsCodeEditor (QWidget *parent=nullptr, const QString &title=QString(), bool folding=false, bool margin=false, QgsCodeEditor::Flags flags=QgsCodeEditor::Flags()) | |
Flags controlling behavior of code editor. More... | |
void | addWarning (int lineNumber, const QString &warning) |
Adds a warning message and indicator to the specified a lineNumber. More... | |
void | clearWarnings () |
Clears all warning messages from the editor. More... | |
bool | foldingVisible () |
Returns true if the folding controls are visible in the editor. More... | |
void | insertText (const QString &text) |
Insert text at cursor position, or replace any selected text if user has made a selection. More... | |
bool | isCursorOnLastLine () const |
Returns true if the cursor is on the last line of the document. More... | |
bool | lineNumbersVisible () const |
Returns whether line numbers are visible in the editor. More... | |
Q_DECL_DEPRECATED bool | marginVisible () |
Returns whether margins are in a visible state. More... | |
void | setCustomAppearance (const QString &scheme=QString(), const QMap< QgsCodeEditorColorScheme::ColorRole, QColor > &customColors=QMap< QgsCodeEditorColorScheme::ColorRole, QColor >(), const QString &fontFamily=QString(), int fontSize=0) |
Sets a custom appearance for the widget, disconnecting it from using the standard appearance taken from QSettings. More... | |
void | setFoldingVisible (bool folding) |
Set whether the folding controls are visible in the editor. More... | |
void | setLineNumbersVisible (bool visible) |
Sets whether line numbers should be visible in the editor. More... | |
Q_DECL_DEPRECATED void | setMarginVisible (bool margin) |
Set margin visible state. More... | |
void | setTitle (const QString &title) |
Set the widget title. More... | |
Static Public Member Functions | |
static QColor | color (QgsCodeEditorColorScheme::ColorRole role) |
Returns the color to use in the editor for the specified role. More... | |
static QColor | defaultColor (QgsCodeEditorColorScheme::ColorRole role, const QString &theme=QString()) |
Returns the default color for the specified role. More... | |
static QFont | getMonospaceFont () |
Returns the monospaced font to use for code editors. More... | |
static void | setColor (QgsCodeEditorColorScheme::ColorRole role, const QColor &color) |
Sets the color to use in the editor for the specified role. More... | |
Protected Member Functions | |
void | focusOutEvent (QFocusEvent *event) override |
virtual void | initializeLexer () |
Called when the dialect specific code lexer needs to be initialized (or reinitialized). More... | |
bool | isFixedPitch (const QFont &font) |
void | keyPressEvent (QKeyEvent *event) override |
QColor | lexerColor (QgsCodeEditorColorScheme::ColorRole role) const |
Returns the color to use in the lexer for the specified role. More... | |
QFont | lexerFont () const |
Returns the font to use in the lexer. More... | |
void | runPostLexerConfigurationTasks () |
Performs tasks which must be run after a lexer has been set for the widget. More... | |
A text editor based on QScintilla2.
Definition at line 41 of file qgscodeeditor.h.
|
strong |
Flags controlling behavior of code editor.
Enumerator | |
---|---|
CodeFolding | Indicates that code folding should be enabled for the editor. |
Definition at line 67 of file qgscodeeditor.h.
|
strong |
Margin roles.
This enum contains the roles which the different numbered margins are used for.
Enumerator | |
---|---|
LineNumbers | Line numbers. |
ErrorIndicators | Error indicators. |
FoldingControls | Folding controls. |
Definition at line 54 of file qgscodeeditor.h.
QgsCodeEditor::QgsCodeEditor | ( | QWidget * | parent = nullptr , |
const QString & | title = QString() , |
||
bool | folding = false , |
||
bool | margin = false , |
||
QgsCodeEditor::Flags | flags = QgsCodeEditor::Flags() |
||
) |
Flags controlling behavior of code editor.
parent | The parent QWidget |
title | The title to show in the code editor dialog |
folding | false: Enable folding for code editor (deprecated, use flags instead) |
margin | false: Enable margin for code editor (deprecated) |
flags | flags controlling behavior of code editor (since QGIS 3.28) |
Definition at line 72 of file qgscodeeditor.cpp.
void QgsCodeEditor::addWarning | ( | int | lineNumber, |
const QString & | warning | ||
) |
Adds a warning message and indicator to the specified a lineNumber.
Definition at line 516 of file qgscodeeditor.cpp.
void QgsCodeEditor::clearWarnings | ( | ) |
Clears all warning messages from the editor.
Definition at line 531 of file qgscodeeditor.cpp.
|
static |
Returns the color to use in the editor for the specified role.
This color will be the default theme color for the role, unless the user has manually selected a custom color scheme for the editor.
Definition at line 437 of file qgscodeeditor.cpp.
|
static |
Returns the default color for the specified role.
The optional theme argument can be used to specify a color theme. A blank theme indicates the default color scheme.
Available themes are stored in QgsCodeEditorColorSchemeRegistry, and can be retrieved via QgsGui::codeEditorColorSchemeRegistry().
Definition at line 368 of file qgscodeeditor.cpp.
|
overrideprotected |
Definition at line 110 of file qgscodeeditor.cpp.
bool QgsCodeEditor::foldingVisible | ( | ) |
Returns true
if the folding controls are visible in the editor.
Definition at line 331 of file qgscodeeditor.cpp.
|
static |
Returns the monospaced font to use for code editors.
Definition at line 471 of file qgscodeeditor.cpp.
|
protectedvirtual |
Called when the dialect specific code lexer needs to be initialized (or reinitialized).
The default implementation does nothing.
Reimplemented in QgsCodeEditorCSS, QgsCodeEditorExpression, QgsCodeEditorHTML, QgsCodeEditorJavascript, QgsCodeEditorJson, QgsCodeEditorPython, and QgsCodeEditorSQL.
Definition at line 153 of file qgscodeeditor.cpp.
void QgsCodeEditor::insertText | ( | const QString & | text | ) |
Insert text at cursor position, or replace any selected text if user has made a selection.
text | The text to be inserted |
Definition at line 352 of file qgscodeeditor.cpp.
bool QgsCodeEditor::isCursorOnLastLine | ( | ) | const |
Returns true
if the cursor is on the last line of the document.
Definition at line 542 of file qgscodeeditor.cpp.
|
protected |
Definition at line 466 of file qgscodeeditor.cpp.
|
overrideprotected |
Definition at line 140 of file qgscodeeditor.cpp.
|
protected |
Returns the color to use in the lexer for the specified role.
Definition at line 158 of file qgscodeeditor.cpp.
|
protected |
Returns the font to use in the lexer.
Definition at line 174 of file qgscodeeditor.cpp.
bool QgsCodeEditor::lineNumbersVisible | ( | ) | const |
Returns whether line numbers are visible in the editor.
Definition at line 313 of file qgscodeeditor.cpp.
|
inline |
Returns whether margins are in a visible state.
Definition at line 110 of file qgscodeeditor.h.
|
virtualslot |
Moves the cursor to the end of the document and scrolls to ensure it is visible.
Definition at line 557 of file qgscodeeditor.cpp.
|
virtualslot |
Moves the cursor to the start of the document and scrolls to ensure it is visible.
Definition at line 550 of file qgscodeeditor.cpp.
|
protected |
Performs tasks which must be run after a lexer has been set for the widget.
Definition at line 207 of file qgscodeeditor.cpp.
|
static |
Sets the color to use in the editor for the specified role.
This color will be stored as the new default color for the role, to be used for all code editors.
Set color to an invalid QColor in order to clear the stored color value and reset it to the default color.
Definition at line 452 of file qgscodeeditor.cpp.
void QgsCodeEditor::setCustomAppearance | ( | const QString & | scheme = QString() , |
const QMap< QgsCodeEditorColorScheme::ColorRole, QColor > & | customColors = QMap< QgsCodeEditorColorScheme::ColorRole, QColor >() , |
||
const QString & | fontFamily = QString() , |
||
int | fontSize = 0 |
||
) |
Sets a custom appearance for the widget, disconnecting it from using the standard appearance taken from QSettings.
Definition at line 503 of file qgscodeeditor.cpp.
void QgsCodeEditor::setFoldingVisible | ( | bool | folding | ) |
Set whether the folding controls are visible in the editor.
Definition at line 318 of file qgscodeeditor.cpp.
void QgsCodeEditor::setLineNumbersVisible | ( | bool | visible | ) |
Sets whether line numbers should be visible in the editor.
Defaults to false
.
Definition at line 294 of file qgscodeeditor.cpp.
void QgsCodeEditor::setMarginVisible | ( | bool | margin | ) |
Set margin visible state.
margin | Set margin in the editor |
Definition at line 273 of file qgscodeeditor.cpp.
void QgsCodeEditor::setTitle | ( | const QString & | title | ) |
Set the widget title.
title | widget title |
Definition at line 268 of file qgscodeeditor.cpp.