Inherits MLABModule.

Public Slots
Scripting methods
QVariant	object ()

MLABNoteItem *	addNote (const QString &title=QString(), const QString &text=QString())

QList< MLABNoteItem * >	notes ()

QList< MLABNetworkModelItemGroup * >	groups ()

MLABNetworkModelItemGroup *	group (const QString &groupName)

virtual void	storeMacroModulePersistentFields (MLABTree *tree)

virtual void	restoreMacroModulePersistentFields (MLABTree *tree)

Public Slots inherited from MLABModule
MLABMacroModule *	parentMacro () const

MLABMacroModule *	parent ()

MLABMacroModule *	applicationMacro (bool shouldWarnIfNotMacro=true)

bool	isDescendentOf (MLABModule *module)

bool	isDescendentOfNetwork (MLABNetwork *network)

MLABNetwork *	parentNetwork () const

MLABNetwork *	owner ()

void	createScriptingContext (const QString &language)

bool	hasFunction (const QString &functionName)

QVariant	scriptVariable (const QString &name)

void	setScriptVariable (const QString &name, const QVariant &value)

void	deleteScriptVariable (const QString &name)

QVariant	call (const QString &function, const QVariantList &args)

QVariant	call (const QString &function)

QVariant	call (const QString &function, QObject *obj)

QObject *	callWithObjectReturn (const QString &function, const QVariantList &args)

QObject *	callWithObjectReturn (const QString &function)

QObject *	callWithObjectReturn (const QString &function, QObject *obj)

int	callLater (double seconds, const QVariant &function, const QVariantList &args=QVariantList())

int	callWithInterval (double seconds, const QVariant &function, const QVariantList &args=QVariantList())

QStringList	callableFunctions ()

QStringList	deprecatedFieldNames (const QString &fieldName)

QStringList	deprecatedFieldNames (MLABField *field)

QVariantMap	deprecatedFieldNames ()

void	removeTimer (int id)

void	removeTimers ()

QObject *	commandHandler (const QString &name)

bool	connectField (const QString &dst, const QString &src)

bool	disconnectField (const QString &input)

virtual void	clearCache ()

virtual MLABField *	field (const QString &name)

bool	hasField (const QString &name)

bool	hasModule (const QString &name)

QStringList	modules ()

QList< MLABModule * >	modulesAsObjects ()

virtual MLABModule *	addModule (const QString &name)

virtual MLABModule *	addMacroModuleFromString (const QString &string)

virtual MLABModule *	addMacroModuleFromFile (const QString &file)

virtual MLABModule *	addRemoteModule (const QString &name)

virtual MLABWidgetControl *	control (const QString &name)

bool	hasControl (const QString &name)

MLABWidgetControl *	controlDebug (const QString &name)

virtual void	closeWindow ()

MLABWindowControl *	window ()

QString	unexpandFilename (const QString &file)

QString	expandFilename (const QString &file, bool doCleanPath=true)

QString	localPath ()

QString	networkPath ()

void	log (const QString &msg)

void	logFixed (const QString &text)

void	logHTML (const QString &msg)

void	logWarning (const QString &msg)

void	logError (const QString &msg)

int	currentWindowID ()

int	setCurrentWindowID (int windowID)

void	remove ()

void	py_delete ()

void	removeUndoable ()

QMap< QString, QVariant >	getDependency ()

bool	exportWindows (const QStringList &windowNames=QStringList()<< "_default")

bool	callRemoteFunction (const QString &functionName, const QVariantList &arguments=QVariantList(), const QVariant &replyHandler=QVariant())

QStringList	inputs ()

QStringList	outputs ()

QStringList	parameters ()

QList< MLABField * >	inputFields ()

QList< MLABField * >	outputFields ()

QList< MLABField * >	parameterFields ()

bool	isValid ()

void	setNonPersistent ()

virtual bool	isPersistent ()

QString	type () const

virtual bool	isRemote ()

virtual QString	fullName ()

QRect	frame () const

void	setFrame (const QRect &frame)

void	setFrameTopLeft (int x, int y)

void	setFrameCenter (int x, int y)

virtual bool	isSelected () const

void	setSelected (bool flag, bool notifyModuleListener=true)

void	setSingleSelected ()

MLABPackage *	package ()

MLABPackage *	getPackage ()

MLABWindowControl *	showWindow (MLABWindowControl *parent=NULL)

MLABWindowControl *	showWindow (const QString &name, MLABWindowControl *parent=NULL)

MLABWindowControl *	showWindowFromString (const QString &string, MLABWindowControl *parent=NULL)

MLABWindowControl *	showWindowFromFile (const QString &file, MLABWindowControl *parent=NULL)

MLABWindowControl *	showAutomaticWindow ()

int	showModalDialog (const QString &name, const QString &title)

int	showModalDialog (const QString &name)

int	showModalDialog ()

int	showModalDialog (const QString &name, MLABWindowControl *parent)

int	showModalDialogFromString (const QString &mdlString, const QString &title)

int	showModalDialogFromString (const QString &mdlString)

int	showModalDialogFromString (const QString &mdlString, MLABWindowControl *parent)

int	showModalDialogFromFile (const QString &file, const QString &title)

int	showModalDialogFromFile (const QString &file)

int	showModalDialogFromFile (const QString &file, MLABWindowControl *parent)

MLABWindowControl *	createWindow ()

MLABWindowControl *	createWindow (MLABWindowControl *parent)

MLABWindowControl *	createWindow (const QString &name)

MLABWindowControl *	createWindow (const QString &name, MLABWindowControl *parent)

MLABWindowControl *	createWindowFromFile (const QString &file)

MLABWindowControl *	createWindowFromFile (const QString &file, MLABWindowControl *parent)

MLABWindowControl *	createWindowFromString (const QString &string)

MLABWindowControl *	createWindowFromString (const QString &string, MLABWindowControl *parent)

MLABWindowControl *	createBorderlessWindow (const QString &name, MLABWindowControl *parent)

MLABWindowControl *	createPopupWindow (const QString &name, MLABWindowControl *parent)

MLABWindowControl *	createModalDialog (const QString &name, MLABWindowControl *parent)

bool	hasWindow (const QString &name)

void	closeAllWindows (bool emitDestroyedCommandImmediately=false)

void	reshowClosedWindows ()

virtual MLABWindowControl *	showParameterWindow ()

void	updateLayout ()

void	createConnectors ()

MLABFieldListener *	addFieldListener (MLABField *field, const QVariant &script, bool init)

void	removeFieldListener (MLABFieldListener *listener)

QString	groupName () const

void	addToGroup (const QString &name)

Public Slots inherited from MLABFieldOwner
virtual bool	isSelected () const =0

virtual bool	isPersistent ()=0

virtual MLABNetwork *	parentNetwork () const =0

virtual QString	fullName ()=0

Public Member Functions
void	emitInternalNetworkOpened ()

virtual bool	isLocalMacro ()

virtual MLABModule *	module (const QString &name)

virtual MLABNetwork *	network ()

Detailed Description

Defines a MacroModule with own fields and an optional internal network.

Most scripting functionality is available via the base class MLABModule, but MLABMacroModule provides some additional scripting functions.

Member Function Documentation

MLABNoteItem* MLABMacroModule::addNote	(	const QString &	title = `QString()`,
		const QString &	text = `QString()`
	)

slot

Creates a new note item in the internal network.

void MLABMacroModule::emitInternalNetworkOpened ( )

inline

Emits when the internal network is opened.

MLABNetworkModelItemGroup* MLABMacroModule::group ( const QString & groupName )

slot

Returns a group by its name.

QList<MLABNetworkModelItemGroup*> MLABMacroModule::groups ( )

slot

Returns all groups.

virtual bool MLABMacroModule::isLocalMacro ( )

inlinevirtual

Returns whether this module is a local macro module.

Reimplemented from MLABModule.

virtual MLABModule* MLABMacroModule::module ( const QString & name )

virtual

Searches for module with given name.

Searches for a module with a given instanceName inside the internal network of this module.

Example:

mod = ctx.module("ImageLoad")

Reimplemented from MLABModule.

virtual MLABNetwork* MLABMacroModule::network ( )

virtual

Returns the internal network (used in MacroModules, do not mix this up with parentNetwork()! ).

Reimplemented from MLABModule.

QList<MLABNoteItem*> MLABMacroModule::notes ( )

slot

Returns all notes.

QVariant MLABMacroModule::object ( )

slot

Get access to the underlying Python object associated with this macro module.

The idea of this method is to provide a public Python API to your macro module to facilitate direct calls to the underlying Python code. To associate a Python object with the macro module, assign it to the global object variable in your python code. This is equivalent to calling scriptVariable("__object__"). If the underlying object is not set, an empty QVariant is returned, which results in a Python None object. Note that basic Python types like dict are translated to Qt types, so if you want to make sure that your API object is returned as a Python object, you need to create your own Python class and assign an instance of it to object and not use a basic Python type. Note: If you keep a reference to the returned Python object, it will be reference counted by your code and thus it may live longer than the macro module itself. This can be a problem if you access the object after the macro itself has already been deleted.

virtual void MLABMacroModule::restoreMacroModulePersistentFields ( MLABTree * tree )

virtualslot

Restores the persistent fields from the tree.

virtual void MLABMacroModule::storeMacroModulePersistentFields ( MLABTree * tree )

virtualslot

Stores the persistent fields to the tree.

Public Slots

Public Member Functions

Detailed Description

Member Function Documentation