QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Member Functions | Protected Member Functions | List of all members
QgsCodeEditorExpression Class Reference

A QGIS expression editor based on QScintilla2. More...

#include <qgscodeeditorexpression.h>

Inheritance diagram for QgsCodeEditorExpression:
Inheritance graph
[legend]

Public Member Functions

 QgsCodeEditorExpression (QWidget *parent=nullptr)
 Constructor for QgsCodeEditorExpression. More...
 
void setExpressionContext (const QgsExpressionContext &context)
 Variables and functions from this expression context will be added to the API. More...
 
void setFields (const QgsFields &fields)
 Field names will be added to the API. More...
 
- Public Member Functions inherited from QgsCodeEditor
 QgsCodeEditor (QWidget *parent=nullptr, const QString &title=QString(), bool folding=false, bool margin=false)
 Construct a new 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 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...
 

Protected Member Functions

void initializeLexer () override
 Called when the dialect specific code lexer needs to be initialized (or reinitialized). More...
 
- Protected Member Functions inherited from QgsCodeEditor
void focusOutEvent (QFocusEvent *event) override
 
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...
 

Additional Inherited Members

- Public Types inherited from QgsCodeEditor
enum  MarginRole { LineNumbers = 0, ErrorIndicators = 1, FoldingControls = 2 }
 Margin roles. More...
 
- Static Public Member Functions inherited from QgsCodeEditor
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...
 

Detailed Description

A QGIS expression editor based on QScintilla2.

Adds syntax highlighting and code autocompletion.

Since
QGIS 3.4

Definition at line 36 of file qgscodeeditorexpression.h.

Constructor & Destructor Documentation

◆ QgsCodeEditorExpression()

QgsCodeEditorExpression::QgsCodeEditorExpression ( QWidget *  parent = nullptr)

Constructor for QgsCodeEditorExpression.

Definition at line 23 of file qgscodeeditorexpression.cpp.

Member Function Documentation

◆ initializeLexer()

void QgsCodeEditorExpression::initializeLexer ( )
overrideprotectedvirtual

Called when the dialect specific code lexer needs to be initialized (or reinitialized).

The default implementation does nothing.

Since
QGIS 3.16

Reimplemented from QgsCodeEditor.

Definition at line 100 of file qgscodeeditorexpression.cpp.

◆ setExpressionContext()

void QgsCodeEditorExpression::setExpressionContext ( const QgsExpressionContext context)

Variables and functions from this expression context will be added to the API.

Will also reload all globally registered functions.

Definition at line 35 of file qgscodeeditorexpression.cpp.

◆ setFields()

void QgsCodeEditorExpression::setFields ( const QgsFields fields)

Field names will be added to the API.

Definition at line 88 of file qgscodeeditorexpression.cpp.


The documentation for this class was generated from the following files: