UserInterfaceMenu.h

Go to the documentation of this file.

/*
    Copyright (C) 2007 Bernd Wisotzki

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
*/

#ifndef USERINTERFACEMENU_H_
#define USERINTERFACEMENU_H_

#ifdef __cplusplus
extern "C" {
#endif

/* -- Defines --------------------------------------------------------------- */

typedef enum {
    MENU_RES_NORMAL   = 0, 
    MENU_RES_PROG     = 1, 
    MENU_RES_SHUTDOWN = 2, 
    MENU_RES_BACK     = 3  
} menuResult_t;

typedef enum {
    MENU_STARTUP_NORMAL          = 0, 
    MENU_STARTUP_PROG            = 1  
} menuStartup_t;

typedef enum {
    MENUE_NORMAL_CLOCK_OPERATION = 0, 
    MENUE_NORMAL_QUICK_OPERATION = 1, 
    MENUE_NORMAL_TIME_FACTOR     = 2, 
    MENUE_NORMAL_START_TIME      = 3, 
    MENUE_NORMAL_CURRENT_TIME    = 4, 
    MENUE_NORMAL_TARGET_TIME     = 5, 
    MENUE_NORMAL_PROG            = 6, 
    MENUE_NORMAL_SHUTDOWN        = 7  
} menuNormal_t;

typedef enum {
    MENUE_PROGRAM_PULSE_WIDTH    = 0, 
    MENUE_PROGRAM_SET0           = 1, 
    MENUE_PROGRAM_NORMAL         = 2, 
    MENUE_PROGRAM_SHUTDOWN       = 3  
} menuProg_t;

typedef enum {
    MENU_SHUTDOWN_BACK           = 0, 
    MENU_SHUTDOWN_SHUTDOWN       = 1  
} menuShutdown_t;

typedef enum {
    MENU_FASTFWD_START           = 0, 
    MENU_FASTFWD_NULL            = 1, 
    MENU_FASTFWD_BACK            = 2  
} menuFastFwd_t;

typedef enum {
    MENU_NORMAL_START            = 0, 
    MENU_NORMAL_BACK             = 1, 
    MENU_NORMAL_STOP             = 2  
} menuNormalClock_t;

typedef enum {
    MENU_SET_MINUTE              = 0, 
    MENU_SET_HOUR                = 1, 
    MENU_SET_BACK                = 2  
} menuSetTime_t;

typedef enum {
    MENU_SET0_BACK               = 0, 
    MENU_SET0_SET0               = 1  
} menuSet0_t;

/* -- FunctionPrototypes ---------------------------------------------------- */

// for comment see UserInterfaceMenu.c
void UserInterfaceBasicInit(void);

// for comment see UserInterfaceMenu.c
void UserInterfaceMenuWelcome(void);

// for comment see UserInterfaceMenu.c
menuResult_t UserInterfaceMenuStartup(void);

// for comment see UserInterfaceMenu.c
menuResult_t UserInterfaceMenuNormal(void);

// for comment see UserInterfaceMenu.c
menuResult_t UserInterfaceMenuProg(void);

// for comment see UserInterfaceMenu.c
menuResult_t UserInterfaceMenuShutdown(void);

// for comment see UserInterfaceMenu.c
void UserInterfaceMenuEndOfSoap(void);

#ifdef __cplusplus
}
#endif

#endif /* USERINTERFACEMENU_H_ */