AUI_Control Parameters

All of the parameters are optional except for the first two, opcode and ctlid, which together are sufficient to delete the control. Even when adding a new control, the last several parameters are only needed when you want to do something slightly unusual or fancy. Refer to the documentation on the individual parameters below for deciding how many you need to specify for a particular effect.

In the case of opcode CTLOP_INFO, all of the parameters besides opcode may be updated. The indicators in the I/O column ignore this case and apply only to the opcodes other than CTLOP_INFO.

Parameter

Type

I/O

Description

opcode

Num

in

Determines the "method" or operation to perform.

ctlid

Num

in/out

Control ID: an integer starting from 1, or an alphanumeric name, that uniquely identifies each control.

ctext

String

in/out

Text associated with the control. For most typical controls (buttons, static text, checkbox, etc.) this is the text that appears in the control.

cstate

B,4

in

State of the control (enabled, disabled, hidden, etc.).

ctype

B,4

in

Control type and attributes. For more exotic controls, leave this zero and use winclass, winstyle, winstylex.

cmd

String

in

Specifies the command or keyboard string which is invoked when the control is clicked.

func

Num

in/out

When the cmd type is DLL, this can specify a function within the DLL to execute. For checkboxes, func is a 1-byte binary which gets set and cleared along with the display state of the checkbox.

cstatus

Signed Num

in/out

Returns status indicating success of operation. For some opcodes, it is used as an input also.

srow, scol, erow, ecol

Num

in

Coordinates of the control.

fgc, bgc

Num

in

Foreground and background color palette numbers for the control.

fontattr

B,4

in

Used to override the default font attributes for the control.

fontscale

Num

in

Scales the font to the specified percentage.

fontface

String

in

Overrides the default font selection.

tooltip

String

in

Defines a "tooltip" (popup message)

parentid

Num

in

If specified, new control becomes child of specified control.

winclass

String

in

May be used as an alternative to ctype to create a control using the standard Windows control classes and styles.

winstyle

winstylex

B,4

in

ctype2

B,4

in

Extension of ctype; control type and attributes.