$root.$itasks.TASK

Parent: $root.$itasks
 
Children 

Class notation

Properties Methods 

Properties

Object specific 
$autoactivateIf true, this task is activated when one of its windows comes to the top
$inheritedUsed when referring to a method or variable defined in a superclass
$instancetaskThe task which owns instances created by this task
$isIDEIf true,instances created by this task belong to the design desktop
$remotedebugIf true,remote debugging is allowed for this task instance and instances belonging to this task instance.Defaults to false in a new task instance
Standard$classtype $ident $isprivate $name

Methods

Object specific 
$asynccomplete$asynccomplete(iCallId,cErrText,vRetVal) Called when method called via Do async method completes;iCallId is the value returned by Do async method;vRetVal is the method return value (unless an error occurred,indicated by non-empty cErrText)
$darkmodechanged$darkmodechanged() Message sent to all task instances when the system dark mode changes.sys(253) can be used to determine if Omnis is currently using dark mode
$langchange$langchange(cNewLocale) All task instances receive this message when the operating system input language changes.cNewLocale is the locale string for the new input language.Not sent to remote tasks.(Microsoft Windows platforms only)
$localnotify$localnotify(iAction,wUserInfo) Called when the user clicks on a local operating system notification
$mainresized$mainresized(iWidth,iHeight) All task instances receive this message when the main window has been resized.Parameters are new sizes of space available (zero if window minimized).Not sent to remote tasks (Microsoft Windows platforms only)
$newlanguage$newlanguage() All task instances receive this message when $root.$prefs.$language changes.Not sent when $root.$prefs.$language is set to its initial value at startup.Not sent to remote tasks
$omnistoback$omnistoback() All task instances receive this message when another application becomes the front application.Not sent to remote tasks
$omnistofront$omnistofront(bClickInDock) All task instances receive this message when Omnis becomes the front application.On macOS,bClickInDock is true if and only if the message is sent as a result of a click on the dock.Not sent to remote tasks
$openfiles$openfiles(lList) All task instances receive this message when the OS uses Omnis to open the file list specified in lList.
$openlibschanged$openlibschanged() In a development version all task instances receive this message after one or more libraries have been opened or closed.This allows a receiving task to use the notation to update its list of open libraries
$processinit$processinit(&cErrorText) If present in a startup task the multi-process server calls this in each child process immediately after it is created.Returns true for success,or false and cErrorText for an error (the child process exits)
$quitcancancelasync$quitcancancelasync() Sent when quitting,to the startup task of all libraries for which an async method is running.Returns qtrue if Omnis can cancel the async method(s) without prompting the user
$showmessage$showmessage(cMessage[,cTitle,iOptions=kMsgOK]) displays a message using the specified cMessage,cTitle and iOptions (a sum of kMsg... constants).Returns true for OK or Yes,false for No or cancel.Use msgcancelled() to check for cancel
$showtoast$showtoast(cMessage[,cTitle,iStyle=kToastSuccess,iStack=kToastStackTopRight,iTimer=4000,bClearStack=kFalse,cContext='']) displays a toast notification using the title and message using the style
$systemcansleep$systemcansleep() All task instances receive this message when the system is attempting to sleep. Any task returning kFalse will cancel sleep
$systemdidwake$systemdidwake() All task instances receive this message when the system has woken from sleep
$systemwillsleep$systemwillsleep() All task instances receive this message when the system is about to enter a non-abortable sleep
$systemwillwake$systemwillwake() All task instances receive this message when the system is waking from sleep
$urlinvoked$urlinvoked(cScheme,wParams) Called when Omnis is invoked using a custom URL scheme
Standard$canclose $close

Children

Top 

$ivars$methods$tvars