MATE Class Reference

#include <mlabTextEditorScriptAccess.h>

Inherits QObject.

MATE Script Interface
void	documentCreated (MATEDocument *document)
void	currentDocumentChanged (MATEDocument *document)
void	loadingSessionStarted (const QString &sessionFilename)
void	loadingSessionFinished (const QString &sessionFilename)
void	closingSessionStarted (const QString &sessionFilename)
void	closingSessionFinished (const QString &sessionFilename)
QList< MATEDocument * >	documents ()
MATEDocument *	openDocument (const QString &filename)
MATEDocument *	getDocument (const QString &filename)
MATEDocument *	activeDocument ()
void	showWidgetExplorer ()
void	setNewLogfile (const QString &logFile, bool logAsHTML=false)

Detailed Description

This class is the scripting interface for MATE. It is not available in MeVisLab and should be used in user scripts.

Member Function Documentation

activeDocument

MATEDocument * MATE::activeDocument ( )

slot

Returns the active document, or returns NULL if there is no active document.

closingSessionFinished

void MATE::closingSessionFinished ( const QString & sessionFilename )

signal

This signal is emitted when a session finished closing.

closingSessionStarted

void MATE::closingSessionStarted ( const QString & sessionFilename )

signal

This signal is emitted when a session starts closing.

During this, currentDocumentChanged will be emitted for each closed document.

currentDocumentChanged

void MATE::currentDocumentChanged ( MATEDocument * document )

signal

This signal is emitted when the current document has changed. The document may be NULL if the last document was closed.

documentCreated

void MATE::documentCreated ( MATEDocument * document )

signal

This signal is emitted when a document is created, either by creating a new one or when loading a file.

documents

QList< MATEDocument * > MATE::documents ( )

slot

Returns all open documents.

getDocument

MATEDocument * MATE::getDocument ( const QString & filename )

slot

Returns the document for the given filename, or returns NULL if is not open.

loadingSessionFinished

void MATE::loadingSessionFinished ( const QString & sessionFilename )

signal

This signal is emitted when a session finished loaded.

loadingSessionStarted

void MATE::loadingSessionStarted ( const QString & sessionFilename )

signal

This signal is emitted when a session starts loading.

During this loading, documentCreated will be emitted for each restored document.

openDocument

MATEDocument * MATE::openDocument ( const QString & filename )

slot

Creates a document and opens the given file in it. If it is already open, it will be activated.

setNewLogfile

void MATE::setNewLogfile ( const QString & logFile, bool logAsHTML = false )

slot

Changes the logfile of MATE.

showWidgetExplorer

void MATE::showWidgetExplorer ( )

slot

Shows the widget explorer.