QGIS/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in
Yoann Quenach de Quivillic 1c79b4927d
[feature][console] Add toggle comment action in the python console (#50341)
Adds a toggle comment action in the Python Console and script editors
2023-01-07 09:27:08 +10:00

99 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/codeeditors/qgscodeeditorpython.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsCodeEditorPython : QgsCodeEditor
{
%Docstring(signature="appended")
A Python editor based on QScintilla2. Adds syntax highlighting and
code autocompletion.
.. note::
may not be available in Python bindings, depending on platform support
.. versionadded:: 2.6
%End
%TypeHeaderCode
#include "qgscodeeditorpython.h"
%End
public:
QgsCodeEditorPython( QWidget *parent /TransferThis/ = 0, const QList<QString> &filenames = QList<QString>(),
QgsCodeEditor::Mode mode = QgsCodeEditor::Mode::ScriptEditor );
%Docstring
Construct a new Python editor.
:param parent: The parent QWidget
:param filenames: The list of apis files to load for the Python lexer
:param mode: code editor mode (since QGIS 3.30)
.. versionadded:: 2.6
%End
virtual Qgis::ScriptLanguage language() const;
void loadAPIs( const QList<QString> &filenames );
%Docstring
Load APIs from one or more files
:param filenames: The list of apis files to load for the Python lexer
%End
bool loadScript( const QString &script );
%Docstring
Loads a ``script`` file.
%End
public slots:
void searchSelectedTextInPyQGISDocs();
%Docstring
Searches the selected text in the official PyQGIS online documentation.
.. versionadded:: 3.16
%End
void toggleComment();
%Docstring
Toggle comment for the selected text.
.. versionadded:: 3.30
%End
protected:
virtual void initializeLexer();
virtual void keyPressEvent( QKeyEvent *event );
protected slots:
void autoComplete();
%Docstring
Triggers the autocompletion popup.
.. versionadded:: 3.16
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/codeeditors/qgscodeeditorpython.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/