A HTML editor based on QScintilla2. More...
#include <qgscodeeditorhtml.h>
Inheritance diagram for QgsCodeEditorHTML:
Public Member Functions | |
| QgsCodeEditorHTML (QWidget *parent=nullptr) | |
| Constructor for QgsCodeEditorHTML. More... | |
| Qgis::ScriptLanguage | language () const override |
| Returns the associated scripting language. More... | |
 Public Member Functions inherited from QgsCodeEditor | |
| QgsCodeEditor (QWidget *parent=nullptr, const QString &title=QString(), bool folding=false, bool margin=false, QgsCodeEditor::Flags flags=QgsCodeEditor::Flags(), QgsCodeEditor::Mode mode=QgsCodeEditor::Mode::ScriptEditor) | |
| 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... | |
| QStringList | history () const |
| Returns the list of commands previously executed 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... | |
| QgsCodeInterpreter * | interpreter () const |
Returns the attached code interpreter, or nullptr if not set. More... | |
| bool | isCursorOnLastLine () const |
Returns true if the cursor is on the last line of the document. More... | |
| virtual Qgis::ScriptLanguage | language () const |
| Returns the associated scripting language. 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... | |
| QgsCodeEditor::Mode | mode () const |
| Returns the code editor mode. 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 | setHistoryFilePath (const QString &path) |
| Sets the file path to use for recording and retrieving previously executed commands. More... | |
| void | setInterpreter (QgsCodeInterpreter *newInterpreter) |
| Sets an attached code interpreter for executing commands when the editor is in the QgsCodeEditor::Mode::CommandInput mode. 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 | contextMenuEvent (QContextMenuEvent *event) override |
| void | focusOutEvent (QFocusEvent *event) override |
| virtual void | initializeLexer () |
| Called when the dialect specific code lexer needs to be initialized (or reinitialized). More... | |
| 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... | |
| virtual void | populateContextMenu (QMenu *menu) |
| Called when the context menu for the widget is about to be shown, after it has been fully populated with the standard actions created by the base class. More... | |
| void | runPostLexerConfigurationTasks () |
| Performs tasks which must be run after a lexer has been set for the widget. More... | |
| void | updatePrompt () |
| Triggers an update of the interactive prompt part of the editor. More... | |
| void | updateSoftHistory () |
| Updates the soft history by storing the current editor text in the history. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsCodeEditor | |
| 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... | |
| enum class | Mode { ScriptEditor , OutputDisplay , CommandInput } |
| Code editor modes. More... | |
| Public Slots inherited from QgsCodeEditor | |
| void | clearPersistentHistory () |
| Clears the entire persistent history of commands run in the editor. More... | |
| void | clearSessionHistory () |
| Clears the history of commands run in the current session. More... | |
| 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... | |
| void | removeHistoryCommand (int index) |
| Removes the command at the specified index from the history of the code editor. More... | |
| void | runCommand (const QString &command) |
| Runs a command in the editor. More... | |
| void | showHistory () |
| Shows the command history dialog. More... | |
| void | showNextCommand () |
| Shows the next command from the session in the editor. More... | |
| void | showPreviousCommand () |
| Shows the previous command from the session in the editor. More... | |
| bool | writeHistoryFile () |
| Stores the commands executed in the editor to the persistent history file. More... | |
| Signals inherited from QgsCodeEditor | |
| void | persistentHistoryCleared () |
| Emitted when the persistent history of commands run in the editor is cleared. More... | |
| void | sessionHistoryCleared () |
| Emitted when the history of commands run in the current session is cleared. 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 QString | languageToString (Qgis::ScriptLanguage language) |
| Returns a user-friendly, translated name of the specified script language. More... | |
| static void | setColor (QgsCodeEditorColorScheme::ColorRole role, const QColor &color) |
| Sets the color to use in the editor for the specified role. More... | |
| Static Protected Member Functions inherited from QgsCodeEditor | |
| static bool | isFixedPitch (const QFont &font) |
Returns true if a font is a fixed pitch font. More... | |
Detailed Description
A HTML editor based on QScintilla2.
Adds syntax highlighting and code autocompletion.
- Note
- may not be available in Python bindings, depending on platform support
- Since
- QGIS 2.6
Definition at line 32 of file qgscodeeditorhtml.h.
Constructor & Destructor Documentation
◆ QgsCodeEditorHTML()
| QgsCodeEditorHTML::QgsCodeEditorHTML | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsCodeEditorHTML.
Definition at line 24 of file qgscodeeditorhtml.cpp.
Member Function Documentation
◆ 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 43 of file qgscodeeditorhtml.cpp.
◆ language()
|
overridevirtual |
Returns the associated scripting language.
- Since
- QGIS 3.30
Reimplemented from QgsCodeEditor.
Definition at line 38 of file qgscodeeditorhtml.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.30.0+99sid/src/gui/codeeditors/qgscodeeditorhtml.h
- /build/qgis-3.30.0+99sid/src/gui/codeeditors/qgscodeeditorhtml.cpp
