summaryrefslogtreecommitdiff
path: root/EDK/MiniSetup/TseLite/control.h
blob: b7111d05d84560ac3affebcad2a7086872971607 (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
//*****************************************************************//
//*****************************************************************//
//*****************************************************************//
//**                                                             **//
//**         (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/control.h $
//
// $Author: Arunsb $
//
// $Revision: 8 $
//
// $Date: 10/18/12 6:01a $
//
//*****************************************************************//
//*****************************************************************//
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Modules/AMITSE2_0/AMITSE/TseLite/control.h $
// 
// 8     10/18/12 6:01a Arunsb
// Updated for 2.16.1235 QA submission
// 
// 9     10/10/12 12:38p Arunsb
// Synched the source for v2.16.1232, backup with Aptio
// 
// 7     6/17/10 2:59p Madhans
// Dynamic parsing support in TSE.
// 
// 6     4/16/10 5:13p Madhans
// Changes for Tse 2.02. Please see Changelog.log for more details.
// 
// 5     2/26/10 8:54p Madhans
// For TSE 2.01.1024. refer changelog.log for file checkin history .
// 
// 5     2/26/10 1:30p Madhans
// To avoid build issues with EDK.
// 
// 4     2/19/10 8:18a Mallikarjunanv
// updated year in copyright message
// 
// 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:04p Madhans
// Tse 2.0 Code complete Checkin.
// 
// 4     4/28/09 9:40p Madhans
// Tse 2.0 Code complete Checkin.
// 
// 3     2/05/09 10:15a Madhans
// Style Module created.
// 
// 2     1/30/09 6:06p Madhans
// Function headers added. 
// 
// 1     12/18/08 7:58p Madhans
// Intial version of TSE Lite sources
//*****************************************************************//
//*****************************************************************//

#ifndef _CONTROL_H_
#define	_CONTROL_H_

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

#include "object.h"
#include "setupdata.h"
#include "action.h"
#if UEFI_SOURCES_SUPPORT
#include "ctrlcond.h"
#endif

#define CONTROL_GRAYOUT_COLOR STYLE_COLOR_GRAYOUT

#define	CONTROL_MEMBER_VARIABLES		\
	CONTROL_INFO	ControlData;		\
	UINT16			Left;				\
	UINT16			Top;				\
	UINT16			Width;				\
	UINT16			Height;				\
	UINT8			FGColor;			\
    UINT8			BGColor;			\
	BOOLEAN			ControlFocus;		\
	BOOLEAN			ControlActive;		\
	UINT32			ParentFrameType;

typedef struct _CONTROL_METHODS	CONTROL_METHODS;

typedef struct _CONTROL_DATA
{
	CONTROL_METHODS	*Methods;

	OBJECT_MEMBER_VARIABLES
	CONTROL_MEMBER_VARIABLES

}
CONTROL_DATA;

typedef	EFI_STATUS	(*CONTROL_METHOD_SET_FOCUS)		( VOID *object, BOOLEAN focus );
typedef	EFI_STATUS	(*CONTROL_METHOD_SET_POSITION)	( VOID *object, UINT16 Left, UINT16 Top );
typedef	EFI_STATUS	(*CONTROL_METHOD_SET_DIMENSIONS)	( VOID *object, UINT16 Width, UINT16 Height );
typedef	EFI_STATUS	(*CONTROL_METHOD_SET_ATTRIBUTES)( VOID *object, UINT8 FGColor, UINT8 BGColor );
typedef	EFI_STATUS	(*CONTROL_METHOD_GET_CONTROL_HIGHT)( VOID *object, VOID *frame, UINT16 *height  );

#define	CONTROL_METHOD_FUNCTIONS					\
	CONTROL_METHOD_SET_FOCUS		SetFocus;		\
	CONTROL_METHOD_SET_POSITION		SetPosition;	\
	CONTROL_METHOD_SET_DIMENSIONS    SetDimensions;	\
	CONTROL_METHOD_SET_ATTRIBUTES	SetAttributes; \
	CONTROL_METHOD_GET_CONTROL_HIGHT GetControlHeight;

struct _CONTROL_METHODS
{
	OBJECT_METHOD_FUNCTIONS
	CONTROL_METHOD_FUNCTIONS
};

extern CONTROL_METHODS gControl;

// Object Methods
EFI_STATUS ControlCreate( VOID **object );
EFI_STATUS ControlDestroy( VOID *object, BOOLEAN freeMem );
EFI_STATUS ControlInitialize( VOID *object, VOID *data );
EFI_STATUS ControlEmptyMethod( VOID *object );
EFI_STATUS ControlDraw( VOID *object );
EFI_STATUS ControlHandleAction( VOID *object, ACTION_DATA *Data );
EFI_STATUS ControlSetCallback( VOID *object, VOID *container, OBJECT_CALLBACK callback, VOID *cookie );

// Control Methods
EFI_STATUS ControlSetFocus(VOID *object, BOOLEAN focus);
EFI_STATUS ControlSetPosition(VOID *object, UINT16 Left, UINT16 Top);
EFI_STATUS ControlSetDimensions(VOID *object, UINT16 Width, UINT16 Height);
EFI_STATUS ControlSetAttributes(VOID *object, UINT8 FGColor, UINT8 BGColor);
CONTROL_DATA * GetUpdatedControlData(CONTROL_DATA * ControlData,UINT16 ControlType,VOID *Handle,UINT16 Key);


#endif /* _CONTROL_H_ */


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