summaryrefslogtreecommitdiff
path: root/EDK/MiniSetup/TseLite/MessageBox.h
blob: 7e5781a3c2a12fa0f70ae7c64d80a7b826479774 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
//*****************************************************************//
//*****************************************************************//
//*****************************************************************//
//**                                                             **//
//**         (C)Copyright 2010, American Megatrends, Inc.        **//
//**                                                             **//
//**                     All Rights Reserved.                    **//
//**                                                             **//
//**   5555 Oakbrook Pkwy, Building 200,Norcross, Georgia 30093  **//
//**                                                             **//
//**                     Phone (770)-246-8600                    **//
//**                                                             **//
//*****************************************************************//
//*****************************************************************//
//*****************************************************************//
// $Archive: /Alaska/SOURCE/Modules/AMITSE2_0/AMITSE/TseLite/MessageBox.h $
//
// $Author: Premkumara $
//
// $Revision: 10 $
//
// $Date: 8/28/14 6:05a $
//
//*****************************************************************//
//*****************************************************************//
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/AMITSE2_0/AMITSE/TseLite/MessageBox.h $
// 
// 10    8/28/14 6:05a Premkumara
// EIP-135253 Updating file name proper in #include
// 
// 9     10/18/12 6:02a Arunsb
// Updated for 2.16.1235 QA submission
// 
// 11    10/10/12 12:38p Arunsb
// Synched the source for v2.16.1232, backup with Aptio
// 
// 8     12/01/11 5:42a Rajashakerg
// [TAG]  		EIP74963 
// [Category]  	Improvement
// [Description]  	MAX_MSGBOX_WIDTH cannot be overridden
// [Files]  		AMITSE.sdl, CommonHelper.c, minisetup.h, legacy.c,
// MessageBox.c, MessageBox.h, FormBrowser.c
// 
// 7     4/21/10 12:01p Madhans
// Tse 2.02
// 
// 9     4/20/10 6:22p Blaines
// Define MSGBOX_MAX_OPTIONS
// 
// 8     3/26/10 6:53p Madhans
// Support to Map the do the Control Mapping from gTseControlMap Table. So
// no changes need in Frame.c, With this feature gTseControlMap Can be
// customized to add/customize the TSE controls.
// 
// 7     3/23/10 5:20p Blaines
// Extend Message Box support
//     Adds Custom Type
//     Adds Progress Bar Type
// 
// 6     2/26/10 1:30p Madhans
// To avoid build issues with EDK.
// 
// 5     2/19/10 8:18a Mallikarjunanv
// updated year in copyright message
// 
// 4     2/04/10 11:17p Madhans
// Mouse support related code optimized
// 
// 3     8/17/09 12:27p Presannar
// Removed References to Tiano.h and replaced it with Efi.h
// 
// 2     6/12/09 7:44p Presannar
// Initial implementation of coding standards for AMITSE2.0
// 
// 1     6/04/09 8:05p Madhans
// 
// 1     4/28/09 11:05p Madhans
// Tse 2.0 Code complete Checkin.
// 
// 2     1/30/09 6:06p Madhans
// Function headers added. 
// 
// 1     12/18/08 7:58p Madhans
// Intial version of TSE Lite sources
//*****************************************************************//
//*****************************************************************//

#ifndef _MSGBOX_H_
#define	_MSGBOX_H_

#if TSE_USE_EDK_LIBRARY
#include "Tiano.h" 
#else
#include "Efi.h" 
#endif

#include "popup.h"
#include "Memo.h"  

//EIP74963 : MAX_MSGBOX_WIDTH macro changed as token and handled from binary
//#define MAX_MSGBOX_WIDTH		45
// messagebox constants
#define MSGBOX_TYPE_NULL        0
#define MSGBOX_TYPE_OK			1
#define MSGBOX_TYPE_OKCANCEL	2
#define MSGBOX_TYPE_YESNO		3
#define MSGBOX_TYPE_CUSTOM		4
#define MSGBOX_TYPE_PROGRESS		5  	// internal use only (NOT PUBLISHED)
#define	MSGBOX_TYPE_MASK		0x0F
#define MSGBOX_TYPE_MAXTYPE     MSGBOX_TYPE_MASK
#define	MSGBOX_STYLE_CENTER		(UINT8)(JUSTIFY_CENTER << 4)
#define	MSGBOX_STYLE_RIGHT		(UINT8)(JUSTIFY_RIGHT << 4)
#define	MSGBOX_STYLE_LEFT		(UINT8)(JUSTIFY_LEFT << 4)
#define	MSGBOX_STYLE_MASK		0xF0
#define MSGBOX_OK				0
#define MSGBOX_CANCEL			1
#define MSGBOX_YES				0	
#define MSGBOX_NO				1

#define MSGBOX_MAX_OPTIONS		4
typedef struct _IFR_MSGBOX
{ // this structure is, in some way, following EFI_IFR structures
	UINT8	Opcode, Length;
	UINT16	Title;
	/*EFI_HII_HANDLE*/VOID * 	TextHandle;
	UINT16	Text;
}AMI_IFR_MSGBOX;

#define	MSGBOX_MEMBER_VARIABLES	\
    VOID	*ScreenBuf;			\
	MEMO_DATA *Memo;			\
	UINT8	MsgBoxType;			\
	UINT8	MsgboxSel;			\
	UINT8	Button1Len;			\
	UINT8	Button2Len;			\
	CHAR16	*Legend;			\
	MSGBOX_EX_CATAGORY MsgBoxCatagory;	\
	UINT16  *PtrTokens;			\
	UINT16  OptionCount;			\
	AMI_POST_MGR_KEY  *HotKeyList;		\
	UINT16 	HotKeyListCount; 		\
	AMI_POST_MGR_KEY  *OutKey;		\
	UINTN 	Percent;				// 0 - 100


typedef struct _MSGBOX_METHODS	MSGBOX_METHODS;

typedef struct _MSGBOX_DATA
{
	MSGBOX_METHODS	*Methods;

	OBJECT_MEMBER_VARIABLES
	CONTROL_MEMBER_VARIABLES
	POPUP_MEMBER_VARIABLES
	MSGBOX_MEMBER_VARIABLES
}
MSGBOX_DATA;

typedef	EFI_STATUS	(*MSGBOX_METHOD_SET_TYPE)		( VOID *object, UINT8 Type );

#define	MSGBOX_METHOD_FUNCTIONS \
      MSGBOX_METHOD_SET_TYPE SetType;

struct _MSGBOX_METHODS
{
	OBJECT_METHOD_FUNCTIONS
	CONTROL_METHOD_FUNCTIONS
    MSGBOX_METHOD_FUNCTIONS
};

extern MSGBOX_METHODS gMsgBox;


// Object Methods
EFI_STATUS MsgBoxCreate( VOID **object );
EFI_STATUS MsgBoxDestroy( VOID *object, BOOLEAN freeMem );
EFI_STATUS MsgBoxInitialize( VOID *object, VOID *data );
EFI_STATUS MsgBoxDraw( VOID *object );
EFI_STATUS MsgBoxHandleAction(VOID *object, ACTION_DATA *Data);
EFI_STATUS MsgBoxSetCallback(  VOID *object, VOID *container, OBJECT_CALLBACK callback, VOID *cookie );
EFI_STATUS MsgBoxSetType(VOID *object, UINT8 Type );

// Control Methods
EFI_STATUS MsgBoxSetFocus(VOID *object, BOOLEAN focus);
EFI_STATUS MsgBoxSetPosition(VOID *object, UINT16 Left, UINT16 Top);
EFI_STATUS MsgBoxSetDimensions(VOID *object, UINT16 Width, UINT16 Height);
EFI_STATUS MsgBoxSetAttributes(VOID *object, UINT8 FGColor, UINT8 BGColor);
EFI_STATUS MsgBoxGetControlHight( VOID *object,VOID *frame, UINT16 *height );

#endif /* _MSGBOX_H_ */


//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2010, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**     5555 Oakbrook Pkwy, Building 200,Norcross, Georgia 30093     **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************