summaryrefslogtreecommitdiffstats
path: root/private/utils/rdisk/help.c
blob: 67ec72dd4389c368df47d53b8424474696b6ddb8 (plain) (blame)
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
/*++

Module Name:

    help.c

Abstract:


Author:

    Jaime Sasson - 10-Aug-1993

Environment:

    ULIB, Windows

--*/

#include "precomp.h"
#pragma hdrstop


//
//  Global variables used in the module
//

HHOOK   _hHook;
INT     _HelpContext;
WCHAR   _HelpFile[ MAX_PATH + 1 ];



LRESULT
HelpHookProc(
    IN INT      nCode,
    IN WPARAM   wParam,
    IN LPARAM   lParam
    )

/*++

Routine Description:

    Hook proc to detect F1 key presses.

Arguments:

    Standard arguments of a hook procedure.

Return Value:

--*/

{
    PMSG pmsg = (PMSG)lParam;

    if(nCode < 0) {
        return( CallNextHookEx( _hHook, nCode, wParam, lParam ) );
    }

    if(((nCode == MSGF_DIALOGBOX) || (nCode == MSGF_MENU))
     && (pmsg->message == WM_KEYDOWN)
     && (LOWORD(pmsg->wParam) == VK_F1))
    {
        PostMessage( _hWndMain, AP_HELP_KEY, nCode, 0);
        return(TRUE);
    }
    return(FALSE);
}


BOOLEAN
InitializeHelp(
    IN PCWSTR    HelpFile
    )

/*++

Routine Description:

    Initialize the help module by initializing its global data.

Arguments:

    HelpFile - Name of the help file to be invoked.


Return Value:

    BOOLEAN - Returns TRUE if the initialization succeeded.
              returns FALSE otherwise.

--*/

{

    wcscpy( _HelpFile, HelpFile );

    _hHook = SetWindowsHookEx( WH_MSGFILTER,
                               HelpHookProc,
                               NULL,
                               GetCurrentThreadId() );

    if( _hHook == NULL ) {
        return( FALSE );
    }
    return( TRUE );
}


VOID
CleanUpHelp(
    )

/*++

Routine Description:

    Clean up the HELP object, by unhooking HelpHookProc.
Arguments:

    None.

Return Value:

    None.

--*/

{
    UnhookWindowsHookEx( _hHook );
}




VOID
DisplayHelp(
    )

/*++

Routine Description:

    Display context-sensitive help.

Arguments:

    None.

Return Value:

    BOOLEAN - Returns TRUE if the operation succeeds. Otherwise, return FALSE.

--*/

{
    if( _HelpContext != IDH_NONE ) {
        WinHelp( _hWndMain,
                 _HelpFile,
                 (UINT)HELP_CONTEXT,
                 _HelpContext );
        DrawMenuBar( _hWndMain );
    }


}



VOID
DisplayHelpIndex(
    )

/*++

Routine Description:

    Invoke winhelp to display the help file index.

Arguments:

    None.

Return Value:

    None.

--*/

{
    WinHelp( _hWndMain, _HelpFile, (UINT)HELP_INDEX, 0 );
}


VOID
DisplayHelpOnHelp(
    )

/*++

Routine Description:

    Invoke winhelp to display help on help.

Arguments:

    None.

Return Value:

    None.

--*/

{
    WinHelp( _hWndMain, _HelpFile, (UINT)HELP_HELPONHELP, 0 );
}



VOID
DisplayHelpSearch(
    )

/*++

Routine Description:

    Invoke winhelp so that it prompt the user to enter a key.

Arguments:

    None.

Return Value:

    None.

--*/

{
    WinHelp( _hWndMain, _HelpFile, (UINT)HELP_PARTIALKEY, (DWORD)"" );
}


VOID
QuitHelp(
    )

/*++

Routine Description:

    Inform winhelp that help is no more needed.

Arguments:

    None.

Return Value:

    None.

--*/

{
    WinHelp( _hWndMain, _HelpFile, (UINT)HELP_QUIT, 0 );
}


INT
GetHelpContext(
    )

/*++

Routine Description:

    Return the current help context.

Arguments:

    None.

Return Value:

    INT - Ireturns the current help id.

--*/

{
    return( _HelpContext );
}



VOID
SetHelpContext(
    IN  INT HelpId
    )

/*++

Routine Description:

    Set the current help context.

Arguments:

    HelpContext - Help context id.

Return Value:

    None.

--*/

{
    _HelpContext = HelpId;
}



VOID
SetMenuItemHelpContext(
    IN WPARAM wParam,
    IN LPARAM lParam
    )

/*++

Routine Description:

    Routine to set help context based on which menu item is currently
    selected.

Arguments:

    wParam,lParam - params to window proc in WM_MENUSELECT case

Return Value:

    None.

--*/

{
    if(HIWORD(lParam) == 0) {                   // menu closed
        SetHelpContext( IDH_SAVE_REPAIR_INFO );

    } else if (HIWORD(wParam) & MF_POPUP) {     // popup selected
        SetHelpContext( IDH_NONE );

    } else if (HIWORD(wParam) & MF_SYSMENU) {   // system menu
        SetHelpContext( IDH_SYSTEM_MENU );

    } else {                                    // regular old menu item
        SetHelpContext( IDH_NONE );

    }
}