QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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, QString title="", bool folding=false, bool margin=false)
 Construct a new code editor. More...
 
 ~QgsCodeEditor ()
 
void setTitle (QString)
 Set the widget title. More...
 
void setMarginVisible (bool margin)
 Set margin visible state. More...
 
bool marginVisible ()
 
void setFoldingVisible (bool folding)
 Set folding visible state. More...
 
bool foldingVisible ()
 

Additional Inherited Members

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

Detailed Description

A Python editor based on QScintilla2.

Adds syntax highlighting and code autocompletion.

Note
added in 2.6

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
QgsCodeEditorPython::~QgsCodeEditorPython ( )

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
bool QgsCodeEditorPython::loadScript ( const QString &  script)

Load a script file.

Parameters
scriptThe script file to load

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