def ExecuteActionIf(self,oAction):
"""
WikiDoc:Doc
WikiDoc:Context:ActionsDetails
WikiDoc:Page:Actions-If
WikiDoc:TOCTitle:if
= if =
Useful, if blocks of actions should be skipped/executed on a condition. Does only make sense, if you apply a condition. For each if, there must be an endif. "if" can be nested.
You also could use a short form, where the condition is added directly to the string. eg. string="if red!=green"
<div style="overflow:auto; ">
{| class="wikitable"
! align="left" | Attribute
! align="left" | Description
|-
|string
|if
|}</div>
A short example:
<div style="overflow-x: auto;"><syntaxhighlight lang="xml">
<action name="if we haven't showed it by now" string="if" condition="'$var(SHOWINSTALLATIONHINT)'=='TRUE'"/>
<action name="SET Showflag to False" string="setvar SHOWINSTALLATIONHINT=FALSE" />
<action name="Save Status" string="modifyvar" varname="SHOWINSTALLATIONHINT" operator="save" parameter1="$var(DEFINITIONNAME)"/>
<action name="show message" string="showquestion" title="$lvar(597)" message="$var(INSTALLATIONHINT)" actionyes="dummy" condition="'$var(INSTALLATIONHINT)'!=''"/>
<action name="" string="endif" />
</syntaxhighlight></div>
WikiDoc:End
"""
self.oEvenDispatcher.bDoNext = True
#This action will be called, if "IF" fails to goto the next end if
self.oEvenDispatcher.LogAction(u'If',oAction,"skip actions")
iLevel=-1
oQueue=GetActiveQueue()
i=oQueue.iActionQueuePos
iActionQueuePos = oQueue.iActionQueuePos
for oTmpAction in oQueue.aActionQueue[iActionQueuePos:]:
if oTmpAction.iActionId==Globals.oActions.oActionType.If:
iLevel+=1
if oTmpAction.iActionId==Globals.oActions.oActionType.EndIf:
if iLevel==0:
oQueue.iActionQueuePos=i
self.oEvenDispatcher.LogAction(u'EndIf', oTmpAction)
return -2
iLevel-=1
i+=1
uMsg=self.oEvenDispatcher.CreateDebugLine(oAction,'Wrong If')+u"\nFileName:"+oAction.uFileName
DumpQueue()
for oTmpAction in oQueue.aActionQueue[iActionQueuePos:]:
uMsg+=u"\n"
uMsg+=oTmpAction.uActionName + u' '+oTmpAction.uActionString
Logger.error (uMsg)
ShowErrorPopUp(uTitle='Warning',uMessage=uMsg)
return -2
def _ExecuteActions(self,aActions, oParentWidget):
""" This functions just adds the action commands to the queue and calls the scheduler at the end """
oQueue = GetActiveQueue()
for aTmpAction in aActions:
oAction = copy(aTmpAction)
oAction.oParentWidget = oParentWidget
iActionId=oAction.iActionId
''' this enables to any function to call without call statement from an macro, as long as the action exists'''
if iActionId==Globals.oActions.oActionType.NoAction:
if oAction.uActionString.lower()!="noaction":
oAction.iActionId=-1
aTmpActions = Globals.oActions.GetActionList(uActionName = oAction.uActionString, bNoCopy = True)
if aTmpActions is not None:
iActionId=aTmpActions[0].iActionId
if iActionId == Globals.oActions.oActionType.SendCommand:
oTmpAction = copy(aTmpAction)
oTmpAction.dActionPars['string']='enabletransmitterpicture'
oTmpAction.iActionId = GetActionID(oTmpAction.dActionPars['string'])
self.__InsertToQueue(oTmpAction, oQueue)
if iActionId == Globals.oActions.oActionType.ShowPage:
oTmpAction = copy(aTmpAction)
oTmpAction.dActionPars['string'] = 'call'
oTmpAction.dActionPars['actionname'] = 'PAGESTOPACTIONS'
oTmpAction.iActionId = GetActionID(oTmpAction.dActionPars['string'])
self.__InsertToQueue(oTmpAction, oQueue)
self.__InsertToQueue(oAction, oQueue)
if iActionId == Globals.oActions.oActionType.ShowPage:
oTmpAction = copy(aTmpAction)
uPagenameToCall = oAction.dActionPars.get('pagename','')
if uPagenameToCall == "":
if oAction.oParentWidget is not None:
uPagenameToCall = oAction.oParentWidget.dActionPars.get('pagename','')
oTmpAction.dActionPars['string'] = 'call'
oTmpAction.dActionPars['actionname'] = 'PAGESTARTACTIONS'
oTmpAction.dActionPars['pagename'] = uPagenameToCall
oTmpAction.dActionPars['currentpagename'] = GetVar(uVarName = 'CURRENTPAGE')
#oTmpAction.dActionPars['currentpagename'] = GetVar('LASTPAGE')
oTmpAction.iActionId = GetActionID(oTmpAction.dActionPars['string'])
self.__InsertToQueue(oTmpAction, oQueue)
if iActionId == Globals.oActions.oActionType.SendCommand:
oTmpAction = copy(aTmpAction)
oTmpAction.dActionPars['string'] = 'disabletransmitterpicture'
oTmpAction.iActionId = GetActionID(oTmpAction.dActionPars['string'])
self.__InsertToQueue(oTmpAction, oQueue)
oQueue = GetActiveQueue()
if not oQueue.bForceState:
Clock.schedule_once(partial(oQueue.WorkOnQueue,oQueue.bForceState), 0)
else:
return oQueue.WorkOnQueue(oQueue.bForceState)
def ExecuteActionExitAction(self, oAction: cAction) -> eReturnCode:
"""
WikiDoc:Doc
WikiDoc:Context:ActionsDetails
WikiDoc:Page:Actions-ExitAction
WikiDoc:TOCTitle:exitaction
= exitaction =
Exit the current action
<div style="overflow:auto; ">
{| class="wikitable"
! align="left" | Attribute
! align="left" | Description
|-
|string
|exitaction
|}</div>
WikiDoc:End
"""
self.oEventDispatcher.LogAction(uTxt=u'ExitAction', oAction=oAction)
oQueue: cQueue = GetActiveQueue()
oQueue.iActionQueuePos = len(oQueue.aActionQueue) + 1
return eReturnCode.Nothing
def ExecuteActionGoto(self,oAction):
"""
WikiDoc:Doc
WikiDoc:Context:ActionsDetails
WikiDoc:Page:Actions-Goto
WikiDoc:TOCTitle:goto
= goto =
Jumps to an action within a multi line action / macro. You have to use the action name of the target as a jump target. You can jump only to actions within your multi line action / macro. If the label can't be found, an error message will popup.
You also could use a short form, where the label is added directly to the string. eg. string="goto label_end"
<div style="overflow:auto; ">
{| class="wikitable"
! align="left" | Attribute
! align="left" | Description
|-
|string
|goto
|-
|label
|Action to jump to
|}</div>
A short example:
<div style="overflow-x: auto;"><syntaxhighlight lang="xml">
<action name="goto exit" string="goto" label="End Function"/>
</syntaxhighlight></div>
WikiDoc:End
"""
uLabel = ReplaceVars(oAction.dActionPars.get("label",""))
self.oEvenDispatcher.bDoNext = True
self.oEvenDispatcher.LogAction(u'Goto',oAction)
i=0
oQueue=GetActiveQueue()
for oTmpAction in oQueue.aActionQueue:
if oTmpAction.uActionName==uLabel:
oQueue.iActionQueuePos=i-1
return -2
i+=1
uMsg=self.oEvenDispatcher.CreateDebugLine(oAction,'Wrong Goto')+u"\nFileName:"+oAction.uFileName
Logger.error (uMsg)
ShowErrorPopUp(uTitle='Warning',uMessage=uMsg)
return -2
def _ExecuteActions(self, *, aActions: List[cAction],
oParentWidget: cWidgetBase) -> Union[int, None]:
""" This functions just adds the action commands to the queue and calls the scheduler at the end """
oQueue: cQueue = GetActiveQueue()
bForceState: bool = oQueue.bForceState
oQueue.AddActions(aActions=aActions, oParentWidget=oParentWidget)
if not bForceState:
Clock.schedule_once(
partial(oQueue.WorkOnQueue, oQueue.bForceState), 0)
return None
else:
return oQueue.WorkOnQueue(bForce=oQueue.bForceState)
def ExecuteActionCall(self,oAction):
"""
WikiDoc:Doc
WikiDoc:Context:ActionsDetails
WikiDoc:Page:Actions-Call
WikiDoc:TOCTitle:call
= call =
Calls a single/multi line action / macro like a function. You have to use the action name of the target as a function name. You can call only multi line actions / macros, not single actions within a macro.
<div style="overflow:auto; ">
{| class="wikitable"
! align="left" | Attribute
! align="left" | Description
|-
|string
|call
|-
|actionname
|multi line action / macro name to call
The actionname could be the name of an action, or one of the following keywords
* APPSTARTACTIONS
* DEFINITIONSTARTACTIONS
* PAGESTARTACTIONS
* PAGESTOPACTIONS
|-
|pagename
|Optional: Name of the page, for which Pagestart/stop Actions to call (only if actionname is PAGESTARTACTIONS/PAGESTOPACTIONS)
|-
|currentpagename
|Optional: Name of the the current pagename: (only if actionname is PAGESTARTACTIONS/PAGESTOPACTIONS)
|-
|enforce
|Optional: attribute to enforce page startaction or page stopactions (only if actionname is PAGESTARTACTIONS/PAGESTOPACTIONS). valid options are:
* ENFORCESTARTACTIONS
* ENFORCESTOPACTIONS
|}</div>
Actionpars:
If the call is triggred directly by a widget click, each action parameter from the widget will create a variable with name ActionName+"_parameter_"+parameter name. This enables the called function to receive parameters
A short example:
<div style="overflow-x: auto;"><syntaxhighlight lang="xml">
<action name="Return to last page" string="call gotolastpage" />
</syntaxhighlight></div>
WikiDoc:End
"""
#self.oEvenDispatcher.bDoNext = False
#self.oEvenDispatcher.bDoNext = True
self.oEvenDispatcher.LogAction(u'Call',oAction)
uActionName = ReplaceVars(oAction.dActionPars.get("actionname",""))
uEnforce = ReplaceVars(oAction.dActionPars.get("enforce",""))
uPageName = ReplaceVars(oAction.dActionPars.get("pagename",""))
uCurrentPageName = ReplaceVars(oAction.dActionPars.get("currentpagename",""))
bForceState = GetActiveQueue().bForceState
oFunction = Globals.oActions.GetActionList(uActionName = ReplaceVars(uActionName), bNoCopy = False)
if oFunction is None:
if uActionName=="APPSTARTACTIONS":
oFunction=Globals.oActions.GetPageStartActionList(uActionName = u'appstart', bNoCopy=True)
if oFunction is None:
return 0
elif uActionName=="DEFINITIONSTARTACTIONS":
oFunction=Globals.oActions.GetPageStartActionList(uActionName=u'definitionstart', bNoCopy=True)
if oFunction is None:
return 0
elif uActionName=="PAGESTARTACTIONS":
# we want to prevent pagestart actions, if the old page was just a popup, or we enforce it
uLastPageName=""
oLastPage=Globals.oTheScreen.oScreenPages.GetLastPage()
if oLastPage:
uLastPageName=oLastPage.uPageName
if (not Globals.oTheScreen.IsPopup(uLastPageName)) or ('ENFORCESTARTACTIONS' in uEnforce):
oFunction=Globals.oTheScreen.ShowPageGetPageStartActions(uPageName=uPageName)
if oFunction is not None:
uActionName=u"PageStartAction"
Logger.debug("Action: () Calling PageStartAction for page: {0}".format(uPageName))
oAction.oParentWidget=Globals.oTheScreen.oCurrentPage.oWidgetBackGround
else:
return 0
else:
self.oEvenDispatcher.LogAction(u'Skipping PageStartAction',oAction,u' for: {0}'.format(uPageName))
return 0
elif uActionName=="PAGESTOPACTIONS":
# we want to prevent pagestop actions, if the new page is just a popup or we enforce it
# Or we want to force it
if (not Globals.oTheScreen.IsPopup(uCurrentPageName) or ("ENFORCESTOPACTIONS" in uEnforce) ):
oFunction=Globals.oTheScreen.ShowPageGetPageStopActions(uPageName="$var(CURRENTPAGE)")
if oFunction is not None:
uActionName=u"PageStopAction"
self.oEvenDispatcher.LogAction(u'Calling PageStopAction',oAction,u' for: {0}'.format(ReplaceVars("$var(CURRENTPAGE)")))
oAction.oParentWidget=Globals.oTheScreen.oCurrentPage.oWidgetBackGround
else:
return 0
else:
self.oEvenDispatcher.LogAction(u'Skipping PageStopAction',oAction,u' for: {0}'.format(ReplaceVars("$var(CURRENTPAGE)")))
return 0
if oFunction is not None:
# oTmpFunction=copy(oFunction)
oTmpFunction = []
for oTmp in oFunction:
oTmpFunction.append(copy(oTmp))
if oAction.oParentWidget is not None:
self.oEvenDispatcher.CopyActionPars(dTarget=oTmpFunction[0].dActionPars,dSource=oAction.oParentWidget.dActionPars,uReplaceOption="donotreplacetarget")
self.oEvenDispatcher.CopyActionPars(dTarget=oAction.dActionPars,dSource=oAction.oParentWidget.dActionPars,uReplaceOption="donotreplacetarget")
else:
self.oEvenDispatcher.CopyActionPars(dTarget=oTmpFunction[0].dActionPars,dSource=oAction.dActionPars,uReplaceOption="donotreplacetarget")
#for aActionParKey in oTmpFunction[0].dActionPars:
#SetVar(uActionName+"_parameter_"+aActionParKey,oTmpFunction[0].dActionPars[aActionParKey])
for aActionParKey in oAction.dActionPars:
if aActionParKey != "linefilename" :
# SetVar(uVarName = uActionName+"_parameter_"+aActionParKey, oVarValue = oAction.dActionPars[aActionParKey])
SetVar(uVarName = uActionName+"_parameter_"+aActionParKey, oVarValue = ReplaceVars(oAction.dActionPars[aActionParKey]))
self.oEvenDispatcher.ExecuteActionsNewQueue(aActions=oTmpFunction,oParentWidget=oAction.oParentWidget,bForce=bForceState)
return 0
uMsg=self.oEvenDispatcher.CreateDebugLine(oAction,'Wrong Call')+u"\nFileName:"+oAction.uFileName
Logger.error (uMsg)
for uKey in sorted(Globals.oActions.dActionsCommands):
LogError(u'Action: Call: Available Name: [%s]' % (uKey) )
DumpQueue()
ShowErrorPopUp(uTitle='Warning',uMessage=uMsg)
return 1
def UnPauseQueue(self) -> None:
""" restarts a queue by reactivating the timer """
ResumeQueue()
Clock.schedule_once(
partial(GetActiveQueue().WorkOnQueue, self.bForceState), 0)
def ForceWorkQueue(self):
""" explicit starts a queue """
GetActiveQueue().WorkOnQueue(True,None)