BuTtoN. More...

#include <ispackets.h>

Data Fields
byte	Size
	12 + TEXT_SIZE (a multiple of 4)
byte	Type
	ISP_BTN
byte	ReqI
	non-zero (returned in IS_BTC and IS_BTT packets)
byte	UCID
	connection to display the button (0 = local / 255 = all)
byte	ClickID
	button ID (0 to 239)
byte	Inst
	some extra flags
byte	BStyle
	button style flags
byte	TypeIn
	max chars to type in
byte	L
	left : 0 - 200
byte	T
	top : 0 - 200
byte	W
	width : 0 - 200
byte	H
	height : 0 - 200
char	Text [TEXT_SIZE]
	0 to 240 characters of text

Detailed Description

BuTtoN.

button header - followed by 0 to 240 characters

ClickID byte : this value is returned in IS_BTC and IS_BTT packets.

TypeIn byte : if set, the user can click this button to type in text.

Text : 65-66-67-0 would display button text "ABC" and no caption

Text : 0-65-66-67-0-68-69-70-71-0-0-0 would display button text "DEFG" and caption "ABC"

Inst byte : mainly used internally by InSim but also provides some extra user flags

NOTE :: If width or height are zero, this would normally be an invalid button. But in that case if there is an existing button with the same ClickID, all the packet contents are ignored except the Text field. This can be useful for updating the text in a button without knowing its position. For example, you might reply to an IS_BTT using an IS_BTN with zero W and H to update the text.

Definition at line 2441 of file ispackets.h.