MLABMacroModule Class Reference

#include <mlabMacroModule.h>

Inherits MLABModule.

Public Slots
Scripting methods
QVariant	object ()
MLABNoteItem *	addNote (const QString &title=QString(), const QString &text=QString())
MLABNoteItem *	addReSTNote (const QString &title=QString(), const QString &reSTText=QString())
QList< MLABNoteItem * >	notes ()
QList< MLABNetworkModelItemGroup * >	groups ()
MLABNetworkModelItemGroup *	group (const QString &groupName)
void	storeMacroModulePersistentFields (MLABTree *tree) override
void	restoreMacroModulePersistentFields (MLABTree *tree) override
Status methods
bool	isLocalMacro () override
virtual bool	isNetworkDocumentMacro ()
virtual bool	isAdHocMacro ()
Public Slots inherited from MLABModule
void	copyInstanceName ()
void	editInstanceNameWithRequester ()
void	editModuleHelp ()
QString	exampleNetworkFile ()
QStringList	exampleNetworkFiles ()
QString	getMLABFile ()
QString	getModuleDefinitionFolder ()
QString	getModuleHelpFile ()
QString	getModuleSourcesFolder ()
QStringList	getScriptSourceFiles ()
bool	hasModuleHelp ()
bool	isDefinedInsideProject () const
bool	isLazyLoading () const
MLABTree *	mdlTree ()
void	openMLABFile ()
void	openModuleDefinition ()
void	openScriptSourceFiles ()
void	restoreDefaultValues ()
void	showContextMenu ()
void	showDLLDependency ()
void	showExampleNetwork ()
void	showHtmlHelp ()
void	showModuleInNetwork (bool openNetworkTabAfterCurrentNetworkTab=false)
MLABWindowControl *	showScriptConsole ()
void	updateModuleHelp ()
MLABMacroModule *	parentMacro () const
MLABMacroModule *	parent ()
MLABMacroModule *	applicationMacro (bool shouldWarnIfNotMacro=true)
bool	isDescendentOf (MLABModule *module)
bool	isDescendentOfNetwork (MLABNetwork *network)
MLABNetwork *	parentNetwork () const override
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())
void	callOnGUIThread (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 *	addLocalModule (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	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())
QString	translate (const QString &text, const QString &disambiguation=QString())
QStringList	inputs ()
QStringList	outputs ()
QStringList	parameters ()
QList< MLABField * >	inputFields ()
QList< MLABField * >	outputFields ()
QList< MLABField * >	parameterFields ()
bool	isValid ()
void	setNonPersistent ()
bool	isPersistent () override
QString	type () const
virtual bool	isRemote ()
virtual bool	isLocalMacro ()
bool	shouldAvoidSideEffects () const
QString	fullName () override
QRect	frame () const
void	setFrame (const QRect &frame)
void	setFrameTopLeft (int x, int y)
void	setFrameCenter (int x, int y)
bool	isSelected () const override
void	setSelected (bool flag, bool notifyModuleListener=true)
void	setSingleSelected ()
MLABPackage *	package ()
MLABPackage *	getPackage ()
MLABWindowControl *	showWindow (MLABWindowControl *parent=nullptr)
MLABWindowControl *	showWindow (const QString &name, MLABWindowControl *parent=nullptr)
MLABWindowControl *	showWindowFromString (const QString &string, MLABWindowControl *parent=nullptr)
MLABWindowControl *	showWindowFromFile (const QString &file, MLABWindowControl *parent=nullptr)
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 ()
void	forceReload () override
bool	isMacroModule () override
MLABModule *	module (const QString &name) override
MLABNetwork *	network () override
void	reload () override
bool	shouldReload () override

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

addNote

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

slot

Creates a new note item in the internal network.

addReSTNote

MLABNoteItem * MLABMacroModule::addReSTNote ( const QString & title = QString(), const QString & reSTText = QString() )

slot

Creates a new note item in the internal network with ReST text.

emitInternalNetworkOpened()

void MLABMacroModule::emitInternalNetworkOpened ( )

inline

Emits when the internal network is opened.

forceReload()

void MLABMacroModule::forceReload ( )

overridevirtual

Reloads the module. Also ensures that the MDL files are re-read in the global tree.

Reimplemented from MLABModule.

group

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

slot

Returns a module group by its name.

groups

QList< MLABNetworkModelItemGroup * > MLABMacroModule::groups ( )

slot

Returns all groups.

isAdHocMacro

virtual bool MLABMacroModule::isAdHocMacro ( )

inlinevirtualslot

Returns whether the macro is an ad hoc module.

isLocalMacro

bool MLABMacroModule::isLocalMacro ( )

inlineoverrideslot

Returns whether the macro is a local macro module.

isMacroModule()

bool MLABMacroModule::isMacroModule ( )

inlineoverridevirtual

Returns whether this module is a macro module.

Reimplemented from MLABModule.

isNetworkDocumentMacro

virtual bool MLABMacroModule::isNetworkDocumentMacro ( )

inlinevirtualslot

Returns whether the macro is a network document module.

module()

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

overridevirtual

Searches for a module with given name.

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

Example:

module = ctx.module("ImageLoad")

Reimplemented from MLABModule.

network()

MLABNetwork * MLABMacroModule::network ( )

overridevirtual

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

Reimplemented from MLABModule.

notes

QList< MLABNoteItem * > MLABMacroModule::notes ( )

slot

Returns all notes.

object

QVariant MLABMacroModule::object ( )

slot

Returns 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.

reload()

void MLABMacroModule::reload ( )

overridevirtual

Reloads the module.

Reimplemented from MLABModule.

restoreMacroModulePersistentFields

void MLABMacroModule::restoreMacroModulePersistentFields ( MLABTree * tree )

overrideslot

Restores the persistent fields from the tree.

shouldReload()

bool MLABMacroModule::shouldReload ( )

overridevirtual

Returns whether the module should be reloaded.

Reimplemented from MLABModule.

storeMacroModulePersistentFields

void MLABMacroModule::storeMacroModulePersistentFields ( MLABTree * tree )

overrideslot

Stores the persistent fields to the tree.