Games/lbreakout2/client/menu.h

   1 /***************************************************************************
   2                           menu.h  -  description
   3                              -------------------
   4     begin                : Thu Sep 20 2001
   5     copyright            : (C) 2001 by Michael Speck
   6     email                : kulkanie@gmx.net
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef __MENU_H
  19 #define __MENU_H
  20
  21 /*
  22 ====================================================================
  23 Menu
  24 ====================================================================
  25 */
  26 enum { MENU_LAYOUT_CENTERED = 0 };
  27 typedef struct _Menu {
  28     char    *name;              /* name of menu -- duplicated */
  29     int     layout;
  30     int     x, y, w, h;         /* layout */
  31     List    *items;             /* list of menu items */
  32     Item    *cur_item;          /* currently highlighted item */
  33     struct _Menu   *parent;     /* parent menu */
  34     StkFont    *font, *hfont, *cfont; /* if not set the default fonts are used */
  35 } Menu;
  36
  37 /*
  38 ====================================================================
  39 Create menu and center it in x,y,w,h by menu_adjust() later.
  40 ====================================================================
  41 */
  42 Menu *menu_create( char *name, int layout, int x, int y, int w, int h, int border, int add_to_list );
  43 /*
  44 ====================================================================
  45 Delete menu and all submenus starting with root menu
  46 ====================================================================
  47 */
  48 void menu_delete( void *menu );
  49 /*
  50 ====================================================================
  51 Add item to menu. Add item::menu to children list if
  52 ITEM_LINK.
  53 ====================================================================
  54 */
  55 void menu_add( Menu *menu, Item *item );
  56 /*
  57 ====================================================================
  58 Adjust position and size of all entries according to layout.
  59 ====================================================================
  60 */
  61 void menu_adjust( Menu *menu );
  62 /*
  63 ====================================================================
  64 Select menu: clear current item and set extern variable cur_menu
  65 ====================================================================
  66 */
  67 void menu_select( Menu *menu );
  68 /*
  69 ====================================================================
  70 Show/hide all items
  71 ====================================================================
  72 */
  73 void menu_hide( Menu *menu );
  74 void menu_show( Menu *menu );
  75 /*
  76 ====================================================================
  77 modify items according to event (if any) and return action id.
  78 ====================================================================
  79 */
  80 int menu_handle_event( Menu *menu, SDL_Event *event );
  81 /*
  82 ====================================================================
  83 Update alpha of items
  84 ====================================================================
  85 */
  86 void menu_update( Menu *menu, int ms );
  87 /*
  88 ====================================================================
  89 Select/unselect item: update menu::cur_item und item::highlight
  90 ====================================================================
  91 */
  92 void menu_unselect_cur_item( Menu *menu );
  93 void menu_select_item( Menu *menu, Item *item );
  94 /*
  95 ====================================================================
  96 Go one valid menu item up or down.
  97 ====================================================================
  98 */
  99 void menu_up( Menu *menu );
 100 void menu_down( Menu *menu );
 101 /*
 102 ====================================================================
 103 Set fonts of menu and items.
 104 ====================================================================
 105 */
 106 void menu_set_fonts(
 107     Menu *menu, StkFont *cfont, StkFont *font, StkFont *hfont );
 108 /*
 109 ====================================================================
 110 Set background of menu and items.
 111 ====================================================================
 112 */
 113 void menu_set_bkgnd( Menu *menu, SDL_Surface *bkgnd );
 114
 115 #endif