QGIS API Documentation  2.12.0-Lyon
Public Member Functions | List of all members
QgsCodeEditorPython Class Reference

A Python editor based on QScintilla2. More...

#include <qgscodeeditorpython.h>

Inheritance diagram for QgsCodeEditorPython:
Inheritance graph
[legend]

Public Member Functions

 QgsCodeEditorPython (QWidget *parent=0, const QList< QString > &filenames=QList< QString >())
 Construct a new Python editor. More...
 
 ~QgsCodeEditorPython ()
 
void loadAPIs (QList< QString > const &filenames)
 Load APIs from one or more files. More...
 
bool loadScript (const QString &script)
 Load a script file. More...
 
- Public Member Functions inherited from QgsCodeEditor
 QgsCodeEditor (QWidget *parent=0, const QString &title="", bool folding=false, bool margin=false)
 Construct a new code editor. More...
 
 ~QgsCodeEditor ()
 
bool foldingVisible ()
 
void insertText (const QString &theText)
 Insert text at cursor position, or replace any selected text if user has made a selection. More...
 
bool marginVisible ()
 
void setFoldingVisible (bool folding)
 Set folding visible state. More...
 
void setMarginVisible (bool margin)
 Set margin visible state. More...
 
void setTitle (const QString &title)
 Set the widget title. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsCodeEditor
QFont getMonospaceFont ()
 
bool isFixedPitch (const QFont &font)
 

Detailed Description

A Python editor based on QScintilla2.

Adds syntax highlighting and code autocompletion.

Note
added in 2.6

Definition at line 27 of file qgscodeeditorpython.h.

Constructor & Destructor Documentation

QgsCodeEditorPython::QgsCodeEditorPython ( QWidget parent = 0,
const QList< QString > &  filenames = QList<QString>() 
)

Construct a new Python editor.

Parameters
parentThe parent QWidget
filenamesThe list of apis files to load for the python lexer
Note
added in 2.6

Definition at line 28 of file qgscodeeditorpython.cpp.

QgsCodeEditorPython::~QgsCodeEditorPython ( )

Definition at line 39 of file qgscodeeditorpython.cpp.

Member Function Documentation

void QgsCodeEditorPython::loadAPIs ( QList< QString > const &  filenames)

Load APIs from one or more files.

Parameters
filenamesThe list of apis files to load for the python lexer

Definition at line 112 of file qgscodeeditorpython.cpp.

bool QgsCodeEditorPython::loadScript ( const QString script)

Load a script file.

Parameters
scriptThe script file to load

Definition at line 119 of file qgscodeeditorpython.cpp.


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