QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgscodeeditorsql.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgscodeeditorsql.cpp - A SQL 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 #include "qgsapplication.h"
17 #include "qgscodeeditorsql.h"
18 #include "qgssymbollayerutils.h"
19 
20 #include <QWidget>
21 #include <QString>
22 #include <QFont>
23 
24 
26  : QgsCodeEditor( parent )
27 {
28  if ( !parent )
29  {
30  setTitle( tr( "SQL Editor" ) );
31  }
32  setFoldingVisible( false );
33  setAutoCompletionCaseSensitivity( false );
34  QgsCodeEditorSQL::initializeLexer(); // avoid cppcheck warning by explicitly specifying namespace
35 }
36 
38 {
39  QFont font = lexerFont();
41 
42  mSqlLexer = new QgsCaseInsensitiveLexerSQL( this );
43  mSqlLexer->setDefaultFont( font );
44  mSqlLexer->setDefaultColor( defaultColor );
45  mSqlLexer->setDefaultPaper( lexerColor( QgsCodeEditorColorScheme::ColorRole::Background ) );
46  mSqlLexer->setFont( font, -1 );
47  font.setBold( true );
48  mSqlLexer->setFont( font, QsciLexerSQL::Keyword );
49 
50  font.setBold( false );
51  font.setItalic( true );
52  mSqlLexer->setFont( font, QsciLexerSQL::Comment );
53  mSqlLexer->setFont( font, QsciLexerSQL::CommentLine );
54 
55  mSqlLexer->setColor( defaultColor, QsciLexerSQL::Default );
56  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::Comment ), QsciLexerSQL::Comment );
57  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::CommentLine ), QsciLexerSQL::CommentLine );
58  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::Number ), QsciLexerSQL::Number );
59  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::Keyword ), QsciLexerSQL::Keyword );
60  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::SingleQuote ), QsciLexerSQL::SingleQuotedString );
61  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::DoubleQuote ), QsciLexerSQL::DoubleQuotedString );
62  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::Operator ), QsciLexerSQL::Operator );
63  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::Identifier ), QsciLexerSQL::Identifier );
64  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::QuotedIdentifier ), QsciLexerSQL::QuotedIdentifier );
65  mSqlLexer->setColor( lexerColor( QgsCodeEditorColorScheme::ColorRole::QuotedOperator ), QsciLexerSQL::QuotedOperator );
66 
67  setLexer( mSqlLexer );
68 
70 }
71 
73 {
74  mFieldNames.clear();
75 
76  for ( const QgsField &field : fields )
77  {
78  mFieldNames << field.name();
79  }
80 
81  updateApis();
82 }
83 
84 void QgsCodeEditorSQL::updateApis()
85 {
86  mApis = new QsciAPIs( mSqlLexer );
87 
88  for ( const QString &fieldName : qgis::as_const( mFieldNames ) )
89  {
90  mApis->add( fieldName );
91  }
92 
93  mApis->prepare();
94  mSqlLexer->setAPIs( mApis );
95 }
QgsCodeEditor::lexerColor
QColor lexerColor(QgsCodeEditorColorScheme::ColorRole role) const
Returns the color to use in the lexer for the specified role.
Definition: qgscodeeditor.cpp:154
QgsCodeEditorColorScheme::ColorRole::Default
@ Default
Default text color.
QgsCodeEditorColorScheme::ColorRole::CommentLine
@ CommentLine
Line comment color.
qgssymbollayerutils.h
QgsFields
Container of fields for a vector layer.
Definition: qgsfields.h:45
QgsCodeEditor
A text editor based on QScintilla2.
Definition: qgscodeeditor.h:42
QgsCodeEditorColorScheme::ColorRole::Operator
@ Operator
Operator color.
field
const QgsField & field
Definition: qgsfield.h:456
QgsField::name
QString name
Definition: qgsfield.h:59
QgsCodeEditorColorScheme::ColorRole::SingleQuote
@ SingleQuote
Single quote color.
QgsCodeEditor::setTitle
void setTitle(const QString &title)
Set the widget title.
Definition: qgscodeeditor.cpp:259
qgsapplication.h
QgsCodeEditorColorScheme::ColorRole::DoubleQuote
@ DoubleQuote
Double quote color.
QgsCodeEditorColorScheme::ColorRole::Comment
@ Comment
Comment color.
QgsCodeEditor::lexerFont
QFont lexerFont() const
Returns the font to use in the lexer.
Definition: qgscodeeditor.cpp:170
QgsCodeEditorSQL::initializeLexer
void initializeLexer() override
Called when the dialect specific code lexer needs to be initialized (or reinitialized).
Definition: qgscodeeditorsql.cpp:37
QgsCodeEditor::runPostLexerConfigurationTasks
void runPostLexerConfigurationTasks()
Performs tasks which must be run after a lexer has been set for the widget.
Definition: qgscodeeditor.cpp:203
QgsCodeEditorColorScheme::ColorRole::Number
@ Number
Number color.
QgsCodeEditorColorScheme::ColorRole::Identifier
@ Identifier
Identifier color.
QgsCodeEditorColorScheme::ColorRole::QuotedOperator
@ QuotedOperator
Quoted operator color.
qgscodeeditorsql.h
QgsCodeEditor::defaultColor
static QColor defaultColor(QgsCodeEditorColorScheme::ColorRole role, const QString &theme=QString())
Returns the default color for the specified role.
Definition: qgscodeeditor.cpp:342
QgsCodeEditorSQL::QgsCodeEditorSQL
QgsCodeEditorSQL(QWidget *parent=nullptr)
Constructor for QgsCodeEditorSQL.
Definition: qgscodeeditorsql.cpp:25
QgsCodeEditorColorScheme::ColorRole::QuotedIdentifier
@ QuotedIdentifier
Quoted identifier color.
QgsCodeEditorSQL::setFields
void setFields(const QgsFields &fields)
Set field names to be added to the lexer API.
Definition: qgscodeeditorsql.cpp:72
QgsCodeEditor::setFoldingVisible
void setFoldingVisible(bool folding)
Set whether the folding controls are visible in the editor.
Definition: qgscodeeditor.cpp:309
QgsCodeEditorColorScheme::ColorRole::Background
@ Background
Background color.
QgsCodeEditorColorScheme::ColorRole::Keyword
@ Keyword
Keyword color.
QgsField
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:50