EditMenuBar.h File Reference

Go to the source code of this file.

Data Structures
struct	_EDITOR_MENU_ITEM

Macros
#define	SCAN_CONTROL_E   5
#define	SCAN_CONTROL_F   6
#define	SCAN_CONTROL_G   7
#define	SCAN_CONTROL_K   11
#define	SCAN_CONTROL_O   15
#define	SCAN_CONTROL_Q   17
#define	SCAN_CONTROL_R   18
#define	SCAN_CONTROL_S   19
#define	SCAN_CONTROL_T   20
#define	SCAN_CONTROL_U   21
#define	SCAN_CONTROL_W   23
#define	SCAN_CONTROL_Z   26

Typedefs
typedef EFI_STATUS(*	MENU_ITEM_FUNCTION) (VOID)
typedef struct _EDITOR_MENU_ITEM	EDITOR_MENU_ITEM

Functions
EFI_STATUS	MenuBarInit (IN CONST EDITOR_MENU_ITEM *Items)
EFI_STATUS	ControlHotKeyInit (IN MENU_ITEM_FUNCTION *Items)
VOID	MenuBarCleanup (VOID)
EFI_STATUS	MenuBarRefresh (IN CONST UINTN LastRow, IN CONST UINTN LastCol)
EFI_STATUS	MenuBarDispatchFunctionKey (IN CONST EFI_INPUT_KEY *Key)
EFI_STATUS	MenuBarDispatchControlHotKey (IN CONST EFI_KEY_DATA *KeyData)

Detailed Description

Declares menubar interface functions.

Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EditMenuBar.h.

Macro Definition Documentation

SCAN_CONTROL_E

#define SCAN_CONTROL_E   5

Definition at line 12 of file EditMenuBar.h.

SCAN_CONTROL_F

#define SCAN_CONTROL_F   6

Definition at line 13 of file EditMenuBar.h.

SCAN_CONTROL_G

#define SCAN_CONTROL_G   7

Definition at line 14 of file EditMenuBar.h.

SCAN_CONTROL_K

#define SCAN_CONTROL_K   11

Definition at line 15 of file EditMenuBar.h.

SCAN_CONTROL_O

#define SCAN_CONTROL_O   15

Definition at line 16 of file EditMenuBar.h.

SCAN_CONTROL_Q

#define SCAN_CONTROL_Q   17

Definition at line 17 of file EditMenuBar.h.

SCAN_CONTROL_R

#define SCAN_CONTROL_R   18

Definition at line 18 of file EditMenuBar.h.

SCAN_CONTROL_S

#define SCAN_CONTROL_S   19

Definition at line 19 of file EditMenuBar.h.

SCAN_CONTROL_T

#define SCAN_CONTROL_T   20

Definition at line 20 of file EditMenuBar.h.

SCAN_CONTROL_U

#define SCAN_CONTROL_U   21

Definition at line 21 of file EditMenuBar.h.

SCAN_CONTROL_W

#define SCAN_CONTROL_W   23

Definition at line 22 of file EditMenuBar.h.

SCAN_CONTROL_Z

#define SCAN_CONTROL_Z   26

Definition at line 23 of file EditMenuBar.h.

Typedef Documentation

MENU_ITEM_FUNCTION

typedef EFI_STATUS(* MENU_ITEM_FUNCTION) (VOID)

Definition at line 26 of file EditMenuBar.h.

Function Documentation

ControlHotKeyInit()

EFI_STATUS ControlHotKeyInit

(

IN MENU_ITEM_FUNCTION *

Items

)

Initialize the control hot-key with the specified items.

Parameters

[in]

Items

The hot-key functions.

Return values

EFI_SUCCESS

The initialization was correct.

Definition at line 63 of file EditMenuBar.c.

MenuBarCleanup()

VOID MenuBarCleanup

(

VOID

)

Cleanup function for a menu bar. frees all allocated memory.

Definition at line 21 of file EditMenuBar.c.

MenuBarDispatchControlHotKey()

EFI_STATUS MenuBarDispatchControlHotKey

(

IN CONST EFI_KEY_DATA *

KeyData

)

Function to dispatch the correct function based on a control-based key (ctrl+o...)

Parameters

[in]

KeyData

The pressed key.

Return values

EFI_NOT_FOUND

The key was not a valid control-based key (an error was sent to the status bar).

Returns

EFI_SUCCESS.

Definition at line 175 of file EditMenuBar.c.

MenuBarDispatchFunctionKey()

EFI_STATUS MenuBarDispatchFunctionKey

(

IN CONST EFI_INPUT_KEY *

Key

)

Function to dispatch the correct function based on a function key (F1...)

Parameters

[in]

Key

The pressed key.

Return values

EFI_NOT_FOUND

The key was not a valid function key (an error was sent to the status bar).

Returns

The return value from the called dispatch function.

Definition at line 146 of file EditMenuBar.c.

MenuBarInit()

EFI_STATUS MenuBarInit

(

IN CONST EDITOR_MENU_ITEM *

Items

)

Initializa the menu bar with the specified items.

Parameters

[in]

Items

The items to display and their functions.

Return values

EFI_SUCCESS	The initialization was correct.
EFI_OUT_OF_RESOURCES	A memory allocation failed.

Initialize the menu bar with the specified items.

Parameters

[in]

Items

The items to display and their functions.

Return values

EFI_SUCCESS	The initialization was correct.
EFI_OUT_OF_RESOURCES	A memory allocation failed.

Definition at line 37 of file EditMenuBar.c.

MenuBarRefresh()

EFI_STATUS MenuBarRefresh	(	IN CONST UINTN	LastRow,
		IN CONST UINTN	LastCol
	)

Refresh function for the menu bar.

Parameters

[in]	LastRow	The last printable row.
[in]	LastCol	The last printable column.

Return values

EFI_SUCCESS

The refresh was successful.

Definition at line 80 of file EditMenuBar.c.