FreeCalypso > hg > fc-magnetite

comparison src/ui3/bmi/mmiUserData.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/MmiUserData.h@e8ddbb0837ed
children
comparison
equal deleted inserted replaced
420:e8ddbb0837ed 421:6a4d9f47793e
1 #ifndef _DEF_MMI_USERDATA_H_
2 #define _DEF_MMI_USERDATA_H_
3
4 /*******************************************************************************
5
6 CONDAT (UK)
7
8 ********************************************************************************
9
10 This software product is the property of Condat (UK) Ltd and may not be
11 disclosed to any third party without the express permission of the owner.
12
13 ********************************************************************************
14
15 $Project name: Basic MMI
16 $Project code: BMI (6349)
17 $Module: MMI
18 $File: MmiUserData.h
19 $Revision: 1.0
20
21 $Author: Condat(UK)
22 $Date: 25/10/00
23
24 ********************************************************************************
25
26 Description:
27
28 This provides the root mofule for the basic MMI
29
30 ********************************************************************************
31 $History: MmiUserData.h
32
33
34
35 $End
36
37 *******************************************************************************/
38
39
40
41
42 #define ALLOC_MEMORY mfwAlloc
43 #define FREE_MEMORY mfwFree
44
45
46
47 /*
48 * The following enum is the _only_ place where keys for the userData mechanism
49 * can be defined. Everybody _can_ and _must_ define their own keys for
50 * _every_ particular use of userData.
51 */
52 typedef enum
53 {
54 UD_SOFTKEYS,
55 UD_OLD_FOCUS,
56 UD_SAT_BITS,
57 UD_SAT_HANDLE,
58 UD_SAT_KEYBOARD,
59 UD_SAT_MENU,
60 UD_SAT_MENU_ATTRIBUTES,
61 UD_SAT_MENU_IDS,
62 UD_SAT_MENU_STRINGPOOL,
63 UD_SAT_SETUPMENU_COMMAND,
64 UD_KBD,
65 UD_PARENTWIN,
66 UD_MENU
67 } UserKey;
68
69
70 /*
71 * Please note that all functions below come in a userDataHnd... and userDataWin...
72 * version, which have identical functionality, but get the <window> passed
73 * in MfwHnd or MfwWin pointer form respectively.
74 * You can just use either one depending on what you got hold of at the moment.
75 */
76
77
78 void *userDataHndSet( MfwHnd window, UserKey key, void *data);
79
80 void *userDataWinSet( MfwWin *window, UserKey key, void *data);
81 /*
82 * Sets the user data for <window> with <key> to <data>,
83 * and returns the previous contents of the user data.
84 * If <data> itself is returned no user data with <key>
85 * existed and a new user data element with <key> has been created
86 * and set to <data>.
87 * If NULL is returned, either <window> was invalid or a new user data
88 * element could not be created.
89 */
90
91
92 void *userDataHndGet( MfwHnd window, UserKey key);
93
94 void *userDataWinGet( MfwWin *window, UserKey key);
95 /*
96 * Returns the user data for <window> with <key>.
97 * If NULL is returned, either <window> was invalid or no user data
98 * with <key> existed.
99 */
100
101
102 void *userDataHndDelete( MfwHnd window, UserKey key);
103
104 void *userDataWinDelete( MfwWin *window, UserKey key);
105 /*
106 * Deletes the user data for <window> with <key>, and returns the
107 * contents of the user data.
108 * If NULL is returned, either <window> was invalid or no user data
109 * with <key> existed.
110 */
111
112
113 #endif
114