menu.h

Go to the documentation of this file.

 
 
/*
 * menu.h
 *
 *  Created on: May 12, 2022
 *      Author: micahbly
 */
 
#ifndef MENU_H_
#define MENU_H_
 
 
/* about this class
 *
 * code to manage all aspects of menus
 *
 * Will be used for:
 *
 *
 *** things a list needs to be able to do
 * create/build menus at app startup
 * determine which menu item has been selected by the user
 * execute or route actions for each menu item
 * 
 *
*/
 
 
/*****************************************************************************/
/*                                Includes                                   */
/*****************************************************************************/
 
#include "a2560k.h"
#include "event.h"
 
 
 
/*****************************************************************************/
/*                            Macro Definitions                              */
/*****************************************************************************/
 
#define MENU_MAX_ITEMS              30  
#define MENU_MAX_WIDTH              300 
#define MENU_MAX_HEIGHT             350 
#define MENU_MARGIN                 5   
#define MENU_TEXT_PADDING           2   
#define MENU_SHORTCUT_SPACE         40  
 
#define MENU_ID_NO_PARENT           -1  
#define MENU_ID_DIVIDER             -2  
#define MENU_ID_NO_SELECTION        -3  
#define MENU_NOTHING_HIGHLIGHTED    -1  
 
#define MENU_PARAM_SHOW_HIGHLIGHTED true    
#define MENU_PARAM_SHOW_NORMAL      false   
 
/*****************************************************************************/
/*                               Enumerations                                */
/*****************************************************************************/
 
typedef enum menu_item_type
{
    menuItem                = 0,
    menuSubmenu             = 1,
    menuDivider             = 2,
} menu_item_type;
 
// typedef enum menu_level
// {
//  menu_no_menu            = -1,
//  menu_level_0            = 0,
//  menu_level_1            = 1,
//  menu_level_2            = 2,
//  menu_level_3            = 3,
// } menu_level;
 
// typedef enum menu_modifiers
// {
//  foenixKeyBit            = 1,    // foenix key down?
//  shiftKeyBit             = 2,    // shift key down?
//  optionKeyBit            = 3,    // option key down?
//  controlKeyBit           = 4,    // control key down?
// } menu_modifiers;
// 
// typedef enum menu_modifier_flags
// {
//  foenixKey               = 1 << foenixKeyBit,
//  shiftKey                = 1 << shiftKeyBit,
//  optionKey               = 1 << optionKeyBit,
//  controlKey              = 1 << controlKeyBit,
// } menu_modifier_flags;
 
/*****************************************************************************/
/*                                 Structs                                   */
/*****************************************************************************/
 
 
struct MenuItem
{
    int16_t                 id_;
    char*                   text_;                  
    event_modifier_flags    modifiers_;             
    unsigned char           shortcut_;              
    menu_item_type          type_;                  
    Rectangle               selection_rect_;        
};
 
struct MenuGroup
{
    int16_t                 id_;
    char*                   title_;                 
    struct MenuItem*        item_[MENU_MAX_ITEMS];
    int16_t                 num_menu_items_;        
    bool                    is_submenu_;            // if this menu group is a submenu, it will get a < back item at the top of the menu.
    int16_t                 parent_id_;             
};
 
struct Menu
{
    Bitmap*                 bitmap_;                        // bitmap in standard memory, to hold the rendered menu. Will be blitted to the screen.
    int16_t                 pen_x_;                         // Local H position relative to the overall_rect_, of the "pen", for drawing functions
    int16_t                 pen_y_;                         // Local V position relative to the overall_rect_, of the "pen", for drawing functions
    uint8_t                 pen_color_;                     // Color index of the "pen", for drawing functions
    Font*                   pen_font_;                      // Font to be used by the "pen", for drawing functions
    Rectangle               overall_rect_;                  // the local rect describing the total area of the menu
    Rectangle               global_rect_;                   // the global rect describing the total area of the menu
    int16_t                 x_;                             // current global horizontal coordinate
    int16_t                 y_;                             // current global vertical coordinate
    int16_t                 width_;                         // current width of menu
    int16_t                 height_;                        // current height of menu
    int16_t                 inner_width_;                   // space available inside the menu, accounting for margin thicknesses
    int16_t                 inner_height_;                  // space available inside the menu, accounting for margin thicknesses
    Rectangle               clip_rect_[2];                  // one or more clipping rects; determines which parts of menu need to be re-blitted to the screen
    int16_t                 clip_count_;                    // number of clip rects the menu is currently tracking
    MenuGroup*              menu_group_;                    // pointer to the menu group currently being displayed
    bool                    invalidated_;                   // if true, the menu needs to be completely re-rendered on the next render pass
    bool                    visible_;                       // is the menu active/visible, or not?
    int16_t                 current_selection_;             // index to menu_group_->item_[]. Updated during mouse move. Indicates which one of the rows is currently highlighted, if any. -1 if none.
};
 
 
/*****************************************************************************/
/*                       Public Function Prototypes                          */
/*****************************************************************************/
 
// constructor
Menu* Menu_New(void);
 
// destructor
void Menu_Destroy(Menu** the_menu);
 
 
void Menu_Render(Menu* the_menu);
 
void Menu_Open(Menu* the_menu, MenuGroup* the_menu_group, int16_t x, int16_t y);
 
void Menu_CancelOpen(Menu* the_menu);
 
void Menu_Hide(Menu* the_menu);
 
void Menu_SetVisible(Menu* the_menu, bool is_visible);
 
 
int16_t Menu_AcceptClick(Menu* the_menu, int16_t x, int16_t y);
 
void Menu_AcceptMouseMove(Menu* the_menu, int16_t x, int16_t y);
 
bool Menu_SetFont(Menu* the_menu, Font* the_font);
 
 
#endif /* MENU_H_ */