AcornSearch - Acorn and RISC OS information searching
RISC OS Search
containing
"Nutty quip goes here!"
Home  |  About  |  Filebase Archive  |  StrongHelp Manuals  |  Newsgroups  |  Module Database
Entry
     R0 = 17
     R1 = task handle
     R2 = features flags
           bit     meaning
           0     reserved; MUST BE 0
           1     Automatically recreate menus if set
           2     reserved; MUST BE 0
           3     Automatically compact heap once a second if set
           4     Correct radio icons if set
           5     semi-automatic help if set, automatic otherwise
           6     Use alternative parameters for flag-setting SWIs if set
           7     Use R0 of WimpExt_SetIconString[N]
           8     Automatically call WimpExt_MoveCaret
           9     Unset other icons in ESG when setting icons
           10     Automatically call WimpExt_ViewIcon after moving caret
           11     Do not allow TAB for moving between writeable icons
           12-31     reserved; MUST BE 0
     R3 -> task name (max 32 characters)
Exit
     R0 = WimpExtension version number * 100

Must be called prior to using any other WimpExt calls. R0 must be 17 on entry. This is so that WimpExtension can work out what version the program thinks it is calling (so I can change the functionality of calls later whilst still retaining backwards-compatibility). R2 holds features flags, for specifying certain things at start-up. Note that WimpExtension will take a copy of the task name pointed to by R3.

If bit 1 is set then if the user selects a menu option with the ADJUST button then the menu will automatically be recreated when you next call WimpExt_PrePoll (assuming you used WimpExt_CreateMenu to create the menu, that is).

If bit 3 is set then WimpExtension will automatically compact your heap once a second.

If bit 4 is set then the user wont be able to deselect all of a group of radio icons by clicking adjust on the selected icon. (This is usually the desired effect, and the Wimp provides no method of doing it automatically.)

If bit 5 is set then instead of automatically reading help strings from validation commands stored in your icons, WimpExtension will send you a message with a suggested string. You can then pass that to WimpExt_SendHelp or alter the message. See the "Help" section for more information.

If bit 6 is set then SWIs that allow you to set icons will allow you to pass unset/set/toggle as 0, 1 or 2 - instead of unset/set as 0 or not 0.

If bit 7 is set then WimpExt_SetIconString[N] checks R0 to see if it should attempt an ellipsis.

If bit 8 is set then up/down arrows will be processed automatically for you to move between writable icons.

If bit 9 is set then if you set an icon to be selected then all the other icons in the ESG will be automatically unset - extremely useful when set configuration windows.

If bit 10 is set then when the caret is set using WimpExt_PutCaretIcon or automatically if bit 8, the icon will be made visible by moving the scroll bar of the window if not in view at the time.

If bit 11 is set then TAB (or SHIFT-TAB) will not move between icons.

Provided by Kernel

[sh-index] Back to list of manuals