MeVisLab Scripting Reference
|
#include <mlabMLModule.h>
Inherits MLABModule.
Inherited by MLABInventorModule, and MLABRemoteModule.
Public Slots | |
virtual QObject * | object () |
Public Slots inherited from MLABModule | |
MLABMacroModule * | applicationMacro (bool shouldWarnIfNotMacro=true) |
bool | isDescendentOf (MLABModule *module) |
bool | isDescendentOfNetwork (MLABNetwork *network) |
virtual bool | isMacroModule () |
virtual MLABNetwork * | network () |
MLABNetwork * | owner () |
MLABMacroModule * | parent () |
MLABMacroModule * | parentMacro () const |
MLABNetwork * | parentNetwork () const override |
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) |
virtual MLABModule * | module (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 | 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()) |
QString | translate (const QString &text, const QString &disambiguation=QString()) |
virtual MLABModule * | addRemoteModule (const QString &name, const QString &host, int port, const QByteArray &applicationName="", const QByteArray &authenticationToken="", bool encrypted=false) |
bool | checkForStdDistribution () |
bool | isRunningApplication () |
QString | applicationStyle () |
void | runTester () |
QStringList | associatedTests () |
void | createTestCase () |
void | editTestCase () |
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 () |
bool | isLazyLoading () const |
void | showWindowFromMenu () |
void | editWindow (const QString &windowName, QString filename="") |
bool | isDefinedInsideProject () const |
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) |
void | setFieldValues (MLABTree *tree) |
MLABTree * | getFieldValues () |
void | restoreDefaultValues () |
virtual void | reload () |
virtual void | forceReload () |
bool | isReloadAllowed () const |
virtual bool | shouldReload () |
void | showContextMenu () |
void | showScriptConsole () |
void | showModuleInNetwork (bool openNetworkTabAfterCurrentNetworkTab=false) |
void | doubleClickAction (Qt::KeyboardModifiers) |
virtual void | showDefaultPanel () |
void | instanceNameFieldChanged () |
void | copyInstanceName () |
void | editInstanceNameWithRequester () |
void | openModuleDefinition () |
void | showHtmlHelp () |
void | editModuleHelp () |
void | updateModuleHelp () |
QString | getModuleHelpFile () |
bool | hasModuleHelp () |
QString | getMLABFile () |
QString | getModuleDefinitionFolder () |
QString | getModuleSourcesFolder () |
void | showExampleNetwork () |
void | showExampleNetworkFromMenu () |
void | showExampleNetworkFromMenu (int index) |
QString | exampleNetworkFile () |
QStringList | exampleNetworkFiles () |
void | openRelatedFileFromMenu () |
void | showModuleDefinitionFolder () |
void | showModuleSourcesFolder () |
void | openProjectInIDE () |
void | macShowNetworkFilesUsingModule () |
void | runUserScript (const QString &scriptName, const QStringList &args=QStringList()) |
void | runUserScriptFromAction () |
QVariant | runBatchCommand (const QVariantList &args, const QString &currPath) |
QVariant | runApplicationCommand (const QVariantList &args, const QString &currPath) |
QStringList | getScriptSourceFiles () |
void | openScriptSourceFiles () |
void | openMLABFile () |
void | attachPythonDebugger () |
void | showDLLDependency () |
MLABTree * | mdlTree () |
void | writeMDLTranslationFile () |
void | editTranslations () |
void | setLanguageAndReload (QAction *action) |
void | svnCommandFromMenu () |
void | showRelatedFolders () |
void | showEnclosingFolder () |
bool | hasNetworkPanel () const |
bool | isShowingNetworkPanel () const |
void | setShowNetworkPanel (bool show) |
Public Slots inherited from MLABFieldOwner | |
virtual bool | isSelected () const =0 |
virtual bool | isPersistent ()=0 |
virtual MLABNetwork * | parentNetwork () const =0 |
virtual QString | fullName ()=0 |
virtual bool | isLoaded () const |
virtual void | ensureModuleIsLoaded (bool recursive=false) |
Additional Inherited Members | |
Public Member Functions inherited from MLABModule | |
QString | getMDLTreeAsJson () |
QStringList | relatedFiles () |
virtual QString | py_toString () |
virtual void | setProfilingEnabled (bool enabled) |
virtual void | resetProfilingData () |
MLABModuleProfilePtr & | getProfile () |
QHash< QString, QString > | getModuleSpecificPathVariables () override |
void | setGroupName (const QString &groupName) |
virtual void | setUniqueName (bool forceTypeName=false) |
QString | nextUniqueName () const |
virtual MLABField * | lookupField (const QString &name, bool &caseWarning, bool &deprecated) |
virtual MLABField * | lookupField (const QString &name) |
MLABField * | lookupField (const QString &name, MLABTree *tree) override |
virtual MLABField * | lookupField (MLABTree *tree) |
void | setupInstanceNameValidatorAndUniqueName () |
bool | isNameAlreadyUsed (const QString &name) |
void | setRunningApplication (bool flag) |
void | setApplicationStyle (const QString &name) |
int | newWindowID () |
void | deleteWindowID (int id) |
int | enterScript (MLABTree *tag, MLABTree *parent, int windowID) |
void | leaveScript (MLABTree *tag, MLABTree *parent, int windowID) |
bool | registerControl (const QString &name, MLABWidgetControl *control, int windowID) |
void | deregisterControl (const QString &name, MLABWidgetControl *control, int windowID) |
QStringList | definedWindowNames () |
MLABWindowControl * | showNthWindow (int i, int flags, MLABWindowControl *parent=nullptr) |
MLABWindowControl * | showWindow (const QString &name, int flags, MLABWindowControl *parent) |
MLABWindowControl * | showWindowFromString (const QString &string, int flags, MLABWindowControl *parent=nullptr) |
MLABWindowControl * | showWindowFromFile (const QString &string, int flags, MLABWindowControl *parent=nullptr) |
MLABWindowControl * | createWindowFromFile (const QString &file, int flags, MLABWindowControl *parent=nullptr) |
MLABWindowControl * | createWindowFromString (const QString &string, int flags, MLABWindowControl *parent=nullptr) |
MLABWindowControl * | createWindowFromString (const QString &string, int flags, QWidget *parent=nullptr) |
MLABWindowControl * | createWindow (const QString &name, int flags) |
MLABWindowControl * | createWindow (const QString &name, int flags, MLABWindowControl *parent) |
MLABWindowControl * | createWindow (const QString &name, int flags, QWidget *parent) |
virtual void | emitWindowCreated (MLABWindowControl *window) |
virtual void | emitWindowCreatedBeforeWakeup (MLABWindowControl *window) |
virtual void | emitParentWakeup () |
void | emitModuleItemCreated () |
void | emitRestoredFromUndoHistory () |
bool | isVerified () |
void | deleteYourself () |
bool | isRemoved () const |
bool | isDeprecated () const |
bool | isDeprecatedAndWillBeRemoved () const |
MLABWidgetControl * | controlForWindowID (const QString &name, int windowID) |
virtual bool | reloadIfNeeded () |
bool | connectUndoable (MLABField *dest, MLABField *src) override |
void | disconnectUndoable (MLABField *dest, MLABField *src) override |
virtual void | setName (const QString &name) |
virtual void | setupFinished () |
virtual void | setupFieldSettings (MLABTree *stored) |
void | setupScriptContext () |
virtual void | setupInterfaceFields () |
void | recordFieldDefaultValues () |
void | removeFieldListeners () |
void | removeFieldSynchronizers () |
void | createFieldListeners () |
void | initModuleScriptHandlers (MLABTree *commandSection) |
void | removeModuleScriptHandlers () |
virtual void | createOwnFields () |
virtual void | storeConnectionsToTree (MLABTree *connections, bool onlySelected) |
virtual void | storeMacroModulePersistentFields (MLABTree *tree) |
virtual void | restoreMacroModulePersistentFields (MLABTree *tree) |
virtual void | restoreFieldConnection (const QString &name, const QString &fullOutputName, MLABTree *srcTree, QHash< QString, MLABModule * > *modules, MLABOrderedConnections *orderedConnections) |
virtual void | willBeRemoved (bool undoable) |
const MLABFieldList & | inputFieldsConst () |
const MLABFieldList & | outputFieldsConst () |
const MLABFieldList & | parameterFieldsConst () |
virtual QString | toolTipInfo () |
void | dropEvent (QDropEvent *e) |
bool | acceptable (const QMimeData *mime) |
QStringList | relatedDirectories () |
QStringList | scriptingSourceFiles () |
QString | getCppProjectFile () |
void | fieldDisconnected (MLABField *field) override |
void | fieldDisconnecting (MLABField *field) override |
void | fieldConnected (MLABField *field) override |
void | fieldSetStringValueUndoable (MLABField *field, const QString &value) override |
void | openUndoRedoGroup () override |
void | closeUndoRedoGroup () override |
const QList< MLABFieldListener * > & | fieldListeners () |
QString | libraryName () |
MLABScriptContext * | scriptContext () |
virtual MLABTreePtr | findWindowTreeWithName (const QString &name) |
QList< MLABTreePtr > | getWindowDefinitions () |
QMenu * | createContextMenu () |
QString | getDrawText (QString nameTypeDelimiter="\n") |
QString | translate (MLABTree *tree) |
void | collectMDLTranslationStrings (QStringList &strings, const QString &windowOrPanel={}, QSet< QString > *handledPythonFiles=nullptr) |
void | svnCommand (const QString &verb) |
void | fillFieldCommentWithHelpText () |
QList< MLABField * > | getNotifiedFields () |
MLABNetworkPanel * | getNetworkPanel () |
void | addMessage (const DiagnosisMessage &message) |
virtual QList< DiagnosisMessage > | getDiagnosisMessages () |
virtual QList< DiagnosisMessage > | getDiagnosisWarnings () |
virtual QList< DiagnosisMessage > | getDiagnosisErrors () |
virtual bool | areMessageCachesValid () |
virtual void | updateMessageCaches () |
void | clearDiagnosisMessages () |
virtual void | clearDiagnosisMessageCaches () |
virtual void | clearDiagnosisMessagesInternal () |
virtual bool | hasAnyDiagnosisMessage (bool updateCachesIfNecessary=false) |
Public Member Functions inherited from MLABFieldOwner | |
Static Public Member Functions inherited from MLABModule | |
static QString | loadLibrary (MLABTree *tree, bool loadIfPresent=false) |
static void | setModuleCreateWindowControllerCB (MLABModuleCreateWindowControllerCB *cb, void *data) |
static void | setCountingNotificationsGlobal (bool counting) |
static bool | isCountingNotificationsGlobal () |
static void | resetNotificationCountsGlobal () |
static QString | getToolTipText (MLABTree *moduleTree, const QString &moduleInstanceName="", const QString &addInfo="") |
static QString | formatTextForToolTip (const QString &helpText, QString moduleName="", QHash< QString, QString > *fieldTitles=nullptr) |
static QString | convertReSTToHTML (const QString &part, QString moduleName="", QHash< QString, QString > *fieldTitles=nullptr) |
Protected Slots inherited from MLABModule | |
void | windowClosing (MLABWindowControl *w) |
Protected Member Functions inherited from MLABModule | |
void | feedSubMetaProfilesRecursive (MLMetaProfile *metaProfile) |
QVariant | runBatchCommandInternal (const QString &command, const QVariantList &args, const QString &currPath) |
virtual void | storeInternalsToTreeDelegate (MLABTree *) |
virtual void | restoreInternalsFromTreeDelegate (MLABTree *) |
void | modifyTreeForUnsignedFiles () |
MLABWindowControl * | showWindowForTree (const QString &name, MLABTree *tree, int flags=MLAB_PANEL, MLABWindowControl *parent=nullptr) |
MLABWindowControl * | createWindowForTree (const QString &name, MLABTree *tree, bool &isNew, int flags=MLAB_PANEL, QWidget *parent=nullptr) |
void | commonCleanup () |
void | commonReloadCleanup () |
void | deleteProfilingData () |
void | storeConnectionsToTree (MLABTree *connections, MLABFieldList &list, bool onlySelected) |
virtual void | restoreInternalsFromTree (MLABTree *root) |
virtual void | restoreFieldsFromTree (MLABTree *root) |
void | storeFieldsToTree (MLABTree *t) |
void | storeInterfaceToTree (MLABTree *t) |
MLABField * | createField (const QString &type, int &hint, MLABTree *typeNode=nullptr) |
void | setupInterfaceFields (MLABFieldList &fields, MLABFieldList &oldfields, MLABFieldListType inout, MLABTree *tree, MLABTree *descriptionSection) |
virtual void | setNameInternal (const QString &name) |
void | printFieldNotFoundInConnection (const QString &name, MLABTree *srcTree, QHash< QString, MLABModule * > *modules=nullptr) |
void | collectMDLTranslationStrings (QStringList &strings, MLABTree *tree, QSet< QString > *handledPythonFiles, bool isWindow) |
void | collectPythonTranslationStrings (const QSet< QString > &pythonFiles, QStringList &translations) |
QSet< QString > | findPythonImportsThroughDependencyAnalysis (const QStringList &modules) |
void | updateTranslations () |
MLMetaProfile * | getMetaProfile () const override |
void | setInputConnectorState (int idx, bool normal) |
void | insertInputConnector (int idx, MLABField *field) |
void | removeInputConnector (int idx) |
MLABTreePtr | parseWindowFromString (const QString &string) |
MLABTreePtr | parseWindowFromFile (const QString &file) |
int | internalShowModalDialog (MLABWindowControl *window, const QString &title={}) |
void | setupFieldTags (bool early) |
void | cleanupFieldTags (MLABField *f) |
void | setupFieldTagsEarly (std::vector< MLABTree * > &fields, bool description) |
void | setupFieldTagsLate (std::vector< MLABTree * > &fields, bool description) |
void | setupEnumFieldFromTree (MLABEnumField *enumfield, MLABTree *tree, bool description) |
MLABTreePtr | createAutomaticTree () |
void | addFieldsToAutomaticTree (MLABTree *tree, MLABFieldList &list) |
virtual void | setupTree () |
void | setupInternalName (MLABTree *stored) |
void | commonSetup (MLABTree *stored) |
void | setTree (MLABTree *tree) |
void | addDeprecatedField (const QString &name, MLABField *newfield) |
void | setCountingNotifications (bool counting) |
void | resetNotificationCounts () |
void | invalidateMessageCaches () |
void | pushCurrentModule () override |
void | popCurrentModule () override |
Protected Member Functions inherited from MLABFieldOwner | |
Protected Attributes inherited from MLABModule | |
QString | _type |
QRect | _frame |
QRect | _persistentFrame |
MLABNetwork * | _parentNetwork |
MLABTreePtr | _tree |
MLABModuleInfo | _moduleInfo |
MLABFieldList | _inputs |
MLABFieldList | _outputs |
MLABFieldList | _parameters |
QString | _applicationStyle |
MLABField * | _instanceName |
bool | _selected |
bool | _lockInstanceName |
bool | _valid |
bool | _persistent |
bool | _restoreDefaultValue |
bool | _restoreLegacyValue |
bool | _verified |
bool | _isRunningApplication |
bool | _isTopLevelApplicationModule |
bool | _reloading |
bool | _suppressLayoutUpdates |
bool | _mhelpFieldCommentsNeedParsing |
bool | _doLazyLoading |
bool | _showNetworkPanel |
bool | _removed |
int | _inDiagnosisStack |
MLABModuleListener * | _moduleListener |
QList< MLABAbstractModuleVisual * > | _visualList |
MLABModuleWindowController * | _windowController |
MLABFileWatch * | _scriptFiles |
MLABScriptContext * | _scriptContext |
MLABCaseInsensitiveDict< MLABTree > * | _removedFields |
MLABCaseInsensitiveDict< MLABField > * | _deprecatedFields |
QList< MLABFieldSynchronizer * > | _synchronizers |
QList< MLABFieldListener * > | _fieldListeners |
QString | _groupName |
MLABModuleProfilePtr | _profile |
QStack< MLTimeProfileHandle * > | _timeProfileHandlesStack |
MLMetaProfilePtr | _metaProfilePtr |
MLABNetworkPanel * | _networkPanel |
QList< DiagnosisMessage > | _messages |
QList< DiagnosisMessage > | _errors |
QList< DiagnosisMessage > | _warnings |
bool | _areMessageCachesValid |
Static Protected Attributes inherited from MLABModule | |
static bool | _countingNotificationsGlobal |
static MLABModuleCreateWindowControllerCB * | _createWindowControllerCB |
static void * | _createWindowControllerCBData |
Defines a ML (MeVis Image Processing Library) Module.
See MLABModule, MLABMLModule currently does not provide additional methods.
|
virtualslot |
Returns scripting access to the underlying ML module This is only supported for ML modules that have a registered CPPObjectWrapper.