Parent: $root
The current Omnis modes
| Object specific | |
| $ccursor | The current mouse cursor |
| $cddelib | (Windows only)Internal name of the library to use for DDE operations |
| $clist | The name of the current list |
| $creport | The name of the current report class |
| $csearch | The name of the current search class |
| $disableenter | If true, 'disable enter and escape keys' is switched on |
| $fixedcursor | If true, automatic changes to the cursor are disabled |
| $libopen | If true,Omnis is in the 'library open' state |
| $mainfile | The name of the main file |
| $nocanceltest | If true, 'disable cancel test at loops' is switched on |
| $nowait | If true, 'do not wait for semaphores' is switched on |
| $receiveaevents | (macOS only)If true, Apple events can be received |
| $serverport | The TCP/IP port number (1-65535) on which the Omnis Server is currently listening for connections |
| $stacklimit | The maximum number of methods which can be stacked |
| Standard | $height $width |
| $dotoolmethod | $dotoolmethod(iToolId,cMethodName[,method parameters]) calls an external method in an environment tool |
| $getapiobject | $getapiobject(cLibraryName) returns a new object reference to the API object for the library with name cLibraryName. If the library does not provide API object support, returns #NULL |
| $installtool | $installtool(iToolId[,cAddInMenuText,iIconId,cAddInMenuHelpText,cAddInMenuKey]) installs tool library on tools menu and toolbar; returns non-zero for success (for add-in tools value is config item base) If iToolId is kEnvToolAddOn,$install tool installs an add-on tool, on to the tools menu in the IDE. An add-on tool is an Omnis library which provides some additional functionality to the IDE; for example the string table editor is implemented as an add-on tool. You place a library implementing an add-on tool in the Startup folder of the development version, and then install the tool in $construct of its startup task, by calling $installtool. cAddInMenuText is the text which appears in the add-ons menu; iIconId is the icon id of the icon used for the menu line for the tool; cAddInMenuHelpText is the text which appears in the help bar when the menu line for the tool is highlighted. $installtool() returns a non-zero number for success. The tool can use this number as the first of 200 possible configuration item numbers in omnis.cfg, accessed using the configuration methods described for $root.$prefs. The number will be the same each time the tool installs itself, provided it does not change the menu-line-text; if you delete omnis.cfg, you may get a different number, but this does not matter, since you have also lost any configuration information the tool may have stored. When the user selects the add-on tool from the menu, Omnis calls the method $exectool() in the tool's startup task. This typically opens a window, or brings it to the front. |
| $welcome | $welcome(kWelcome...) executes a request from the welcome library |