Scrollbar Menu-

This method pack contains various commands for making a menu with a scrollbar.
You can make multiple menus at once with different IDs, use custom graphics
for the background, scrollbar and cursor, change the keys used for input,
add and remove options from the menus and clear the menus from the screen
again afterwards, all with very little coding effort.



Methods in scrollmenu.prg

  #menu_back(background!, background$)
  #menu_back_rgb(r!, g!, b!)
  #menu_bar(graphics$, width!)
  #menu_bar_rgb(r!, g!, b!)
  #menu_cursor(graphics$, width!, height!, r!, g!, b!)
  #menu_cursor_rgb(r!, g!, b!)
  #menu_keys(up$, down$, select$, cancel$)
  #menu_create(x!, y!, width!, height!, id!)
  #menu_destroy(id!)
  #menu_add(option$, command$, id!)
  #menu_remove(id!)
  #menu_activate(id!)
  #menu_deactivate(id!)
  #menu_draw(id!)


#menu_back(background!, background$)

Sets a background image for the menu.
background!	0 if no background image is used. 1 if there is a background 		image.
background$	The filename of the background image (If you are not using a 		background image, just put "")


#menu_back_rgb(r!, g!, b!)

Sets a solid colour for the menu background.
r!, g!, b!	Red, green and blue values for the menu colour.

If neither of the background commands are used, the menu will have no
background.


#menu_bar(graphics$, width!)

Sets graphics for the scrollbar.
graphics$	The filename of the image to use for the scrollbar.
width!		The width of the scrollbar.


#menu_bar_rgb(r!, g!, b!)

Sets a solid colour for the scrollbar.
r!, g!, b!	Red, green and blue values for the scrollbar.

If neither of the bar commands are used, the scrollbar will be solid blue.


#menu_cursor(graphics$, width!, height!, r!, g!, b!)

Sets graphics for the cursor.
graphics$	The filename of the image to use for the cursor.
width!		The width of the cursor.
height!		The height of the cursor.
r!, g!, b!	Red, green and blue values for the transparent colour.


#menu_cursor_rgb(r!, g!, b!)

Sets a solid colour for the cursor (The cursor will be a circle).
r!, g!, b!	Red, green and blue values for the cursor.

If neither of the cursor commands are used, the cursor will be a yellow circle.


#menu_keys(up$, down$, select$, cancel$)

Sets the keys to use for selecting menu options.
up$		The key to move the cursor up.
down$		The key to move the cursor down.
select$		The key to select an option.
cancel$		The key to exit the current menu. Set it as "" if you want
		menu cancelling to be deactivated.

If this command is not used, the keys will default to these:
up	- "UP" (Up cursor key)
down	- "DOWN" (Down cursor key)
select	- "ENTER" (Return key)
cancel	- " " (Spacebar)


#menu_create(x!, y!, width!, height!, id!)

Creates a new menu.
x!, y!		Coordinates of the menu, in pixels.
width!		Width of the menu, in pixles.
height!		Height of the menu, in pixels.
id!		ID of the menu.


#menu_destroy(id!)

Destroys a menu, clearing its variables and removing it from the screen.
id!		ID of the menu to destroy.


#menu_add(option$, command$, id!)

Adds an option to the menu.
option$		The option to add to the menu.
command$	The command to run when the option is selected.
id!		ID of the menu to add the option to.


#menu_remove(id!)

Removes the last option from a menu.
id!		ID of the menu to remove an option from.


#menu_activate(id!)

Activates a menu, so the user can select an option.
id!		ID of the menu to activate.


#menu_deactivate(id!)

Deactivates a menu, so it remains on the screen but the cursor is not in
the menu.
id!		ID of the menu to deactivate.


#menu_draw(id!)

Redraws a menu.
id!		ID of the menu to redraw.




For the commands in the #menu_add method, it is best to use custom methods.
If you want the menu to close or become deactivated after an option has been
selected, you can put the #menu_destroy or #menu_deactivate commands inside
the custom methods.