-
Notifications
You must be signed in to change notification settings - Fork 0
/
AppleHelp.h
262 lines (225 loc) · 6.48 KB
/
AppleHelp.h
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
/*
File: AppleHelp.h
Contains: Apple Help
Version: Technology: Mac OS X/CarbonLib 1.1
Release: Universal Interfaces 3.4
Copyright: © 2000-2001 by Apple Computer, Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __APPLEHELP__
#define __APPLEHELP__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FILES__
#include <Files.h>
#endif
#ifndef __CFSTRING__
#include <CFString.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_IMPORT
#pragma import on
#endif
#if PRAGMA_STRUCT_ALIGN
#pragma options align=mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
/* AppleHelp Error Codes */
enum {
kAHInternalErr = -10790,
kAHInternetConfigPrefErr = -10791
};
typedef SInt16 AHTOCType;
enum {
kAHTOCTypeUser = 0,
kAHTOCTypeDeveloper = 1
};
/*
* AHSearch()
*
* Discussion:
* Delivers a request to perform the specified search to the Help
* Viewer application.
*
* Parameters:
*
* bookname:
* Optionally, the AppleTitle of the Help book to be searched. If
* NULL, all installed Help books are searched.
*
* query:
* The query to be made. This string can, if desired, have boolean
* operators or be a natural language phrase.
*
* Result:
* An operating system result code that indicates whether the
* request was successfully sent to the Help Viewer application.
* Possible values: noErr, paramErr, kAHInternalErr,
* kAHInternetConfigPrefErr.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: in CarbonLib 1.1 and later
* Mac OS X: in version 10.0 or later
*/
EXTERN_API_C( OSStatus )
AHSearch(
CFStringRef bookname,
CFStringRef query);
/*
* AHGotoMainTOC()
*
* Discussion:
* Delivers a request to load the main table of contents of
* installed help books to the Help Viewer application.
*
* Parameters:
*
* toctype:
* The type of table of contents to be loaded: user or developer.
*
* Result:
* An operating system result code that indicates whether the
* request was successfully sent to the Help Viewer application.
* Possible values: noErr, paramErr, kAHInternalErr,
* kAHInternetConfigPrefErr.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: in CarbonLib 1.1 and later
* Mac OS X: in version 10.0 or later
*/
EXTERN_API_C( OSStatus )
AHGotoMainTOC(AHTOCType toctype);
/*
* AHGotoPage()
*
* Discussion:
* Delivers a request to load a specific text/html file to the Help
* Viewer application.
*
* Parameters:
*
* bookname:
* Optionally, the AppleTitle of an installed Help book. If NULL,
* the path parameter must be a full file: URL to the file to be
* opened.
*
* path:
* Optionally, one of two types of paths: 1) a URL-style path to a
* file that is relative to the main folder of the book supplied
* in the bookname parameter, or 2) if bookname is NULL, a full
* file: URL to the file to be opened. If this parameter is NULL,
* then bookname must not be NULL, and is used to open the Help
* Viewer to the main page of Help content for the specified book.
*
* anchor:
* Optionally, the name of anchor tag to scroll to in the newly
* opened file. Can be NULL.
*
* Result:
* An operating system result code that indicates whether the
* request was successfully sent to the Help Viewer application.
* Possible values: noErr, paramErr, kAHInternalErr,
* kAHInternetConfigPrefErr.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: in CarbonLib 1.1 and later
* Mac OS X: in version 10.0 or later
*/
EXTERN_API_C( OSStatus )
AHGotoPage(
CFStringRef bookname,
CFStringRef path,
CFStringRef anchor);
/*
* AHLookupAnchor()
*
* Discussion:
* Delivers a request to perform an anchor lookup to the Help Viewer
* application. Note: anchor lookups will fail unless you have
* indexed your help content with anchor indexing turned on in the
* indexing tool's preferences panel.
*
* Parameters:
*
* bookname:
* Optionally, the AppleTitle of the Help book to searched. If
* NULL, the anchor lookup is performed using all installed Help
* books.
*
* anchor:
* The name of the anchor tag to look up.
*
* Result:
* An operating system result code that indicates whether the
* request was successfully sent to the Help Viewer application.
* Possible values: noErr, paramErr, kAHInternalErr,
* kAHInternetConfigPrefErr.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: in CarbonLib 1.1 and later
* Mac OS X: in version 10.0 or later
*/
EXTERN_API_C( OSStatus )
AHLookupAnchor(
CFStringRef bookname,
CFStringRef anchor);
/*
* AHRegisterHelpBook()
*
* Discussion:
* Registers a book of Help content such that the book will appear
* in the current user's main table of contents (Help Center) in the
* Help Viewer application. To be used when help books reside
* outside of the known help folders (i.e. help books that are kept
* inside of application bundles).
*
* Parameters:
*
* appBundleRef:
* An FSRef pointer to the bundle within which one or more Help
* books is stored. This is likely an FSRef to your application's
* main bundle.
*
* Result:
* An operating system result code that indicates whether all help
* books contained within the specified bundle were registered.
* Possible values: noErr, paramErr, kAHInternalErr, dirNFErr.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: in CarbonLib 1.1 and later
* Mac OS X: in version 10.0 or later
*/
EXTERN_API_C( OSStatus )
AHRegisterHelpBook(const FSRef * appBundleRef);
#if PRAGMA_STRUCT_ALIGN
#pragma options align=reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __APPLEHELP__ */