Ticket #2026: TrayMenuItem help.txt

File TrayMenuItem help.txt, 2.3 KB (added by anonymous, on Oct 3, 2011 at 9:25:04 PM)

Properly formatted version of the above (hopefully)

Line 
1; #FUNCTION# ====================================================================================================================
2; Name...........: TrayCreateItem
3; Description ...: Creates a menuitem control for the tray
4; Syntax.........:TrayCreateItem ( text [,parentID [, ixEntry [, fRadioItem]]] )
5
6; Parameters ....: text - The text of the control
7; $parentID - [optional] Control ID of parent menu (-1 if at first level). Default: -1
8; $ixEntry - [optional] Index of insertion position
9; |Default: -1 (new item is below previous item)
10; fRadioItem - [optional] 0 for checkbox, 1 for radio (black circle) Default: 0 (like checkbox)
11; Return values .: Success - Identifier (controlID) of the new tray menu item
12; -Failure - 0
13; Author ........:
14; Modified.......:
15; Remarks .......: If the text parameter is a blank string ( "" ) then a separator line is created
16; +
17; Behaviour of fRadioItem depends on value of Opt("TrayMenuModemode":
18; +
19; TrayMenuMode = 0, 1, or 5: item acts like checkbox or auto-radio
20; +
21; TrayMenuMode = 9 or 13: item acts like checkbox or manual radio
22; +
23; TrayMenuMode = 3 or 9: Set/clear checkbox/radio states by calling TrayItemSetState with
24; $TRAY_CHECKED/$TRAY_UNCHECKED parameters
25; +
26; For modes 0, 1, 5:
27; +
28; - radio groups are delimited by separators and checkbox items
29; +
30; - clicking on one radio item checks it and unchecks others in the group
31; +
32; For modes 0, 1, 5, 9 and 13: clicking on a checked checkbox item unchecks it; clicking on an unchexked one unchecks it
33; +
34; Place the #NoTrayIcon directive at the top of your script to leave icon display to TraySetState.
35; Related .......: TrayMenuMode, TrayItemSetState, TrayItemSetText, TrayGetMsg, TrayItemDelete, TrayItemSetOnEvent
36; Link ..........:
37; Example .......: Yes
38; ===============================================================================================================================