$tip » History » Version 6
Per Amundsen, 12/27/2018 12:04 AM
1 | 1 | Per Amundsen | _Added in 1.9.3_ |
---|---|---|---|
2 | |||
3 | 2 | Per Amundsen | *$tip(name/N)* |
4 | 1 | Per Amundsen | |
5 | Returns properties for the specified tip. |
||
6 | |||
7 | *Parameters* |
||
8 | |||
9 | 5 | Per Amundsen | name/N - Tip name or If N = 0 number of open tips, otherwise the Nth tip. |
10 | 1 | Per Amundsen | |
11 | *Properties* |
||
12 | |||
13 | .name - Tip name. |
||
14 | .title - Tip title. |
||
15 | .text - Tip text. |
||
16 | .delay - Delay in milliseconds until tip closes. |
||
17 | .iconfn - Icon file name. |
||
18 | .iconpos - Icon position. |
||
19 | .alias - Alias to be executed on double click. |
||
20 | .wid - Window id associated with this tip. |
||
21 | |||
22 | 3 | Per Amundsen | -------------------------- |
23 | |||
24 | 1 | Per Amundsen | *$tip(name,title,text,delay,iconfn,iconpos,alias,wid)* |
25 | |||
26 | Allows you to create scripted tips that are independent of normal tip events. Returns Nth position of tip if it was successfully created, zero if not. |
||
27 | 3 | Per Amundsen | |
28 | _Title and text can have [[Formatting_text|Control Codes]]._ |
||
29 | 6 | Per Amundsen | |
30 | *Example* |
||
31 | |||
32 | <pre> |
||
33 | ; Create and show a Tip using the title 'title here' and the text 'text here'. |
||
34 | ; Prefix with /noop to ignore the result. |
||
35 | //noop $tip(name, title here, text here) |
||
36 | |||
37 | </pre> |