Project

General

Profile

$toolbar » History » Version 15

Per Amundsen, 02/23/2023 07:51 PM

1 1 Per Amundsen
_Added in 1.9.3_
2
3
*$toolbar*
4
5 12 Per Amundsen
Returns [[$true]] if the [[Toolbar_Control|Toolbar]] is visible, otherwise [[$false]].
6 3 Per Amundsen
7 14 Per Amundsen
_See also [[/toolbar]], [[Toolbar_Control|Toolbar]]._
8
9 7 Per Amundsen
-----------------------------------------------------------------------------
10
11 6 Per Amundsen
*$toolbar(name||N)*
12 3 Per Amundsen
13 12 Per Amundsen
Returns properties for a [[Toolbar_Control|Toolbar]] button.
14 3 Per Amundsen
15
*Parameters*
16
17 15 Per Amundsen
table(ktable).
18
|*Parameter*|*Description*|
19
| name<notextile>|</notextile><notextile>|</notextile>N | Toolbar item name or the Nth item, if N = 0, number of [[Toolbar_Control<notextile>|</notextile>Toolbar]] items. |
20 1 Per Amundsen
21
*Properties*
22
23 15 Per Amundsen
table(ktable).
24
|*Property*|*Description*|
25
| .name | [[Toolbar_Control<notextile>|</notextile>Toolbar]] item name. |
26
| .type |  button or separator. |
27
| .tip | [[Toolbar_Control<notextile>|</notextile>Toolbar]] tooltip text. |
28
| .alias | [[Toolbar_Control<notextile>|</notextile>Toolbar]] alias. |
29
| .popup | [[Toolbar_Control<notextile>|</notextile>Toolbar]] popup name. |
30
| .width | [[Toolbar_Control<notextile>|</notextile>Toolbar]] item width. |
31
| .height | [[Toolbar_Control<notextile>|</notextile>Toolbar]] item height. |
32
| .wide | *TODO* ($true) |
33
| .enabled | [[$true]] if the Toolbar item is enabled, otherwise [[$false]]. |
34
| .visible | [[$true]] if the Toolbar item is visible, otherwise [[$false]]. |
35
| .checked | [[$true]] if the Toolbar item is checked, otherwise [[$false]]. |
36
| .alpha | *TODO* (0) |
37
| .iconfile | Returns the icon file, if any. *(AdiIRC only)* |
38
| .x | Horizontal position of the [[Toolbar_Control<notextile>|</notextile>Toolbar]] item relative to the main AdiIRC window. *(AdiIRC only)* |
39
| .y | Vertical position of the [[Toolbar_Control<notextile>|</notextile>Toolbar]] item relative to the main AdiIRC window. *(AdiIRC only)* |
40
| .w | [[Toolbar_Control<notextile>|</notextile>Toolbar]] item width. *(AdiIRC only)* |
41
| .h | [[Toolbar_Control<notextile>|</notextile>Toolbar]] item height. *(AdiIRC only)* |
42
| .dx | Horizontal position of the [[Toolbar_Control<notextile>|</notextile>Toolbar]] item relative to the desktop. *(AdiIRC only)* |
43
| .dy | Vertical position of the [[Toolbar_Control<notextile>|</notextile>Toolbar]] item relative to the desktop. *(AdiIRC only)* |
44 4 Per Amundsen
45
*Example*
46
47
<pre>
48
; Print number of Toolbar items.
49
//echo -ag $toolbar(0)
50
51
; Print the first Toolbar item name.
52
//echo -ag $toolbar(1)
53
</pre>