Project

General

Profile

Topicbox » History » Version 7

Per Amundsen, 02/16/2023 03:32 PM

1 1 Per Amundsen
_Added in 1.9.1_
2
3 3 Per Amundsen
*/topicbox [-dhostabNeNfNpvck] [window] [text|color]*
4 1 Per Amundsen
5 6 Per Amundsen
Sets [[Topicbox Control|Topicbox]] visibility or visibility style and/or fills the [[Topicbox Control|Topicbox]] of the current or specified window with the specified text.
6 1 Per Amundsen
7
*Switches*
8
9 7 Per Amundsen
table(ktable).
10
|*Switch*|*Description*|
11
| -d | Use default visibility option. |
12
| -h | Show [[Topicbox Control<notextile>|</notextile>Topicbox]] as one line, expandable on click. |
13
| -o | Hide [[Topicbox Control<notextile>|</notextile>Topicbox]] |
14
| -s | Set current [[Topicbox Control<notextile>|</notextile>Topicbox]] option as default for all [[Topicbox Control<notextile>|</notextile>Topicbox]]es. |
15
| -t | Show [[Topicbox Control<notextile>|</notextile>Topicbox]] multiline sticky. |
16
| -a | Use the [[Topicbox Control<notextile>|</notextile>Topicbox]] from the current active window. |
17
| -bN | Set selection start to position N. |
18
| -eN | Set selection end to position N. |
19
| -fN | If N = 1/[$null] sets focus to the [[Topicbox Control<notextile>|</notextile>Topicbox]] and makes sure the window is not minimized and active. |
20
| -p | Append a white-space after the text. |
21
| -v | Prevents the [[Topicbox Control<notextile>|</notextile>Topicbox]] contents from being changed. |
22
| -c | Sets the [[Topicbox Control<notextile>|</notextile>Topicbox]] text color. |
23
| -k | Sets the [[Topicbox Control<notextile>|</notextile>Topicbox]] background color. |
24 6 Per Amundsen
25
*Parameters*
26 1 Per Amundsen
27 7 Per Amundsen
table(ktable).
28
|*Parameter*|*Description*|
29
| [window] | Window to change the [[Topicbox Control<notextile>|</notextile>Topicbox]]. |
30
| [text<notextile>|</notextile>color] | Text to set or color to set with -c and -k switches. |
31 1 Per Amundsen
32
*Example*
33
34
<pre>
35 2 Per Amundsen
; Show Topicbox as one line on #channel.
36 1 Per Amundsen
/topicbox -h #channel
37
38 2 Per Amundsen
; Hide Topicbox on #channel.
39 1 Per Amundsen
/topicbox -o #channel
40 2 Per Amundsen
41
; Set the Topicbox text for #channel.
42
/topicbox #channel Test Topic
43 1 Per Amundsen
</pre>