MLABIDENetworkWindow Class Reference

#include <mlabIDENetworkWindow.h>

Scripting access.
MLABUndoManager *	undoManager ()
void	showScriptConsole ()
void	editNetworkScript ()
void	startNetworkScript ()
void	createLocalMacro (const QString &name=QString())
void	addLocalMacro ()
bool	isInternalNetwork ()
MLABMacroModule *	outerMacro ()
MLABMacroModule *	internalMacro ()
void	setCloseSilent (bool flag)
bool	doesCloseSilent ()
bool	hasScriptFile ()
void	reloadAllModules ()
void	updateCaption ()
QString	captionName ()
QString	shortCaptionName ()
void	setOverwriteCaptions (const QString &shortTitleOverwrite="", const QString &fullTitleOverwrite="")
void	clearOverwriteCaptions ()
void	networkScriptWindowClosing ()
void	triggerAutoSave ()
void	removeAutoSaveFile ()
void	runTesterOnNetwork ()
void	showCreateNetworkNoteDialog ()
void	showQuickSearchInNetworkWidget ()
void	setUnnamed ()
bool	isUnnamed ()
void	load (const QString &filename, bool ignoreAutoSaveFile=false)
bool	save ()
bool	saveAs ()
bool	saveCopyAs ()
QString	filename () const override
bool	hasChanged ()
bool	hasRelevantChanges ()
bool	isExpendable ()
bool	hasRelevantRunningBackgroundTasks ()
bool	hasOpenAndChangedInternalNetworkForClosing ()
void	showAll ()
MLABNetwork *	network ()

Detailed Description

Network window used as document in the MLAB MDI interface.

For each opened network, a MLABIDENetworkWindow is added to the workspace of the MLABIDEMainWindow. A network window can be unnamed, have a given file name, and also be an internal network of a macro module.

Member Function Documentation

addLocalMacro()

void MLABIDENetworkWindow::addLocalMacro

(

)

Adds a local macro module.

captionName()

QString MLABIDENetworkWindow::captionName

(

)

Returns 'untitled' or the real name.

clearOverwriteCaptions()

void MLABIDENetworkWindow::clearOverwriteCaptions

(

)

Clears custom captions.

createLocalMacro()

void MLABIDENetworkWindow::createLocalMacro

(

const QString &

name = QString()

)

Creates a local macro module.

doesCloseSilent()

bool MLABIDENetworkWindow::doesCloseSilent ( )

inline

Returns whether the document can be closed without saving or requester.

editNetworkScript()

void MLABIDENetworkWindow::editNetworkScript

(

)

Edits the script for this network (only when network has a filename).

filename

QString MLABIDENetworkWindow::filename ( ) const

overrideslot

Returns the filename as an absolute path.

Referenced by load(), and showQuickSearchInNetworkWidget().

hasChanged

bool MLABIDENetworkWindow::hasChanged ( )

slot

Returns whether the document has changed.

hasOpenAndChangedInternalNetworkForClosing

bool MLABIDENetworkWindow::hasOpenAndChangedInternalNetworkForClosing ( )

slot

Returns whether the network contains any macro with an open and changed internal network that should be saved if the network is closed.

hasRelevantChanges

bool MLABIDENetworkWindow::hasRelevantChanges ( )

slot

Returns whether the document has changes that need to be saved. (This is especially not true if the network is empty and no filename is given!)

hasRelevantRunningBackgroundTasks

bool MLABIDENetworkWindow::hasRelevantRunningBackgroundTasks ( )

slot

Returns whether the network contains any running background tasks (recursively) that would be affected when this network is closed (which is not the case for internal networks).

hasScriptFile()

bool MLABIDENetworkWindow::hasScriptFile

(

)

Returns whether there is a script file for the network.

internalMacro()

MLABMacroModule * MLABIDENetworkWindow::internalMacro ( )

inline

Returns the internal macro if we are showing an internal network.

isExpendable

bool MLABIDENetworkWindow::isExpendable ( )

slot

Returns whether the document can be discarded without losing anything. This means no redo, no modules, no notes, no changes, not title

isInternalNetwork()

bool MLABIDENetworkWindow::isInternalNetwork ( )

inline

Returns whether this module is an internal network.

isUnnamed

bool MLABIDENetworkWindow::isUnnamed ( )

slot

Returns whether this document is unnamed.

load

void MLABIDENetworkWindow::load ( const QString & filename, bool ignoreAutoSaveFile = false )

slot

Loads the document.

References filename().

network

MLABNetwork * MLABIDENetworkWindow::network ( )

inlineslot

Returns the network.

networkScriptWindowClosing()

void MLABIDENetworkWindow::networkScriptWindowClosing

(

)

Handles closing of window created by startNetworkScript.

outerMacro()

MLABMacroModule * MLABIDENetworkWindow::outerMacro ( )

inline

Returns the outer macro.

reloadAllModules()

void MLABIDENetworkWindow::reloadAllModules

(

)

Reloads all the modules in the network (not for internal networks).

removeAutoSaveFile()

void MLABIDENetworkWindow::removeAutoSaveFile

(

)

Removes auto-save file.

Referenced by showQuickSearchInNetworkWidget().

runTesterOnNetwork()

void MLABIDENetworkWindow::runTesterOnNetwork

(

)

Runs the tester on the network.

save

bool MLABIDENetworkWindow::save ( )

slot

Saves document.

saveAs

bool MLABIDENetworkWindow::saveAs ( )

slot

Saves the document with a file dialog.

saveCopyAs

bool MLABIDENetworkWindow::saveCopyAs ( )

slot

Save as... with a file dialog.

setCloseSilent()

void MLABIDENetworkWindow::setCloseSilent ( bool flag )

inline

Sets a flag to close without any saving or requesters.

setOverwriteCaptions()

void MLABIDENetworkWindow::setOverwriteCaptions	(	const QString &	shortTitleOverwrite = "",
		const QString &	fullTitleOverwrite = "" )

Defines custom titles that are always displayed in window title and tab bar. Method can be used to set and unset the caption overwrite. Use clearOverwriteCaptions() to unset the overwrite.

setUnnamed

void MLABIDENetworkWindow::setUnnamed ( )

slot

This document should be unnamed.

shortCaptionName()

QString MLABIDENetworkWindow::shortCaptionName

(

)

Returns 'untitled' or the real name (short version for tabs).

showAll

void MLABIDENetworkWindow::showAll ( )

slot

Shows all.

showCreateNetworkNoteDialog()

void MLABIDENetworkWindow::showCreateNetworkNoteDialog

(

)

Shows the network note creation dialog.

showQuickSearchInNetworkWidget()

void MLABIDENetworkWindow::showQuickSearchInNetworkWidget

(

)

Shows the quick search in network widget.

References filename(), and removeAutoSaveFile().

showScriptConsole()

void MLABIDENetworkWindow::showScriptConsole

(

)

Shows the scripting console for this network.

startNetworkScript()

void MLABIDENetworkWindow::startNetworkScript

(

)

Runs the network script.

triggerAutoSave()

void MLABIDENetworkWindow::triggerAutoSave

(

)

Triggers auto-save if needed.

undoManager()

MLABUndoManager * MLABIDENetworkWindow::undoManager ( )

inline

Returns the undoManager.

updateCaption()

void MLABIDENetworkWindow::updateCaption

(

)

Updates the window caption whenever the state changes.