AES Function Reference

return crys_if(0x13);

addrin[0] = fname;

return crys_if(0x0D);

If the upper word of the CHAR * is 0xFFFE, the lower word is assumed to be the AES application identifier and the MiNT id is returned.

If the upper word of the CHAR * is 0x0000, the current processes' application identifier is returned.This functionality only exists if the AES version is 4.0 and above and appl_getinfo() indicates that it is available.

ap_gout1 is filled in with the AES font's point size.

ap_gout2 is filled in with the font id.

ap_gout3 is a code indicating the type of font:

SYSTEM_FONT (0) is the system font

OUTLINE_FONT (1) is an outline font

ap_gout4 is unused.

Same as above for the current small font.

ap_gout1 is filled in with the resolution number (as would be returned by Getrez()).

ap_gout2 is filled in with the number of colors supported by the AES object library.

ap_gout3 is 0 if color icons are not supported or 1 if they are.

ap_gout4 is 0 to indicate that the extended resource file format is not supported or 1 if it is.

ap_gout1 is filled in with the current AES language code as follows:Name ap_gout1 LanguageAESLANG_ENGLISH 0 English

AESLANG_GERMAN 1 German

AESLANG_FRENCH 2 French

- 3 (Reserved)

AESLANG_SPANISH 4 Spanish

AESLANG_ITALIAN 5 Italian

AESLANG_SWEDISH 6 Swedishap_gout2, ap_gout3, and ap_gout4 are unused.

ap_gout1 is 0 to indicate the use of non-pre-emptive multitasking and 1 to indicate the use of pre-emptive multitasking.

ap_gout2 is 0 if appl_find() cannot convert between MiNT and AES id's and 1 to indicate that it can.

ap_gout3 is 0 if appl_search() is not implemented and 1 if it is.

ap_gout4 is 0 if rsrc_rcfix() is not implemented and 1 if it is.

ap_gout1 is 0 if objc_xfind() is not implemented and 1 if it is.

ap_gout2 is currently reserved.

ap_gout3 is 0 if menu_click() is not implemented and 1 if it is.

ap_gout4 is 0 if shel_rdef() and shel_wdef() are not implemented and 1 if they are.

ap_gout1 is 0 if -1 is not a valid ap_id parameter to appl_read() or 1 if it is.

ap_gout2 is 0 if -1 is not a valid length parameter to shel_get() or 1 if it is.

ap_gout3 is 0 if -1 is not a valid mode parameter to menu_bar() or 1 if it is.

ap_gout4 is 0 if MENU_INSTL is not a valid mode parameter to menu_bar() or 1 if it is.

ap_gout1 is 0 to indicate that mode parameters of 258-260 are not supported by graf_mouse() and 1 if they are.

ap_gout2 is 0 to indicate that the application has control over the mouse form and 1 to indicate that the mouse form is maintained by the AES on a per-application basis.

ap_gout3 and ap_gout4 are currently unused.

ap_gout1 is 0 to indicate that sub-menus are not supported and 1 if MultiTOS style sub-menus are.

ap_gout2 is 0 to indicate that popup menus are not supported and 1 if MultiTOS style popup menus are.

ap_gout3 is 0 to indicate that scrollable menus are not supported and 1 if MultiTOS style scrollable menus are.

ap_gout4 is 0 to indicate that the MN_SELECTED message does not contain object tree information in msg[57] and 1 to indicate that it does.

ap_gout1 & 0x00FF indicates the highest legal value for the mode parameter of shel_write(). ap_gout1 & 0xFF00 indicate which extended shel_write() mode bits are supported.

ap_gout2 is 0 if shel_write() with a mode parameter of 0 launches an application or 1 if it cancels the previous shel_write().

ap_gout3 is 0 if shel_write() with a mode parameter of 1 launches an application immediately or 1 if it takes effect when the current application exits.

ap_gout4 is 0 if ARGV style parameter passing is not supported or 1 if it is.

ap_gout1 is a bitmap of extended modes supported by wind_get() and wind_set() (if a bit is set, it is supported) as follows: Bit mode

0 WF_TOP returns window below the top also.

1 wind_get( WF_NEWDESK, ... ) supported.

2 WF_COLOR get/set.

3 WF_DCOLOR get/set.

4 WF_OWNER get/set.

5 WF_BEVENT get/set.

6 WF_BOTTOM set.

7 WF_ICONIFY set.

8 WF_UNICONIFY set.

9-15 Unused

ap_gout2 is current unused.

ap_gout3 is a bitmap of supported window behaviors (if a bit is set, it is supported) as follows:

Bit Behaviour

0 Iconifier gadget present.

1 Bottomer gadget present.

2 shift-click sends window to bottom.

3 "hot" close box supported.

4-15 Unused

ap_gout4 is currently unused.

ap_gout1 is a bitmap of extra messages supported (if a bit is set, it is supported) as follows: Bit Message

0 WM_NEWTOP is meaningful.

1 WM_UNTOPPED is sent.

2 WM_ONTOP is sent.

3 AP_TERM is sent.

4 Shutdown and resolution change messages.

5 CH_EXIT is sent.

6 WM_BOTTOMED is sent.

7 WM_ICONIFY is sent.

8 WM_UNICONIFY is sent.

9 WM_ALLICONIFY is sent.

10-15 Unused

ap_gout2 is a bitmap of extra messages supported. Current all bits are unused.

ap_gout3 is a bitmap indicating message behaviour (if a bit is set, the behaviour exists) as follows:

Bit Message

0 WM_ICONIFY message gives coordinates.

1-15 Unused

ap_gout4 is currently unused.

ap_gout1 is 0 if 3D objects are not supported or 1 if they are.

ap_gout2 is 0 if objc_sysvar() is not present, 1 if MultiTOS v1.01 objc_sysvar() is present, or 2 if extended objc_sysvar() is present.

ap_gout3 is 0 if the system font is the only font supported or 1 if GDOS fonts are also supported.

ap_gout4 is reserved for OS extensions.

ap_gout1 is 0 if 'flying dialogs' are not supported or 1 if they are.

ap_gout2 is 0 if keyboard tables are not supported or 1 if Mag!X style keyboard tables are supported.

ap_gout3 is 0 if the last cursor position from objc_edit() is not returned or 1 if it is.

ap_gout4 is currently reserved.

intin[0] = ap_gtype;

crys_if(0x82);

*ap_gout1 = intout[1];
*ap_gout2 = intout[2];
*ap_gout3 = intout[3];
*ap_gout4 = intout[4];

return intout[0];

return crys_if(0x0A);

Besides the return value, the AES fills in the application's global array (to reference the global array see your programming languages' manual).

intin[0] = ap_id;
intin[1] = length;

addrin[0] = message;

return crys_if(0x0B);

It is recommended that message lengths in multiples of 16 bytes be used.

ap_id is a pointer to a word into which will be placed the processes' application identifier.

intin[0] = mode;

addrin[0] = fname;
addrin[1] = type;
addrin[2] = ap_id;

return crys_if(0x12);

scale indicates on a scale of 1 to 10000 how fast the AES will attempt to play back your recording. A value of 100 will play it back at recorded speed. A value of 200 will play the events back at twice the recorded speed, and 50 will play back the events at half of the recorded speed. Other values will respond accordingly.

intin[0] = num;
intin[1] = scale;

addrin[0] = mem;

return crys_if(0x0E);

typedef struct pEvntrec
{
 WORD ap_event;
 LONG ap_value;
} EVNTREC;ap_event defines the required interpretation of ap_value as follows:

high word = # of clicks

high word = Y pos

bits 8-15: scan code

bits 16-31: shift key state

intin[0] = num;

addrin[0] = mem;

return crys_if(0x0F);

intin[0] = ap_id;
intin[1] = length;

addrin[0] = msg;

return crys_if(0x0C);

As of AES version 4.00 you can use shel_write(7,...) to 'broadcast' a message to all processes running with the exception of the AES itself, the desktop, and your own application. See shel_write() for details.

button is a pointer to a WORD which upon return will contain the mouse button state as defined in state.

kstate is a pointer to a WORD which upon return will contain the current status of the keyboard shift keys. The value is a bit-mask defined as follows:

intin[0] = clicks;
intin[1] = mask;
intin[2] = state;

crys_if(0x15);

*mx = intout[1];
*my = intout[2];
*button = intout[3];
*kstate = intout[4];

return intout[0];

Fastest

intin[0] = new;
intin[1] = flag;

return crys_if(0x1A);

return crys_if(0x14);

addrin[0] = msg

return crys_if(0x17);

WM_REDRAW

WM_TOPPED

WM_CLOSED

WM_FULLED

WM_ARROWED

WM_HSLID

WM_VSLID

WM_SIZED

WM_MOVED

WM_UNTOPPED

WM_ONTOP

WM_BOTTOM

WM_ICONIFY

WM_UNICONIFY

WM_ALLICONIFY

WM_TOOLBAR

AC_OPEN

AC_CLOSE

AP_TERM

AP_TFAIL

AP_RESCHG

SHUT_COMPLETED

RESCH_COMPLETED

AP_DRAGDROP

SH_WDRAW

CH_EXIT

20

21

22

23

24

25

26

27

28

30

31

33

34

35

36

37

40

41

50

51

57

60

61

63

72

90

As of AES version 3.30 (and when indicated by appl_getinfo() ), msg[5] and msg[6] contain the high and low word, respectively, of the object tree of the menu item. msg[7] contains the parent object index of the menu item.

When the message is received the window contents should be drawn (or a representative icon if the window is iconified).

You should use wind_set( msg[3], WF_TOP, 0, 0, 0, 0) to actually cause the window to be topped.

You should react to this message with wind_close().

If the window was previously 'fulled' and has not been resized since, the application should return the window to its previous size.

A row or column message is sent when a slider arrow is selected. A 'page' message is sent when a darkened area of the scroll bar is clicked. This usually indicates that the application should adjust the window's contents by a larger amount than with the row or column messages.

msg[3] indicates which action was actually selected as follows: Name Value Meaning

WA_UPPAGE 0 Page Up

WA_DNPAGE 1 Page Down

WA_UPLINE 2 Row Up

WA_DNLINE 3 Row Down

WA_LFPAGE 4 Page Left

WA_RTPAGE 5 Page Right

WA_LFLINE 6 Column Left

WA_RTLINE 7 Column Right

Note: Slider position is relative and not related to slider size.

Note: Slider position is relative and not related to slider size.

Use wind_set(handle, WF_CURRXYWH,... to actually size the window.

WM_SIZED and WM_MOVED usually share common handling code.

Use wind_set(handle, WF_CURRXYWH,... ) to actually move the window.

WM_MOVED and WM_SIZED usually share common handling code.

The application need take no action. The message is for informational use only.

This message requires no action, it is for informational purposes only.

If the iconified window represents a single window this message should be responded to by using wind_set() with a parameter of WF_ICONIFY.

This message should be responded to by using wind_set() with a parameter of WF_UNICONIFY.

The application should respond to this message by closing all open windows and opening a new iconified window at the position indicated which represents the application.

msg[4] contains the object index of the object clicked. msg[5] contains the number of clicks. msg[6] contains the state of the keyboard shift keys at the time of the click (as in evnt_keybd() ).

Do not close any windows your accessory had open, the system will do this for you. Also, do not require any feedback from the user when this is received. Treat this message as a 'Cancel' from the user.

The application should shut down immediately after closing windows, freeing resources, etc... msg[5] indicates the reason for the shut down as follows: AP_TERM (50) = Just shut down.

AP_RESCHG (57) = Resolution Change.If for some reason, your process can not shut down you must inform the AES by sending an AP_TFAIL (51) message by using shel_write() mode 10 (see shel_write()).

Note: Desk Accessories wil always be sent AC_CLOSE messages, not AP_TERM.

msg[0] should contain AP_TFAIL and msg[1] should contain the application error code.

msg[4-5] contains the X and Y position of the mouse when the object was 'dropped'. msg[6] indicates the keyboard shift state at the time of the drop (as in evnt_keybd() ).

msg[7] is a two-byte ASCII packed pipe identifier which gives the file extension of the pipe to open.

For more information about the drag & drop protocal, see Chapter 2: GEMDOS.

WM_BOTTOM, WM_ICONIFY, WM_UNICONIFY, WM_ALLICONIFY, and WM_TOOLBAR are new as of AES version 4.1.

No lower version AES will send these messages.

The existence (or acceptance) of these messages should also be checked for by using appl_getinfo().

button is a WORD pointer which will be filled in upon return with the final state of the mouse button as defined in evnt_button().

kstate is a WORD pointer which will be filled in upon return with the final state of the keyboard shift keys as defined in evnt_button().

intin[0] = flag;
intin[1] = x;
intin[2] = y;
intin[3] = w;
intin[4] = h;

crys_if(0x16);

*mx = intout[1];
*my = intout[2];
*button = intout[3];
*kstate = intout[4];

return intout[0];

This call is usually the cornerstone of all GEM applications that must process system events.

For usage of m1flag, m1x, m1y, m1w, m1h, m2flag, m2x, m2y, m2w, and m2h, consult evnt_mouse().

For usage of msg, see evnt_mesag().

For usage of locount and hicount, see evnt_timer().

intin[0] = events;
intin[1] = bclicks;
intin[2] = bmask;
intin[3] = bstate;
intin[4] = m1flag;
intin[5] = m1x;
intin[6] = m1y;
intin[7] = m1w;
intin[8] = m1h;
intin[9] = m2flag;
intin[10] = m2x;
intin[11] = m2y;
intin[12] = m2w;
intin[13] = m2h;
intin[14] = locount;
intin[15] = hicount;

addrin[0] = msg;

crys_if(0x19);

*mx = intout[1];
*my = intout[2];
*mb = intout[3];
*ks = intout[4];
*kc = intout[5];
*mc = intout[6];

return intout[0];

hicount is the high portion of that 32-bit value.

intin[0] = locount;
intin[1] = hicount;

return crys_if(0x18);

# specifies the icon to display in the alert as follows:

'Buttons' is a text string to define as many as 3 buttons up to 10 characters each. If only one button is used, its text may be as long as 30 characters. Again, each button is separated by a '|' character

intin[0] = default;

addrin[0] = alertstr;

return crys_if(0x34);

2. Add one space to the end of the longest text line on an alert. This will prevent the right edge from touching the border in some AES versions.

clicks is the number of times the mouse button was clicked.

newobj returns the next object to gain edit focus or 0 if there are no editable objects. If the top bit of newobj is set, this indicates that a TOUCHEXIT object was double-clicked.

intin[0] = obj;
intin[1] = clicks;

addrin[0] = tree;

crys_if(0x38);

*newobj = intout[1];

return intout[0];

2. When a click occurs, use objc_find() to determine if the click occurred over the object.

3. If so, call form_button() with the appropriate values.This function was not originally documented by Atari. You may have to add bindings for this function to some earlier 'C' compilers.

addrin[0] = tree;

crys_if(0x36);

*x = intout[1];
*y = intout[2];
*w = intout[3];
*h = intout[4];

return intout[0];

intin[0] = mode;
intin[1] = x1;
intin[2] = y1;
intin[3] = w1;
intin[4] = h1;
intin[5] = x2;
intin[6] = y2;
intin[7] = w2;
intin[8] = h2;

return crys_if(0x33);

editobj is the object index into tree which specifies the desired initial location of the edit cursor (the object must be flagged as EDITABLE). If the form has no text editable fields, you should use 0.

intin[0] = editobj;

addrin[0] = tree;

return crys_if(0x32);

The application can not find the folder or file that you tried to access.

The application cannot find the folder or file that you tried to access.

The application does not have room to open another document. To make room, close any open document that you do not need.

An item with this name already exists in the directory, or this item is set to read-only status.

There is not enough memory for the application you just tried to run.

There is not enough memory for the application you just tried to run.

There is not enough memory for the application you just tried to run.

The drive you specified does not exist.

You cannot delete the folder in which you are working.

The application can not find the folder or file that you tried to access.

intin[0] = error;

return crys_if(0x35);

kc is the value returned from evnt_keybd() or evnt_multi() which represents the keypresses' scan code and ASCII value.

newobj is a WORD pointer which is filled in on function exit to be the new object with edit focus unless the return key was pressed with a default object present in which case it equals the object index of the object that was the default.

keyout is the value ready to be passed on to objc_edit() if no processing was required or 0 if the key was processed and handled by the call.

intin[0] = obj;
intin[1] = kc;
intin[2] = nextobj;

addrin[0] = tree;

crys_if(0x37);

*newobj = intout[1];
*keyout = intout[2];

return intout[0];