MeVisLab Scripting Reference
MLABIDEMainWindow Class Reference

#include <mlabIDEMainWindow.h>

Public Slots

Access to IDE features.
MLABIDENetworkWindow * currentDocument ()
void setCurrentDocument (MLABIDENetworkWindow *window)
bool hasOpenDocuments ()
QList< MLABNetwork * > getOpenNetworks ()
QList< MLABIDENetworkWindow * > getOpenDocuments ()
MLABIDENetworkWindow * newDocument ()
MLABIDENetworkWindow * ensureEmptyDocument ()
void load ()
void save ()
void saveAs ()
void saveCopyAs ()
void revertToSaved ()
void closeCurrentDocument (bool closeWithRequester=true)
void closeAll (bool silent=false)
void activateNextDocument ()
void activatePrevDocument ()
void activateNextDocumentViaTabKey ()
void activatePrevDocumentViaTabKey ()
void openInternalNetwork (MLABMacroModule *module, bool centerToSelection=true, bool openNetworkTabAfterCurrentNetworkTab=false)
bool closeInternalNetworkWithRequester (MLABMacroModule *module)
void closeInternalNetwork (MLABMacroModule *module)
void showDocumentForNetwork (MLABNetwork *network, bool centerToSelection=true)
MLABIDENetworkWindow * loadDocument (const QString &fn, bool ignoreAutoSaveFile=false)
MLABIDENetworkWindow * getDocumentForFilename (const QString &fn)
MLABIDENetworkWindow * getDocumentForMacro (MLABMacroModule *macro)
MLABIDENetworkWindow * getDocumentForNetwork (MLABNetwork *network)
void makeVisible ()
void about ()
QString recentNetworkFilePath ()
QStringList recentNetworkFiles ()
void addRecentlyOpened (const QString &fileName)
void addRecentTestCase (const QString &name, const QVariantMap &settings)
void runTestCase (const QString &name, const QVariantMap &settings)
void runLastTestCase ()
void restartWithCurrentNetwork ()
void launchNewInstance ()
void message (const QString &msg=QString())
void showShortlivedMessage (const QString &msg)
void showOpenPanelsForNetwork (MLABNetwork *network)
void minimizeAllOpenVisiblePanels ()
void showAllMinimizedPanelsNormal ()
bool closeAllPanels ()
void closePanelsOfCurrentNetwork ()
void undo ()
void runUserScript (const QString &filename, const QStringList &args=QStringList())
void closeRunningApplication (const QString &name)
bool activateDockPreset (const QString &name)
QStringList allDockPresetNames ()

Detailed Description

Main application window for the MDI interface of MLAB.

Only one instance of the MLABIDEMainWindow is created and can be accessed by calling the self() method. The main window contains a number of docking windows and stores its state with MLABSettings. It automatically creates its menus and toolbars from the mlabPrefs globalTree.

Member Function Documentation

◆ about

void MLABIDEMainWindow::about ( )
slot

Shows the 'about' dialog.

◆ activateDockPreset

bool MLABIDEMainWindow::activateDockPreset ( const QString & name)
slot

Activates dock preset given as argument - returns false if preset name is not found.

Referenced by allDockPresetNames().

◆ activateNextDocument

void MLABIDEMainWindow::activateNextDocument ( )
slot

Shows next window.

◆ activateNextDocumentViaTabKey

void MLABIDEMainWindow::activateNextDocumentViaTabKey ( )
slot

Shows next window.

◆ activatePrevDocument

void MLABIDEMainWindow::activatePrevDocument ( )
slot

Shows previous window.

◆ activatePrevDocumentViaTabKey

void MLABIDEMainWindow::activatePrevDocumentViaTabKey ( )
slot

Shows previous window.

◆ addRecentlyOpened

void MLABIDEMainWindow::addRecentlyOpened ( const QString & fileName)
slot

Adds the recently opened file to the file list.

◆ addRecentTestCase

void MLABIDEMainWindow::addRecentTestCase ( const QString & name,
const QVariantMap & settings )
slot

Adds the recently started test case.

◆ allDockPresetNames

QStringList MLABIDEMainWindow::allDockPresetNames ( )
slot

Return name of all dock presets.

References activateDockPreset().

◆ closeAll

void MLABIDEMainWindow::closeAll ( bool silent = false)
slot

Closes all open document windows. If the flag silent is set to tru, all windows will be closed without a saving prompt for changed windows.

◆ closeAllPanels

bool MLABIDEMainWindow::closeAllPanels ( )
slot

Closes all panels.

◆ closeCurrentDocument

void MLABIDEMainWindow::closeCurrentDocument ( bool closeWithRequester = true)
slot

Closes current document window.

◆ closeInternalNetwork

void MLABIDEMainWindow::closeInternalNetwork ( MLABMacroModule * module)
slot

Closes the internal network document if not already done by user.

◆ closeInternalNetworkWithRequester

bool MLABIDEMainWindow::closeInternalNetworkWithRequester ( MLABMacroModule * module)
slot

Close the internal network, but the user can abort this (if the internal network has changed). Returns whether the network should actually be closed.

◆ closePanelsOfCurrentNetwork

void MLABIDEMainWindow::closePanelsOfCurrentNetwork ( )
slot

Closes all panels of the current network.

◆ closeRunningApplication

void MLABIDEMainWindow::closeRunningApplication ( const QString & name)
slot

Allows to close a running application, e.g., "TestCaseManager".

◆ currentDocument

MLABIDENetworkWindow * MLABIDEMainWindow::currentDocument ( )
slot

Returns the current document (may be NULL).

◆ ensureEmptyDocument

MLABIDENetworkWindow * MLABIDEMainWindow::ensureEmptyDocument ( )
slot

Makes sure there is an unnamed and empty network windows that is visible.

◆ getDocumentForFilename

MLABIDENetworkWindow * MLABIDEMainWindow::getDocumentForFilename ( const QString & fn)
slot

Returns the document window if the file is already opened, else returns NULL.

◆ getDocumentForMacro

MLABIDENetworkWindow * MLABIDEMainWindow::getDocumentForMacro ( MLABMacroModule * macro)
slot

Returns the document for an opened internal network of the given macro module.

◆ getDocumentForNetwork

MLABIDENetworkWindow * MLABIDEMainWindow::getDocumentForNetwork ( MLABNetwork * network)
slot

Returns the document for an opened network (which can be either an untitled or named loaded .mlab file, or the internal network of a macro.) Returns NULL if the IDE has not open document for the given network.

◆ getOpenDocuments

QList< MLABIDENetworkWindow * > MLABIDEMainWindow::getOpenDocuments ( )
slot

Returns a list of all open documents.

◆ getOpenNetworks

QList< MLABNetwork * > MLABIDEMainWindow::getOpenNetworks ( )
slot

Returns a list of all open networks.

◆ hasOpenDocuments

bool MLABIDEMainWindow::hasOpenDocuments ( )
slot

Returns whether loaded documents exist.

◆ launchNewInstance

void MLABIDEMainWindow::launchNewInstance ( )
slot

Launches a new instance of MeVisLab.

◆ load

void MLABIDEMainWindow::load ( )
slot

Loads a document with a dialog.

◆ loadDocument

MLABIDENetworkWindow * MLABIDEMainWindow::loadDocument ( const QString & fn,
bool ignoreAutoSaveFile = false )
slot

Loads the document given by filename, and returns the new or existing window.

◆ makeVisible

void MLABIDEMainWindow::makeVisible ( )
slot

Shows this main IDE window again if it was hidden or not previously shown.

◆ message

void MLABIDEMainWindow::message ( const QString & msg = QString())
slot

Shows a message in the status bar.

◆ minimizeAllOpenVisiblePanels

void MLABIDEMainWindow::minimizeAllOpenVisiblePanels ( )
slot

Minimizes all open and visible panels.

◆ newDocument

MLABIDENetworkWindow * MLABIDEMainWindow::newDocument ( )
slot

Creates an empty untitled document.

◆ openInternalNetwork

void MLABIDEMainWindow::openInternalNetwork ( MLABMacroModule * module,
bool centerToSelection = true,
bool openNetworkTabAfterCurrentNetworkTab = false )
slot

Opens the internal network of the MLABMacroModule as document (special handling compared to normal documents).

◆ recentNetworkFilePath

QString MLABIDEMainWindow::recentNetworkFilePath ( )
slot

Returns the recent network file path.

◆ recentNetworkFiles

QStringList MLABIDEMainWindow::recentNetworkFiles ( )
inlineslot

Returns a list of recent network files.

◆ restartWithCurrentNetwork

void MLABIDEMainWindow::restartWithCurrentNetwork ( )
slot

Restarts MeVisLab with the current network file.

◆ revertToSaved

void MLABIDEMainWindow::revertToSaved ( )
slot

Reverts to saved copy.

◆ runLastTestCase

void MLABIDEMainWindow::runLastTestCase ( )
slot

Runs the last test case that has been executed.

◆ runTestCase

void MLABIDEMainWindow::runTestCase ( const QString & name,
const QVariantMap & settings )
slot

Runs the test case with the given settings.

◆ runUserScript

void MLABIDEMainWindow::runUserScript ( const QString & filename,
const QStringList & args = QStringList() )
slot

Runs the given userScript (also records the filename as last executed user script).

◆ save

void MLABIDEMainWindow::save ( )
slot

Saves the document.

◆ saveAs

void MLABIDEMainWindow::saveAs ( )
slot

Save as file.

◆ saveCopyAs

void MLABIDEMainWindow::saveCopyAs ( )
slot

Saves file to...

◆ setCurrentDocument

void MLABIDEMainWindow::setCurrentDocument ( MLABIDENetworkWindow * window)
slot

Sets the current document.

◆ showAllMinimizedPanelsNormal

void MLABIDEMainWindow::showAllMinimizedPanelsNormal ( )
slot

Opens all minimized panels in normal mode.

◆ showDocumentForNetwork

void MLABIDEMainWindow::showDocumentForNetwork ( MLABNetwork * network,
bool centerToSelection = true )
slot

Shows the document window for the given network.

◆ showOpenPanelsForNetwork

void MLABIDEMainWindow::showOpenPanelsForNetwork ( MLABNetwork * network)
slot

Shows all opened panels for the given network.

◆ showShortlivedMessage

void MLABIDEMainWindow::showShortlivedMessage ( const QString & msg)
slot

Shows a short-lived message in the status bar.

◆ undo

void MLABIDEMainWindow::undo ( )
slot

Forwarded calls: