IS_BTN Struct Reference

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 - see below
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.

Lowest 7 bits are the maximum number of characters to type in (0 to 95) Highest bit (128) can be set to initialise dialog with the button's text

Text : 0-65-66-0 would display button text "AB" 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 2081 of file ispackets.h.

---

Field Documentation

byte IS_BTN::Size

12 + TEXT_SIZE (a multiple of 4)

Definition at line 2083 of file ispackets.h.

byte IS_BTN::Type

ISP_BTN

Definition at line 2084 of file ispackets.h.

byte IS_BTN::ReqI

non-zero (returned in IS_BTC and IS_BTT packets)

Definition at line 2085 of file ispackets.h.

byte IS_BTN::UCID

connection to display the button (0 = local / 255 = all)

Definition at line 2086 of file ispackets.h.

byte IS_BTN::ClickID

button ID (0 to 239)

Definition at line 2088 of file ispackets.h.

byte IS_BTN::Inst

some extra flags

Definition at line 2089 of file ispackets.h.

byte IS_BTN::BStyle

button style flags

Definition at line 2090 of file ispackets.h.

byte IS_BTN::TypeIn

max chars to type in - see below

Definition at line 2091 of file ispackets.h.

byte IS_BTN::L

left : 0 - 200

Definition at line 2093 of file ispackets.h.

byte IS_BTN::T

top : 0 - 200

Definition at line 2094 of file ispackets.h.

byte IS_BTN::W

width : 0 - 200

Definition at line 2095 of file ispackets.h.

byte IS_BTN::H

height : 0 - 200

Definition at line 2096 of file ispackets.h.

char IS_BTN::Text[TEXT_SIZE]

0 to 240 characters of text

Definition at line 2098 of file ispackets.h.

---

The documentation for this struct was generated from the following file:

• ispackets.h