FreeCalypso > hg > fc-magnetite

comparison src/ui3/bmi/mmiSoftKeys.h @ 421:6a4d9f47793e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/ui3/bmi: file renames to make the case consistent
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 21 Jan 2018 03:28:53 +0000
parents src/ui3/bmi/MmiSoftKeys.h@e8ddbb0837ed
children
comparison
equal deleted inserted replaced
420:e8ddbb0837ed 421:6a4d9f47793e
1 /*******************************************************************************
2
3 CONDAT (UK)
4
5 ********************************************************************************
6
7 This software product is the property of Condat (UK) Ltd and may not be
8 disclosed to any third party without the express permission of the owner.
9
10 ********************************************************************************
11
12 $Project name: Basic MMI
13 $Project code: BMI (6349)
14 $Module: Softkeys
15 $File: MmiSoftKeys.h
16 $Revision: 1.0
17
18 $Author: Condat(UK)
19 $Date: 25/10/00
20
21 ********************************************************************************
22
23 Description:
24
25
26 ********************************************************************************
27 $History: MmiSoftkeys.h
28
29 xrashmic 5 Oct, 2005 MMI-SPR-29356, MMI-SPR-29357
30 To display '?' to indicate to the user that help is available for a STK menu
31
32 25/10/00 Original Condat(UK) BMI version.
33
34
35 $End
36
37 *******************************************************************************/
38
39
40 #ifndef _DEF_MMI_SOFTKEYS_H_
41 #define _DEF_MMI_SOFTKEYS_H_
42
43 #define ALLOC_MEMORY mfwAlloc
44 #define FREE_MEMORY mfwFree
45
46
47 #include "MmiResources.h"
48
49
50 typedef enum
51 {
52 SOFTKEYS_FAILURE,
53 SOFTKEYS_CREATED,
54 SOFTKEYS_CHANGED
55 } SoftKeysResult;
56
57 typedef struct
58 {
59 LangTxt leftKeyLabel;
60 LangTxt rightKeyLabel;
61 MfwCb leftKeyCallBack;
62 MfwCb rightKeyCallBack;
63 } SoftKeysSetup;
64
65 #ifdef FF_MMI_FILEMANAGER
66 typedef enum
67 {
68 MENU_KEY_UP_DOWN_CENTER = 0,
69 MENU_KEY_UP_DOWN_PLAY ,
70 MENU_KEY_UP_DOWN_STOP,
71 MENU_KEY_ALL,
72 MENU_KEY_WAIT
73 }T_MENU_KEY;
74 #endif
75
76 //Softkey format definitions
77 #define SK_TALLBGD 0x0001 /* blank 2 lines of text over width of display */
78
79 #define SK_ROUNDBOX 0x0010 /* draw rounded rectangle round text*/
80 #define SK_FILLBOX 0x0020 /* draw filled rectangle round text*/
81
82 #define SK_DEFAULTCOL 0x0100 /* use default colour (i.e. do not change current colours) */
83
84 SoftKeysResult softKeysAttributes( U8 font, UBYTE displayAttibutes);
85 /*
86 * Change the <font> and <displayAttibutes> for _all_ softkeys.
87 * All consecutive calls of softKeysUpdate() will reflect the change.
88 * Returns SOFTKEYS_CHANGED when everything went fine,
89 * or SOFTKEYS_FAILURE on failure.
90 */
91
92
93 /*
94 * Please note that all functions below come in a softKeysHnd... and softKeysWin...
95 * version, which have identical functionality, but get the <window> passed
96 * in MfwHnd or MfwWin pointer form respectively.
97 * You can just use either one depending on what you got hold of at the moment.
98 */
99
100
101 SoftKeysResult softKeysHndCreate( MfwHnd window, SoftKeysSetup *setup);
102
103 SoftKeysResult softKeysWinCreate( MfwWin *window, SoftKeysSetup *setup);
104 /*
105 * Creates the softkeys for <window>, which will display the
106 * <leftKeyLabel> and <rightKeyLabel> in the softkey area
107 * on the screen, and invoke <leftKeyCallBack> or <rightKeyCallBack>
108 * when the approrpiate key is pressed. Returns SOFTKEYS_CREATED when
109 * everything went fine, or SOFTKEYS_FAILURE on failure.
110 */
111
112
113 SoftKeysResult softKeysHndSet( MfwHnd window, SoftKeysSetup *changes);
114
115 SoftKeysResult softKeysWinSet( MfwWin *window, SoftKeysSetup *changes);
116 /*
117 * Change the setup of the softkeys for <window>. Use TxtNull if you
118 * don't want to change a ...Label, and NULL if you don't want to change
119 * a ...CallBack. Returns SOFTKEYS_CHANGED when everything went fine,
120 * or SOFTKEYS_FAILURE on failure.
121 */
122
123
124 void softKeysHndUpdate(MfwHnd window);
125
126 void softKeysWinUpdate(MfwWin *window);
127 /*
128 * You will need to call this whenever <window> is updated.
129 */
130
131
132 void softkeysHndDelete(MfwHnd window);
133
134 void softkeysWinDelete(MfwWin *window);
135 /*
136 * Deletes the softkeys for <window>.
137 */
138
139
140 void softKeys_displayId(int leftSoftKey,int rightSoftKey, int format, unsigned int colIndex);
141 void softKeys_displayStr(char* leftSoftKey_str,char* rightSoftKey_str, int format, unsigned int colIndex);
142 void softKeys_displayStrXY(char* leftSoftKey_str,char* rightSoftKey_str, int format, unsigned int colIndex, MfwRect* rect );
143
144
145
146 void displaySoftKeys(int leftSoftKey, int rightSoftKey);
147
148 //Allow sk to be placed at locations other than the bottom of the screen
149 void displaySoftKeysXY(int leftSoftKey,int rightSoftKey,int lskX,int rskX, int lpos);
150
151 void displaySoftKeysBox(int leftSoftKey,int rightSoftKey, U32 fCol, U32 bCol, int format);
152
153 void displaySoftKeys_edition(int leftSoftKey,int index, int rightSoftKey);
154
155 // SH - 25/5/01
156 // This function provided for WAP, to allow the printing of custom softkeys
157 // from strings provided (otherwise same as displaySoftKeys).
158
159 void displayCustSoftKeys(char *LeftSoftKey, char *RightSoftKey);
160
161 void displayHelpSymbol(void); //xrashmic 5 Oct, 2005 MMI-SPR-29356, MMI-SPR-29357
162
163 void displayCameraIcon(void);
164
165 #endif
166