Amulets & Armor  v1.02
Open Source Game
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Macros | Functions
BUTTON

Button UI Component. More...

Macros

#define BUTTON_TAG   12345
 

Functions

T_void ButtonCleanUp (T_void)
 
T_buttonID ButtonCreate (T_word16 lx, T_word16 ly, T_byte8 *bmname, E_Boolean toggletype, T_word16 keyassoc, T_buttonHandler p_cbroutine, T_buttonHandler p_cbroutine2)
 
T_void ButtonDelete (T_buttonID buttonID)
 
T_void ButtonDisable (T_buttonID buttonID)
 
T_void ButtonDoCallback (T_buttonID buttonID)
 
T_void ButtonDoCallback2 (T_buttonID buttonID)
 
T_void ButtonDown (T_buttonID buttonID)
 
T_void ButtonDownNoAction (T_buttonID buttonID)
 
T_void ButtonDownNum (T_word16 num)
 
T_void ButtonDrawCallBack (T_graphicID graphicID, T_word16 info)
 
T_void ButtonDrawTextCallback (T_graphicID graphicID, T_word16 info)
 
T_void ButtonEnable (T_buttonID buttonID)
 
E_buttonAction ButtonGetAction (T_void)
 
T_buttonID ButtonGetByKey (T_word16 keycode)
 
T_buttonID ButtonGetByLoc (T_word16 x, T_word16 y)
 
T_word32 ButtonGetData (T_buttonID buttonID)
 
T_graphicID ButtonGetGraphic (T_buttonID buttonID)
 
T_voidButtonGetStateBlock (T_void)
 
T_word32 ButtonGetSubData (T_buttonID buttonID)
 
T_word16 ButtonIDToIndex (T_buttonID buttonID)
 
E_Boolean ButtonIsAt (T_buttonID buttonID, T_word16 lx, T_word16 ly)
 
E_Boolean ButtonIsEnabled (T_buttonID buttonID)
 
E_Boolean ButtonIsMouseOverButton (T_void)
 
E_Boolean ButtonIsPushed (T_buttonID buttonID)
 
E_Boolean ButtonIsValid (T_buttonID buttonID)
 
T_void ButtonKeyControl (E_keyboardEvent event, T_word16 scankey)
 
T_void ButtonMouseControl (E_mouseEvent event, T_word16 x, T_word16 y, T_buttonClick button)
 
T_void ButtonRedraw (T_buttonID buttonID)
 
T_void ButtonRedrawAllButtons (T_void)
 
T_void ButtonSetCallbacks (T_buttonID buttonID, T_buttonHandler cb1, T_buttonHandler cb2)
 
T_void ButtonSetData (T_buttonID buttonID, T_word32 newdata)
 
T_void ButtonSetFont (T_buttonID buttonID, T_byte8 *fntname)
 
T_void ButtonSetPicture (T_buttonID buttonID, T_byte8 *picname)
 
T_void ButtonSetSelectPic (T_buttonID buttonID, char *picname)
 
T_void ButtonSetStateBlock (T_void *p_state)
 
T_void ButtonSetSubData (T_buttonID buttonID, T_word32 newdata)
 
T_void ButtonSetText (T_buttonID buttonID, const T_byte8 *string, T_byte8 color)
 
T_void ButtonUp (T_buttonID buttonID)
 
T_void ButtonUpNoAction (T_buttonID buttonID)
 
T_void ButtonUpNum (T_word16 num)
 

Detailed Description

Button UI Component.

Buttons are a type of UI element in the Form system. As expected, events can be attached to buttons and handled by the Form handler. Buttons can be rendered with just a graphic or with text on it too. Hot keys can also be assigned.

See Also
http://www.amuletsandarmor.com/AALicense.txt

Macro Definition Documentation

#define BUTTON_TAG   12345

Function Documentation

T_void ButtonCleanUp ( T_void  )
T_buttonID ButtonCreate ( T_word16  lx,
T_word16  ly,
T_byte8 bmname,
E_Boolean  toggletype,
T_word16  keyassoc,
T_buttonHandler  p_cbroutine,
T_buttonHandler  p_cbroutine2 
)

Adds a button to the current list of buttons for a form

T_void ButtonDelete ( T_buttonID  buttonID)

Releases memory allocated to a button Cleanup releases memory allocated to all 'buttons'

T_void ButtonDisable ( T_buttonID  buttonID)
T_void ButtonDoCallback ( T_buttonID  buttonID)

Executes one of the callback routines pointed to in the button struct

T_void ButtonDoCallback2 ( T_buttonID  buttonID)
T_void ButtonDown ( T_buttonID  buttonID)

Sets the state (pushed and changed flags) of a button

T_void ButtonDownNoAction ( T_buttonID  buttonID)
T_void ButtonDownNum ( T_word16  num)
T_void ButtonDrawCallBack ( T_graphicID  graphicID,
T_word16  info 
)

A routine that will be called once the first time a button is drawn.. draws a 'shadow' behind the button, and then sets the graphic draw callback routine to null.

T_void ButtonDrawTextCallback ( T_graphicID  graphicID,
T_word16  info 
)
T_void ButtonEnable ( T_buttonID  buttonID)
E_buttonAction ButtonGetAction ( T_void  )
T_buttonID ButtonGetByKey ( T_word16  keycode)
T_buttonID ButtonGetByLoc ( T_word16  x,
T_word16  y 
)
T_word32 ButtonGetData ( T_buttonID  buttonID)
T_graphicID ButtonGetGraphic ( T_buttonID  buttonID)
T_void* ButtonGetStateBlock ( T_void  )
T_word32 ButtonGetSubData ( T_buttonID  buttonID)
T_word16 ButtonIDToIndex ( T_buttonID  buttonID)
E_Boolean ButtonIsAt ( T_buttonID  buttonID,
T_word16  lx,
T_word16  ly 
)
E_Boolean ButtonIsEnabled ( T_buttonID  buttonID)
E_Boolean ButtonIsMouseOverButton ( T_void  )
E_Boolean ButtonIsPushed ( T_buttonID  buttonID)

Returns specific information about the status of a given button

E_Boolean ButtonIsValid ( T_buttonID  buttonID)
T_void ButtonKeyControl ( E_keyboardEvent  event,
T_word16  scankey 
)

This routine acts as a generic keyboard and mouse handling routine for all active buttons

T_void ButtonMouseControl ( E_mouseEvent  event,
T_word16  x,
T_word16  y,
T_buttonClick  button 
)
T_void ButtonRedraw ( T_buttonID  buttonID)
T_void ButtonRedrawAllButtons ( T_void  )
T_void ButtonSetCallbacks ( T_buttonID  buttonID,
T_buttonHandler  cb1,
T_buttonHandler  cb2 
)
T_void ButtonSetData ( T_buttonID  buttonID,
T_word32  newdata 
)
T_void ButtonSetFont ( T_buttonID  buttonID,
T_byte8 fntname 
)
T_void ButtonSetPicture ( T_buttonID  buttonID,
T_byte8 picname 
)
T_void ButtonSetSelectPic ( T_buttonID  buttonID,
char *  picname 
)
T_void ButtonSetStateBlock ( T_void p_state)
T_void ButtonSetSubData ( T_buttonID  buttonID,
T_word32  newdata 
)
T_void ButtonSetText ( T_buttonID  buttonID,
const T_byte8 string,
T_byte8  color 
)
T_void ButtonUp ( T_buttonID  buttonID)
T_void ButtonUpNoAction ( T_buttonID  buttonID)
T_void ButtonUpNum ( T_word16  num)