oc_gui.h

Go to the documentation of this file.

#ifndef INC_GUI_OC_GUI_H_
#define INC_GUI_OC_GUI_H_

#include <oc_errors.h>
#include <oc_terminal.h>
#include <stdint.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

typedef void *  oC_Gui_Menu_t;
typedef uint8_t oC_Gui_MenuItemIndex_t;

typedef struct
{
    const char *        Name;
    const char *        DetailedDescription;
} oC_Gui_MenuItem_t;

typedef enum
{
    oC_Gui_MenuStyleType_Terminal ,
    oC_Gui_MenuStyleType_Hd44780
} oC_Gui_MenuStyleType_t;

typedef struct
{
    oC_Gui_MenuStyleType_t  StyleType;

    union
    {
        struct
        {
            oC_Terminal_Color_t     BorderColor;
            oC_Terminal_Color_t     BackgroundColor;

            struct
            {
                oC_Terminal_Color_t     ForegroundColor;
                oC_Terminal_Color_t     BackgroundColor;
            } ActiveElement;

            struct
            {
                oC_Terminal_Color_t     ForegroundColor;
                oC_Terminal_Color_t     BackgroundColor;
            } NonActiveElement;

            struct
            {
                oC_Terminal_Color_t     ForegroundColor;
                oC_Terminal_Color_t     BackgroundColor;
            } TitleElement;
        } TerminalStyle;
    };

} oC_Gui_MenuStyle_t;

typedef enum
{
    oC_Gui_MessageBoxType_Info ,
    oC_Gui_MessageBoxType_Warning ,
    oC_Gui_MessageBoxType_Error
} oC_Gui_MessageBoxType_t;

typedef enum
{
    oC_Gui_Button_Ok        = (1<<0) ,
    oC_Gui_Button_Cancel    = (1<<1) ,
    oC_Gui_Button_Next      = (1<<2) ,
    oC_Gui_Button_Previous  = (1<<3) ,
    oC_Gui_Button_Escape    = (1<<4) ,
    oC_Gui_Button_Details   = (1<<5) ,
    oC_Gui_Button_Restart   = (1<<6) ,
    oC_Gui_Button_Retry     = (1<<7) ,
    oC_Gui_Button_Skip      = (1<<8) ,
    oC_Gui_Button_Print     = (1<<9) ,
    oC_Gui_Button_TurnOn    = (1<<10) ,
    oC_Gui_Button_TurnOff   = (1<<11) ,
    oC_Gui_Button_Install   = (1<<12)
} oC_Gui_Button_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

extern oC_Gui_Menu_t            oC_Gui_Menu_New             ( const oC_Gui_MenuItem_t * MenuItems , uint32_t Count , const oC_Gui_MenuStyle_t * MenuStyle );
extern oC_ErrorCode_t           oC_Gui_Menu_Delete          ( oC_Gui_Menu_t * Menu );
extern oC_ErrorCode_t           oC_Gui_Menu_Show            ( oC_Gui_Menu_t Menu , uint32_t * outSelectedItemIndex );

extern oC_ErrorCode_t           oC_Gui_ShowMessageBox       ( const char * Title , const char * Message , oC_Gui_MessageBoxType_t Type , oC_Gui_Button_t Buttons );

#undef  _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

#endif /* INC_GUI_OC_GUI_H_ */