OrsMacroPlayer¶
Controller of a macro recording and execution
| author: | ORS Team |
|---|---|
| contact: | http://theobjects.com |
| email: | info@theobjects.com |
| organization: | Object Research Systems (ORS), Inc. |
| address: | 760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 |
| copyright: | Object Research Systems (ORS), Inc. All rights reserved 2018. |
| date: | Oct 20 2016 09:50 |
| dragonflyVersion: | |
| 3.0 | |
| UUID: | 9ee31aae761511e7b35d448a5b5d70c0 |
Class Code¶
-
class
OrsPythonPlugins.OrsMacroPlayer.OrsMacroPlayer.OrsMacroPlayer(varname=None, managed=True)¶ -
classmethod
OrsMacroPlayer_openGUI()¶
-
UIDescriptors= [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]¶
-
applyModificationToDeclaredVariable(blockIndex, declaredVariable, newState, newVariableValue=None)¶
-
canContinueRecording()¶
-
canDeleteBlock(blockIndex)¶
-
canPauseRecording()¶
-
canRefreshFile()¶
-
canSetDeclaredVariables(blockIndex)¶
-
canSetMuted(blockIndex)¶
-
canSetPauseBeforeExecution(blockIndex)¶
-
canStartRecording()¶
-
canStopRecording()¶
-
clearMacro()¶
-
closable= True¶
-
closeWidget(name)¶
-
classmethod
contextualMenuStartMacrosFromSelection(listSelectedObjectsRepr)¶
-
continueRecording()¶
-
defineVariables(dictVariables)¶
-
defineVariablesFromSelection(listSelectedObjects)¶
-
deleteBlock(blockIndex)¶
-
deleteMacro(fullname)¶
-
deletePlugin(aWidget=None)¶
-
executeMacro(runFullMacro=True, automaticSelectionSingleElement=False)¶
-
classmethod
generateMacroTestFile(macroPath)¶
-
getAssignationStateOfDeclaredVariable(blockIndex, declaredVariable)¶
-
getAssignedValueToDeclaredVariable(blockIndex, declaredVariable)¶
-
getBlockCount()¶
-
getBlockIndexDeclaredVariablesExamination()¶
-
getBlockIndexInExecution()¶
-
getCurrentMacroBibliographyModel()¶
-
getDeclaredInputVariableDescriptors(blockIndex)¶
-
getDeclaredVariablesAssignedBeforeBlock(blockIndex)¶
-
getIsAssignmentToDeclaredVariableModified(blockIndex, declaredVariable)¶
-
getIsMacroPlayingInExecution()¶
-
getIsMacroRecordingInExecution()¶
-
getIsMuted(blockIndex)¶
-
getLastError()¶
-
getMacroInfo(blockIndex)¶
-
classmethod
getMacroTestFilename(macroPath)¶
-
getMacroTitle(blockIndex)¶
-
getOriginalMacroBibliographyModel()¶
-
getPauseBeforeExecution(blockIndex)¶
-
getVariablesToDefine()¶
-
interruptMacroWhileRunning()¶
-
classmethod
isMacroTestFileExisting(macroPath)¶
-
isRecordingPaused()¶
-
isThereAnError()¶
-
keepAlive= True¶
-
multiple= False¶
-
classmethod
openGUI()¶
-
openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)¶
-
pauseRecording()¶
-
refreshFile()¶
-
revertModificationToDeclaredVariable(blockIndex, declaredVariable)¶
-
savable= False¶
-
saveAsNewMacro(macroPath)¶
-
saveMacroAs(fullname)¶
-
setBlockIndexDeclaredVariablesExamination(blockIndexDeclaredVariablesExamination)¶
-
setCallbackMethodToUpdateCurrentBlockInExecution(aMethod)¶
-
setCallbackMethodToUpdateDefinedVariablesWidgets(aMethod)¶
-
setIsMuted(blockIndex, isMuted)¶
-
setMacroFromPath(macroPath)¶
-
setMacroInfo(blockIndex, info)¶
-
setMacroTitle(blockIndex, title)¶
-
setPauseBeforeExecution(blockIndex, pauseBeforeExecution)¶
-
shouldLastErrorBeGivenToTheUser()¶
-
showInToolbar= True¶
-
classmethod
startMacroOnSelection(macroPath, listSelectedObjectsGUID)¶ Method called from the contextual menu item to start an instance of the current plugin and start the execution of a specific macro with variables set from the selection. The UI will be shown only if a user interaction is required.
Parameters: - macroPath – path of the macro to execute
- listSelectedObjectsGUID – string representation of the selected objects
-
startRecording(macroFullFilename, writeBlockStartEndTime)¶
-
stopPlaying()¶
-
stopRecording()¶
-
classmethod
toolsMenu()¶
-
updateMacroCache(macroPaths=None)¶
-
classmethod
