An Objective-C wrapper for Mac OS X’s FSEvents C API.
Revision | cf22832b16d4ef5e7fbcfa1433d742901e3a6de9 (tree) |
---|---|
Time | 2011-11-03 00:46:31 |
Author | Aron Cedercrantz <aron@cede...> |
Commiter | Aron Cedercrantz |
Change latest to ordinary directory.
It seems that links did not work with gh pages :P
@@ -1 +0,0 @@ | ||
1 | -1.1.2 | |
\ No newline at end of file |
@@ -0,0 +1,1610 @@ | ||
1 | +<!DOCTYPE HTML> | |
2 | +<html> | |
3 | + <head> | |
4 | + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> | |
5 | + <title>CDEvent Class Reference</title> | |
6 | + <meta id="xcode-display" name="xcode-display" content="render"/> | |
7 | + <meta name="viewport" content="width=550" /> | |
8 | + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> | |
9 | + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> | |
10 | + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> | |
11 | + </head> | |
12 | + <body> | |
13 | + <header id="top_header"> | |
14 | + <div id="library" class="hideInXcode"> | |
15 | + <h1><a id="libraryTitle" href="../index.html">CDEvents </a></h1> | |
16 | + <a id="developerHome" href="../index.html">Aron Cedercrantz</a> | |
17 | + </div> | |
18 | + | |
19 | + <div id="title" role="banner"> | |
20 | + <h1 class="hideInXcode">CDEvent Class Reference</h1> | |
21 | + </div> | |
22 | + <ul id="headerButtons" role="toolbar"> | |
23 | + <li id="toc_button"> | |
24 | + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> | |
25 | + </li> | |
26 | + <li id="jumpto_button" role="navigation"> | |
27 | + <select id="jumpTo"> | |
28 | + <option value="top">Jump To…</option> | |
29 | + | |
30 | + <option value="overview">Overview</option> | |
31 | + | |
32 | + | |
33 | + | |
34 | + | |
35 | + <option value="tasks">Tasks</option> | |
36 | + | |
37 | + | |
38 | + | |
39 | + | |
40 | + | |
41 | + <option value="properties">Properties</option> | |
42 | + | |
43 | + <option value="//api/name/URL"> URL</option> | |
44 | + | |
45 | + <option value="//api/name/date"> date</option> | |
46 | + | |
47 | + <option value="//api/name/didVolumeMount"> didVolumeMount</option> | |
48 | + | |
49 | + <option value="//api/name/didVolumeUnmount"> didVolumeUnmount</option> | |
50 | + | |
51 | + <option value="//api/name/flags"> flags</option> | |
52 | + | |
53 | + <option value="//api/name/identifier"> identifier</option> | |
54 | + | |
55 | + <option value="//api/name/isCreated"> isCreated</option> | |
56 | + | |
57 | + <option value="//api/name/isEventIdentifiersWrapped"> isEventIdentifiersWrapped</option> | |
58 | + | |
59 | + <option value="//api/name/isGenericChange"> isGenericChange</option> | |
60 | + | |
61 | + <option value="//api/name/isHistoryDone"> isHistoryDone</option> | |
62 | + | |
63 | + <option value="//api/name/isKernelDropped"> isKernelDropped</option> | |
64 | + | |
65 | + <option value="//api/name/isRootChanged"> isRootChanged</option> | |
66 | + | |
67 | + <option value="//api/name/isUserDropped"> isUserDropped</option> | |
68 | + | |
69 | + <option value="//api/name/mustRescanSubDirectories"> mustRescanSubDirectories</option> | |
70 | + | |
71 | + | |
72 | + | |
73 | + | |
74 | + <option value="class_methods">Class Methods</option> | |
75 | + | |
76 | + <option value="//api/name/eventWithIdentifier:date:URL:flags:"> + eventWithIdentifier:date:URL:flags:</option> | |
77 | + | |
78 | + | |
79 | + | |
80 | + | |
81 | + <option value="instance_methods">Instance Methods</option> | |
82 | + | |
83 | + <option value="//api/name/initWithIdentifier:date:URL:flags:"> - initWithIdentifier:date:URL:flags:</option> | |
84 | + | |
85 | + | |
86 | + | |
87 | +</select> | |
88 | + </li> | |
89 | + </ul> | |
90 | + </header> | |
91 | + <nav id="tocContainer" class="isShowingTOC"> | |
92 | + <ul id="toc" role="tree"> | |
93 | + | |
94 | +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> | |
95 | + | |
96 | + | |
97 | + | |
98 | + | |
99 | +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> | |
100 | + | |
101 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Getting Event Properties">Getting Event Properties</a></span></li> | |
102 | + | |
103 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Getting Event Flags">Getting Event Flags</a></span></li> | |
104 | + | |
105 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Creating CDEvent Objects">Creating CDEvent Objects</a></span></li> | |
106 | + | |
107 | +</ul></li> | |
108 | + | |
109 | + | |
110 | + | |
111 | + | |
112 | + | |
113 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> | |
114 | + | |
115 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/URL">URL</a></span></li> | |
116 | + | |
117 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/date">date</a></span></li> | |
118 | + | |
119 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/didVolumeMount">didVolumeMount</a></span></li> | |
120 | + | |
121 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/didVolumeUnmount">didVolumeUnmount</a></span></li> | |
122 | + | |
123 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/flags">flags</a></span></li> | |
124 | + | |
125 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/identifier">identifier</a></span></li> | |
126 | + | |
127 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isCreated">isCreated</a></span></li> | |
128 | + | |
129 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isEventIdentifiersWrapped">isEventIdentifiersWrapped</a></span></li> | |
130 | + | |
131 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isGenericChange">isGenericChange</a></span></li> | |
132 | + | |
133 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isHistoryDone">isHistoryDone</a></span></li> | |
134 | + | |
135 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isKernelDropped">isKernelDropped</a></span></li> | |
136 | + | |
137 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isRootChanged">isRootChanged</a></span></li> | |
138 | + | |
139 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isUserDropped">isUserDropped</a></span></li> | |
140 | + | |
141 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/mustRescanSubDirectories">mustRescanSubDirectories</a></span></li> | |
142 | + | |
143 | +</ul></li> | |
144 | + | |
145 | + | |
146 | + | |
147 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> | |
148 | + | |
149 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/eventWithIdentifier:date:URL:flags:">eventWithIdentifier:date:URL:flags:</a></span></li> | |
150 | + | |
151 | +</ul></li> | |
152 | + | |
153 | + | |
154 | + | |
155 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> | |
156 | + | |
157 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithIdentifier:date:URL:flags:">initWithIdentifier:date:URL:flags:</a></span></li> | |
158 | + | |
159 | +</ul></li> | |
160 | + | |
161 | + | |
162 | + </ul> | |
163 | + </nav> | |
164 | + <article> | |
165 | + <div id="contents" class="isShowingTOC" role="main"> | |
166 | + <a title="CDEvent Class Reference" name="top"></a> | |
167 | + <div class="main-navigation navigation-top"> | |
168 | + <ul> | |
169 | + <li><a href="../index.html">Index</a></li> | |
170 | + <li><a href="../hierarchy.html">Hierarchy</a></li> | |
171 | +</ul> | |
172 | + </div> | |
173 | + <div id="header"> | |
174 | + <div class="section-header"> | |
175 | + <h1 class="title title-header">CDEvent Class Reference</h1> | |
176 | + </div> | |
177 | + </div> | |
178 | + <div id="container"> | |
179 | + | |
180 | + <div class="section section-specification"><table cellspacing="0"><tbody> | |
181 | + <tr> | |
182 | + <td class="specification-title">Inherits from</td> | |
183 | + <td class="specification-value">NSObject</td> | |
184 | +</tr><tr> | |
185 | + <td class="specification-title">Conforms to</td> | |
186 | + <td class="specification-value">NSCoding<br />NSCopying</td> | |
187 | +</tr><tr> | |
188 | + <td class="specification-title">Declared in</td> | |
189 | + <td class="specification-value">CDEvent.h</td> | |
190 | +</tr> | |
191 | + </tbody></table></div> | |
192 | + | |
193 | + | |
194 | + | |
195 | + | |
196 | + <div class="section section-overview"> | |
197 | + <a title="Overview" name="overview"></a> | |
198 | + <h2 class="subtitle subtitle-overview">Overview</h2> | |
199 | + <p>An Objective-C wrapper for a <code>FSEvents</code> event data.</p> | |
200 | + | |
201 | +<p>@note Inpired by <code>SCEvent</code> class of the <code>SCEvents</code> project by Stuart Connolly. | |
202 | +@note The class is immutable.</p> | |
203 | + </div> | |
204 | + | |
205 | + | |
206 | + | |
207 | + | |
208 | + | |
209 | + <div class="section section-tasks"> | |
210 | + <a title="Tasks" name="tasks"></a> | |
211 | + <h2 class="subtitle subtitle-tasks">Tasks</h2> | |
212 | + | |
213 | + | |
214 | + <a title="Getting Event Properties" name="task_Getting Event Properties"></a> | |
215 | + <h3 class="subsubtitle task-title">Getting Event Properties</h3> | |
216 | + | |
217 | + <ul class="task-list"> | |
218 | + <li> | |
219 | + <span class="tooltip"> | |
220 | + <code><a href="#//api/name/identifier"> identifier</a></code> | |
221 | + <span class="tooltip"><p>The event <a href="#//api/name/identifier">identifier</a>.</p></span> | |
222 | + </span> | |
223 | + <span class="task-item-suffix">property</span> | |
224 | + | |
225 | +</li><li> | |
226 | + <span class="tooltip"> | |
227 | + <code><a href="#//api/name/date"> date</a></code> | |
228 | + <span class="tooltip"><p>An approximate <a href="#//api/name/date">date</a> and time the event occured.</p></span> | |
229 | + </span> | |
230 | + <span class="task-item-suffix">property</span> | |
231 | + | |
232 | +</li><li> | |
233 | + <span class="tooltip"> | |
234 | + <code><a href="#//api/name/URL"> URL</a></code> | |
235 | + <span class="tooltip"><p>The <a href="#//api/name/URL">URL</a> of the item which changed.</p></span> | |
236 | + </span> | |
237 | + <span class="task-item-suffix">property</span> | |
238 | + | |
239 | +</li> | |
240 | + </ul> | |
241 | + | |
242 | + | |
243 | + <a title="Getting Event Flags" name="task_Getting Event Flags"></a> | |
244 | + <h3 class="subsubtitle task-title">Getting Event Flags</h3> | |
245 | + | |
246 | + <ul class="task-list"> | |
247 | + <li> | |
248 | + <span class="tooltip"> | |
249 | + <code><a href="#//api/name/flags"> flags</a></code> | |
250 | + <span class="tooltip"><p>The <a href="#//api/name/flags">flags</a> of the event.</p></span> | |
251 | + </span> | |
252 | + <span class="task-item-suffix">property</span> | |
253 | + | |
254 | +</li><li> | |
255 | + <span class="tooltip"> | |
256 | + <code><a href="#//api/name/isGenericChange"> isGenericChange</a></code> | |
257 | + <span class="tooltip"><p>Wheter there was some change in the directory at the specific path supplied in this event.</p></span> | |
258 | + </span> | |
259 | + <span class="task-item-suffix">property</span> | |
260 | + | |
261 | +</li><li> | |
262 | + <span class="tooltip"> | |
263 | + <code><a href="#//api/name/mustRescanSubDirectories"> mustRescanSubDirectories</a></code> | |
264 | + <span class="tooltip"><p>Wheter you must rescan the whole <a href="#//api/name/URL">URL</a> including its children.</p></span> | |
265 | + </span> | |
266 | + <span class="task-item-suffix">property</span> | |
267 | + | |
268 | +</li><li> | |
269 | + <span class="tooltip"> | |
270 | + <code><a href="#//api/name/isUserDropped"> isUserDropped</a></code> | |
271 | + <span class="tooltip"><p>Provides some information as to what might have caused the need to rescan the <a href="#//api/name/URL">URL</a> including its children.</p></span> | |
272 | + </span> | |
273 | + <span class="task-item-suffix">property</span> | |
274 | + | |
275 | +</li><li> | |
276 | + <span class="tooltip"> | |
277 | + <code><a href="#//api/name/isKernelDropped"> isKernelDropped</a></code> | |
278 | + <span class="tooltip"><p>Provides some information as to what might have caused the need to rescan the <a href="#//api/name/URL">URL</a> including its children.</p></span> | |
279 | + </span> | |
280 | + <span class="task-item-suffix">property</span> | |
281 | + | |
282 | +</li><li> | |
283 | + <span class="tooltip"> | |
284 | + <code><a href="#//api/name/isEventIdentifiersWrapped"> isEventIdentifiersWrapped</a></code> | |
285 | + <span class="tooltip"><p>Wheter the 64-bit event <a href="#//api/name/identifier">identifier</a> counter has wrapped around.</p></span> | |
286 | + </span> | |
287 | + <span class="task-item-suffix">property</span> | |
288 | + | |
289 | +</li><li> | |
290 | + <span class="tooltip"> | |
291 | + <code><a href="#//api/name/isHistoryDone"> isHistoryDone</a></code> | |
292 | + <span class="tooltip"><p>Denotes a sentinel event sent to mark the end of the “historical” events sent.</p></span> | |
293 | + </span> | |
294 | + <span class="task-item-suffix">property</span> | |
295 | + | |
296 | +</li><li> | |
297 | + <span class="tooltip"> | |
298 | + <code><a href="#//api/name/isRootChanged"> isRootChanged</a></code> | |
299 | + <span class="tooltip"><p>Denotes a special event sent when there is a change to one of the URLs you asked to watch.</p></span> | |
300 | + </span> | |
301 | + <span class="task-item-suffix">property</span> | |
302 | + | |
303 | +</li><li> | |
304 | + <span class="tooltip"> | |
305 | + <code><a href="#//api/name/didVolumeMount"> didVolumeMount</a></code> | |
306 | + <span class="tooltip"><p>Denotes a special event sent when a volume is mounted underneath one of the URLs being watched.</p></span> | |
307 | + </span> | |
308 | + <span class="task-item-suffix">property</span> | |
309 | + | |
310 | +</li><li> | |
311 | + <span class="tooltip"> | |
312 | + <code><a href="#//api/name/didVolumeUnmount"> didVolumeUnmount</a></code> | |
313 | + <span class="tooltip"><p>Denotes a special event sent when a volume is unmounted underneath one of the URLs being watched.</p></span> | |
314 | + </span> | |
315 | + <span class="task-item-suffix">property</span> | |
316 | + | |
317 | +</li><li> | |
318 | + <span class="tooltip"> | |
319 | + <code><a href="#//api/name/isCreated"> isCreated</a></code> | |
320 | + <span class="tooltip"><p>The entirety of the documentation on file level events in lion is 3 sentences | |
321 | +long. Rename behavior is odd, making the combination of events and <a href="#//api/name/flags">flags</a> | |
322 | +somewhat confusing for atomic writes. It also appears possible to get a | |
323 | +singular event where a file has been created, modified, and removed.</p></span> | |
324 | + </span> | |
325 | + <span class="task-item-suffix">property</span> | |
326 | + | |
327 | +</li> | |
328 | + </ul> | |
329 | + | |
330 | + | |
331 | + <a title="Creating CDEvent Objects" name="task_Creating CDEvent Objects"></a> | |
332 | + <h3 class="subsubtitle task-title">Creating CDEvent Objects</h3> | |
333 | + | |
334 | + <ul class="task-list"> | |
335 | + <li> | |
336 | + <span class="tooltip"> | |
337 | + <code><a href="#//api/name/eventWithIdentifier:date:URL:flags:">+ eventWithIdentifier:date:URL:flags:</a></code> | |
338 | + <span class="tooltip"><p>Returns an <code>CDEvent</code> created with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p></span> | |
339 | + </span> | |
340 | + | |
341 | + | |
342 | +</li><li> | |
343 | + <span class="tooltip"> | |
344 | + <code><a href="#//api/name/initWithIdentifier:date:URL:flags:">– initWithIdentifier:date:URL:flags:</a></code> | |
345 | + <span class="tooltip"><p>Returns an <code>CDEvent</code> object initialized with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p></span> | |
346 | + </span> | |
347 | + | |
348 | + | |
349 | +</li> | |
350 | + </ul> | |
351 | + | |
352 | + </div> | |
353 | + | |
354 | + | |
355 | + | |
356 | + | |
357 | + | |
358 | + <div class="section section-methods"> | |
359 | + <a title="Properties" name="properties"></a> | |
360 | + <h2 class="subtitle subtitle-methods">Properties</h2> | |
361 | + | |
362 | + <div class="section-method"> | |
363 | + <a name="//api/name/URL" title="URL"></a> | |
364 | + <h3 class="subsubtitle method-title">URL</h3> | |
365 | + | |
366 | + | |
367 | + | |
368 | + <div class="method-subsection brief-description"> | |
369 | + <p>The <a href="#//api/name/URL">URL</a> of the item which changed.</p> | |
370 | + </div> | |
371 | + | |
372 | + | |
373 | + <div class="method-subsection method-declaration"><code>@property (readonly) NSURL *URL</code></div> | |
374 | + | |
375 | + | |
376 | + | |
377 | + | |
378 | + <div class="method-subsection return"> | |
379 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
380 | + <p>The <a href="#//api/name/URL">URL</a> of the item which changed.</p> | |
381 | + </div> | |
382 | + | |
383 | + | |
384 | + | |
385 | + <div class="method-subsection availability"> | |
386 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
387 | + <p>1.0.0</p> | |
388 | + </div> | |
389 | + | |
390 | + | |
391 | + | |
392 | + <div class="method-subsection discussion-section"> | |
393 | + <h4 class="method-subtitle">Discussion</h4> | |
394 | + <p>The <a href="#//api/name/URL">URL</a> of the item which changed.</p> | |
395 | + </div> | |
396 | + | |
397 | + | |
398 | + | |
399 | + | |
400 | + | |
401 | + | |
402 | + | |
403 | + <div class="method-subsection declared-in-section"> | |
404 | + <h4 class="method-subtitle">Declared In</h4> | |
405 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
406 | + </div> | |
407 | + | |
408 | + | |
409 | +</div> | |
410 | + | |
411 | + <div class="section-method"> | |
412 | + <a name="//api/name/date" title="date"></a> | |
413 | + <h3 class="subsubtitle method-title">date</h3> | |
414 | + | |
415 | + | |
416 | + | |
417 | + <div class="method-subsection brief-description"> | |
418 | + <p>An approximate <a href="#//api/name/date">date</a> and time the event occured.</p> | |
419 | + </div> | |
420 | + | |
421 | + | |
422 | + <div class="method-subsection method-declaration"><code>@property (readonly) NSDate *date</code></div> | |
423 | + | |
424 | + | |
425 | + | |
426 | + | |
427 | + <div class="method-subsection return"> | |
428 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
429 | + <p>The approximate <a href="#//api/name/date">date</a> and time the event occured.</p> | |
430 | + </div> | |
431 | + | |
432 | + | |
433 | + | |
434 | + <div class="method-subsection availability"> | |
435 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
436 | + <p>1.0.0</p> | |
437 | + </div> | |
438 | + | |
439 | + | |
440 | + | |
441 | + <div class="method-subsection discussion-section"> | |
442 | + <h4 class="method-subtitle">Discussion</h4> | |
443 | + <p>An approximate <a href="#//api/name/date">date</a> and time the event occured.</p> | |
444 | + </div> | |
445 | + | |
446 | + | |
447 | + | |
448 | + | |
449 | + | |
450 | + | |
451 | + | |
452 | + <div class="method-subsection declared-in-section"> | |
453 | + <h4 class="method-subtitle">Declared In</h4> | |
454 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
455 | + </div> | |
456 | + | |
457 | + | |
458 | +</div> | |
459 | + | |
460 | + <div class="section-method"> | |
461 | + <a name="//api/name/didVolumeMount" title="didVolumeMount"></a> | |
462 | + <h3 class="subsubtitle method-title">didVolumeMount</h3> | |
463 | + | |
464 | + | |
465 | + | |
466 | + <div class="method-subsection brief-description"> | |
467 | + <p>Denotes a special event sent when a volume is mounted underneath one of the URLs being watched.</p> | |
468 | + </div> | |
469 | + | |
470 | + | |
471 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL didVolumeMount</code></div> | |
472 | + | |
473 | + | |
474 | + | |
475 | + | |
476 | + <div class="method-subsection return"> | |
477 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
478 | + <p><code>YES</code> if a volumen is mounted underneath one of the URLs being watched, otherwise <code>NO</code>.</p> | |
479 | + </div> | |
480 | + | |
481 | + | |
482 | + | |
483 | + <div class="method-subsection availability"> | |
484 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
485 | + <p>1.1.0</p> | |
486 | + </div> | |
487 | + | |
488 | + | |
489 | + | |
490 | + <div class="method-subsection discussion-section"> | |
491 | + <h4 class="method-subtitle">Discussion</h4> | |
492 | + <p>Denotes a special event sent when a volume is mounted underneath one of the URLs being watched.</p> | |
493 | + | |
494 | +<p>Denotes a special event sent when a volume is mounted underneath one of the | |
495 | +URLs being watched. The <a href="#//api/name/URL">URL</a> in the event is the <a href="#//api/name/URL">URL</a> to the newly-mounted | |
496 | +volume. You will receive one of these notifications for every volume mount | |
497 | +event inside the kernel (independent of DiskArbitration). Beware that a | |
498 | +newly-mounted volume could contain an arbitrarily large directory hierarchy. | |
499 | +Avoid pitfalls like triggering a recursive scan of a non-local filesystem, | |
500 | +which you can detect by checking for the absence of the | |
501 | +<code>MNT_LOCAL</code> flag in the <code>f_flags</code> returned by statfs(). | |
502 | +Also be aware of the <code>MNT_DONTBROWSE</code> flag that is set for volumes | |
503 | +which should not be displayed by user interface elements.</p> | |
504 | + </div> | |
505 | + | |
506 | + | |
507 | + | |
508 | + | |
509 | + | |
510 | + <div class="method-subsection see-also-section"> | |
511 | + <h4 class="method-subtitle">See Also</h4> | |
512 | + <ul> | |
513 | + | |
514 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
515 | + | |
516 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
517 | + | |
518 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
519 | + | |
520 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
521 | + | |
522 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
523 | + | |
524 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
525 | + | |
526 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
527 | + | |
528 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
529 | + | |
530 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
531 | + | |
532 | + </ul> | |
533 | + </div> | |
534 | + | |
535 | + | |
536 | + | |
537 | + <div class="method-subsection declared-in-section"> | |
538 | + <h4 class="method-subtitle">Declared In</h4> | |
539 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
540 | + </div> | |
541 | + | |
542 | + | |
543 | +</div> | |
544 | + | |
545 | + <div class="section-method"> | |
546 | + <a name="//api/name/didVolumeUnmount" title="didVolumeUnmount"></a> | |
547 | + <h3 class="subsubtitle method-title">didVolumeUnmount</h3> | |
548 | + | |
549 | + | |
550 | + | |
551 | + <div class="method-subsection brief-description"> | |
552 | + <p>Denotes a special event sent when a volume is unmounted underneath one of the URLs being watched.</p> | |
553 | + </div> | |
554 | + | |
555 | + | |
556 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL didVolumeUnmount</code></div> | |
557 | + | |
558 | + | |
559 | + | |
560 | + | |
561 | + <div class="method-subsection return"> | |
562 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
563 | + <p><code>YES</code> if a volume is unmounted underneath one of the URLs being watched, otherwise <code>NO</code>.</p> | |
564 | + </div> | |
565 | + | |
566 | + | |
567 | + | |
568 | + <div class="method-subsection availability"> | |
569 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
570 | + <p>1.1.0</p> | |
571 | + </div> | |
572 | + | |
573 | + | |
574 | + | |
575 | + <div class="method-subsection discussion-section"> | |
576 | + <h4 class="method-subtitle">Discussion</h4> | |
577 | + <p>Denotes a special event sent when a volume is unmounted underneath one of the URLs being watched.</p> | |
578 | + | |
579 | +<p>Denotes a special event sent when a volume is unmounted underneath one of the | |
580 | +URLs being watched. The <a href="#//api/name/URL">URL</a> in the event is the <a href="#//api/name/URL">URL</a> to the directory from | |
581 | +which the volume was unmounted. You will receive one of these notifications | |
582 | +for every volume unmount event inside the kernel. This is not a substitute | |
583 | +for the notifications provided by the DiskArbitration framework; you only get | |
584 | +notified after the unmount has occurred. Beware that unmounting a volume | |
585 | +could uncover an arbitrarily large directory hierarchy, although Mac OS X | |
586 | +never does that.</p> | |
587 | + </div> | |
588 | + | |
589 | + | |
590 | + | |
591 | + | |
592 | + | |
593 | + <div class="method-subsection see-also-section"> | |
594 | + <h4 class="method-subtitle">See Also</h4> | |
595 | + <ul> | |
596 | + | |
597 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
598 | + | |
599 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
600 | + | |
601 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
602 | + | |
603 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
604 | + | |
605 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
606 | + | |
607 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
608 | + | |
609 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
610 | + | |
611 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
612 | + | |
613 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
614 | + | |
615 | + </ul> | |
616 | + </div> | |
617 | + | |
618 | + | |
619 | + | |
620 | + <div class="method-subsection declared-in-section"> | |
621 | + <h4 class="method-subtitle">Declared In</h4> | |
622 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
623 | + </div> | |
624 | + | |
625 | + | |
626 | +</div> | |
627 | + | |
628 | + <div class="section-method"> | |
629 | + <a name="//api/name/flags" title="flags"></a> | |
630 | + <h3 class="subsubtitle method-title">flags</h3> | |
631 | + | |
632 | + | |
633 | + | |
634 | + <div class="method-subsection brief-description"> | |
635 | + <p>The <a href="#//api/name/flags">flags</a> of the event.</p> | |
636 | + </div> | |
637 | + | |
638 | + | |
639 | + <div class="method-subsection method-declaration"><code>@property (readonly) CDEventFlags flags</code></div> | |
640 | + | |
641 | + | |
642 | + | |
643 | + | |
644 | + <div class="method-subsection return"> | |
645 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
646 | + <p>The <a href="#//api/name/flags">flags</a> of the event.</p> | |
647 | + </div> | |
648 | + | |
649 | + | |
650 | + | |
651 | + <div class="method-subsection availability"> | |
652 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
653 | + <p>1.0.0</p> | |
654 | + </div> | |
655 | + | |
656 | + | |
657 | + | |
658 | + <div class="method-subsection discussion-section"> | |
659 | + <h4 class="method-subtitle">Discussion</h4> | |
660 | + <p>The <a href="#//api/name/flags">flags</a> of the event.</p> | |
661 | + | |
662 | +<p>The <a href="#//api/name/flags">flags</a> of the event as returned by <code>FSEvents</code>.</p> | |
663 | + </div> | |
664 | + | |
665 | + | |
666 | + | |
667 | + | |
668 | + | |
669 | + | |
670 | + | |
671 | + <div class="method-subsection declared-in-section"> | |
672 | + <h4 class="method-subtitle">Declared In</h4> | |
673 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
674 | + </div> | |
675 | + | |
676 | + | |
677 | +</div> | |
678 | + | |
679 | + <div class="section-method"> | |
680 | + <a name="//api/name/identifier" title="identifier"></a> | |
681 | + <h3 class="subsubtitle method-title">identifier</h3> | |
682 | + | |
683 | + | |
684 | + | |
685 | + <div class="method-subsection brief-description"> | |
686 | + <p>The event <a href="#//api/name/identifier">identifier</a>.</p> | |
687 | + </div> | |
688 | + | |
689 | + | |
690 | + <div class="method-subsection method-declaration"><code>@property (readonly) CDEventIdentifier identifier</code></div> | |
691 | + | |
692 | + | |
693 | + | |
694 | + | |
695 | + <div class="method-subsection return"> | |
696 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
697 | + <p>The event <a href="#//api/name/identifier">identifier</a>.</p> | |
698 | + </div> | |
699 | + | |
700 | + | |
701 | + | |
702 | + <div class="method-subsection availability"> | |
703 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
704 | + <p>1.0.0</p> | |
705 | + </div> | |
706 | + | |
707 | + | |
708 | + | |
709 | + <div class="method-subsection discussion-section"> | |
710 | + <h4 class="method-subtitle">Discussion</h4> | |
711 | + <p>The event <a href="#//api/name/identifier">identifier</a>.</p> | |
712 | + | |
713 | +<p>The event <a href="#//api/name/identifier">identifier</a> as returned by <code>FSEvents</code>.</p> | |
714 | + </div> | |
715 | + | |
716 | + | |
717 | + | |
718 | + | |
719 | + | |
720 | + | |
721 | + | |
722 | + <div class="method-subsection declared-in-section"> | |
723 | + <h4 class="method-subtitle">Declared In</h4> | |
724 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
725 | + </div> | |
726 | + | |
727 | + | |
728 | +</div> | |
729 | + | |
730 | + <div class="section-method"> | |
731 | + <a name="//api/name/isCreated" title="isCreated"></a> | |
732 | + <h3 class="subsubtitle method-title">isCreated</h3> | |
733 | + | |
734 | + | |
735 | + | |
736 | + <div class="method-subsection brief-description"> | |
737 | + <p>The entirety of the documentation on file level events in lion is 3 sentences | |
738 | +long. Rename behavior is odd, making the combination of events and <a href="#//api/name/flags">flags</a> | |
739 | +somewhat confusing for atomic writes. It also appears possible to get a | |
740 | +singular event where a file has been created, modified, and removed.</p> | |
741 | + </div> | |
742 | + | |
743 | + | |
744 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isCreated</code></div> | |
745 | + | |
746 | + | |
747 | + | |
748 | + | |
749 | + | |
750 | + | |
751 | + | |
752 | + | |
753 | + <div class="method-subsection discussion-section"> | |
754 | + <h4 class="method-subtitle">Discussion</h4> | |
755 | + <p>The entirety of the documentation on file level events in lion is 3 sentences | |
756 | +long. Rename behavior is odd, making the combination of events and <a href="#//api/name/flags">flags</a> | |
757 | +somewhat confusing for atomic writes. It also appears possible to get a | |
758 | +singular event where a file has been created, modified, and removed.</p> | |
759 | + </div> | |
760 | + | |
761 | + | |
762 | + | |
763 | + | |
764 | + | |
765 | + | |
766 | + | |
767 | + <div class="method-subsection declared-in-section"> | |
768 | + <h4 class="method-subtitle">Declared In</h4> | |
769 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
770 | + </div> | |
771 | + | |
772 | + | |
773 | +</div> | |
774 | + | |
775 | + <div class="section-method"> | |
776 | + <a name="//api/name/isEventIdentifiersWrapped" title="isEventIdentifiersWrapped"></a> | |
777 | + <h3 class="subsubtitle method-title">isEventIdentifiersWrapped</h3> | |
778 | + | |
779 | + | |
780 | + | |
781 | + <div class="method-subsection brief-description"> | |
782 | + <p>Wheter the 64-bit event <a href="#//api/name/identifier">identifier</a> counter has wrapped around.</p> | |
783 | + </div> | |
784 | + | |
785 | + | |
786 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isEventIdentifiersWrapped</code></div> | |
787 | + | |
788 | + | |
789 | + | |
790 | + | |
791 | + <div class="method-subsection return"> | |
792 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
793 | + <p><code>YES</code> if the 64-bit event <a href="#//api/name/identifier">identifier</a> counter has wrapped around, otherwise <code>NO</code>.</p> | |
794 | + </div> | |
795 | + | |
796 | + | |
797 | + | |
798 | + <div class="method-subsection availability"> | |
799 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
800 | + <p>1.1.0</p> | |
801 | + </div> | |
802 | + | |
803 | + | |
804 | + | |
805 | + <div class="method-subsection discussion-section"> | |
806 | + <h4 class="method-subtitle">Discussion</h4> | |
807 | + <p>Wheter the 64-bit event <a href="#//api/name/identifier">identifier</a> counter has wrapped around.</p> | |
808 | + | |
809 | +<p>Wheter the 64-bit event <a href="#//api/name/identifier">identifier</a> counter has wrapped around. As a result, | |
810 | +previously-issued event identifiers are no longer valid arguments for the | |
811 | +sinceEventIdentifier parameter of the <a href="../Classes/CDEvents.html">CDEvents</a> init methods.</p> | |
812 | + </div> | |
813 | + | |
814 | + | |
815 | + | |
816 | + | |
817 | + | |
818 | + <div class="method-subsection see-also-section"> | |
819 | + <h4 class="method-subtitle">See Also</h4> | |
820 | + <ul> | |
821 | + | |
822 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
823 | + | |
824 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
825 | + | |
826 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
827 | + | |
828 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
829 | + | |
830 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
831 | + | |
832 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
833 | + | |
834 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
835 | + | |
836 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
837 | + | |
838 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
839 | + | |
840 | + </ul> | |
841 | + </div> | |
842 | + | |
843 | + | |
844 | + | |
845 | + <div class="method-subsection declared-in-section"> | |
846 | + <h4 class="method-subtitle">Declared In</h4> | |
847 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
848 | + </div> | |
849 | + | |
850 | + | |
851 | +</div> | |
852 | + | |
853 | + <div class="section-method"> | |
854 | + <a name="//api/name/isGenericChange" title="isGenericChange"></a> | |
855 | + <h3 class="subsubtitle method-title">isGenericChange</h3> | |
856 | + | |
857 | + | |
858 | + | |
859 | + <div class="method-subsection brief-description"> | |
860 | + <p>Wheter there was some change in the directory at the specific path supplied in this event.</p> | |
861 | + </div> | |
862 | + | |
863 | + | |
864 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isGenericChange</code></div> | |
865 | + | |
866 | + | |
867 | + | |
868 | + | |
869 | + <div class="method-subsection return"> | |
870 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
871 | + <p><code>YES</code> if there was some change in the directory, otherwise <code>NO</code>.</p> | |
872 | + </div> | |
873 | + | |
874 | + | |
875 | + | |
876 | + <div class="method-subsection availability"> | |
877 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
878 | + <p>1.1.0</p> | |
879 | + </div> | |
880 | + | |
881 | + | |
882 | + | |
883 | + <div class="method-subsection discussion-section"> | |
884 | + <h4 class="method-subtitle">Discussion</h4> | |
885 | + <p>Wheter there was some change in the directory at the specific path supplied in this event.</p> | |
886 | + </div> | |
887 | + | |
888 | + | |
889 | + | |
890 | + | |
891 | + | |
892 | + <div class="method-subsection see-also-section"> | |
893 | + <h4 class="method-subtitle">See Also</h4> | |
894 | + <ul> | |
895 | + | |
896 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
897 | + | |
898 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
899 | + | |
900 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
901 | + | |
902 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
903 | + | |
904 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
905 | + | |
906 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
907 | + | |
908 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
909 | + | |
910 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
911 | + | |
912 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
913 | + | |
914 | + </ul> | |
915 | + </div> | |
916 | + | |
917 | + | |
918 | + | |
919 | + <div class="method-subsection declared-in-section"> | |
920 | + <h4 class="method-subtitle">Declared In</h4> | |
921 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
922 | + </div> | |
923 | + | |
924 | + | |
925 | +</div> | |
926 | + | |
927 | + <div class="section-method"> | |
928 | + <a name="//api/name/isHistoryDone" title="isHistoryDone"></a> | |
929 | + <h3 class="subsubtitle method-title">isHistoryDone</h3> | |
930 | + | |
931 | + | |
932 | + | |
933 | + <div class="method-subsection brief-description"> | |
934 | + <p>Denotes a sentinel event sent to mark the end of the “historical” events sent.</p> | |
935 | + </div> | |
936 | + | |
937 | + | |
938 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isHistoryDone</code></div> | |
939 | + | |
940 | + | |
941 | + | |
942 | + | |
943 | + <div class="method-subsection return"> | |
944 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
945 | + <p><code>YES</code> if if the event is sent to mark the end of the “historical” events sent, otherwise <code>NO</code>.</p> | |
946 | + </div> | |
947 | + | |
948 | + | |
949 | + | |
950 | + <div class="method-subsection availability"> | |
951 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
952 | + <p>1.1.0</p> | |
953 | + </div> | |
954 | + | |
955 | + | |
956 | + | |
957 | + <div class="method-subsection discussion-section"> | |
958 | + <h4 class="method-subtitle">Discussion</h4> | |
959 | + <p>Denotes a sentinel event sent to mark the end of the “historical” events sent.</p> | |
960 | + | |
961 | +<p>Denotes a sentinel event sent to mark the end of the “historical” events sent | |
962 | +as a result of specifying a <i>sinceEventIdentifier</i> argument other than | |
963 | +kCDEventsSinceEventNow with the <a href="../Classes/CDEvents.html">CDEvents</a> init methods.</p> | |
964 | + </div> | |
965 | + | |
966 | + | |
967 | + | |
968 | + | |
969 | + | |
970 | + <div class="method-subsection see-also-section"> | |
971 | + <h4 class="method-subtitle">See Also</h4> | |
972 | + <ul> | |
973 | + | |
974 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
975 | + | |
976 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
977 | + | |
978 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
979 | + | |
980 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
981 | + | |
982 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
983 | + | |
984 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
985 | + | |
986 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
987 | + | |
988 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
989 | + | |
990 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
991 | + | |
992 | + <li><code><p><a href="../Classes/CDEvents.html">CDEvents</a></p></code></li> | |
993 | + | |
994 | + </ul> | |
995 | + </div> | |
996 | + | |
997 | + | |
998 | + | |
999 | + <div class="method-subsection declared-in-section"> | |
1000 | + <h4 class="method-subtitle">Declared In</h4> | |
1001 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1002 | + </div> | |
1003 | + | |
1004 | + | |
1005 | +</div> | |
1006 | + | |
1007 | + <div class="section-method"> | |
1008 | + <a name="//api/name/isKernelDropped" title="isKernelDropped"></a> | |
1009 | + <h3 class="subsubtitle method-title">isKernelDropped</h3> | |
1010 | + | |
1011 | + | |
1012 | + | |
1013 | + <div class="method-subsection brief-description"> | |
1014 | + <p>Provides some information as to what might have caused the need to rescan the <a href="#//api/name/URL">URL</a> including its children.</p> | |
1015 | + </div> | |
1016 | + | |
1017 | + | |
1018 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isKernelDropped</code></div> | |
1019 | + | |
1020 | + | |
1021 | + | |
1022 | + | |
1023 | + <div class="method-subsection return"> | |
1024 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1025 | + <p><code>YES</code> if <a href="#//api/name/mustRescanSubDirectories">mustRescanSubDirectories</a> returns <code>YES</code> and the cause were in kernelspace, otherwise <code>NO</code>.</p> | |
1026 | + </div> | |
1027 | + | |
1028 | + | |
1029 | + | |
1030 | + <div class="method-subsection availability"> | |
1031 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1032 | + <p>1.1.0</p> | |
1033 | + </div> | |
1034 | + | |
1035 | + | |
1036 | + | |
1037 | + <div class="method-subsection discussion-section"> | |
1038 | + <h4 class="method-subtitle">Discussion</h4> | |
1039 | + <p>Provides some information as to what might have caused the need to rescan the <a href="#//api/name/URL">URL</a> including its children.</p> | |
1040 | + </div> | |
1041 | + | |
1042 | + | |
1043 | + | |
1044 | + | |
1045 | + | |
1046 | + <div class="method-subsection see-also-section"> | |
1047 | + <h4 class="method-subtitle">See Also</h4> | |
1048 | + <ul> | |
1049 | + | |
1050 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
1051 | + | |
1052 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
1053 | + | |
1054 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
1055 | + | |
1056 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
1057 | + | |
1058 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
1059 | + | |
1060 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
1061 | + | |
1062 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
1063 | + | |
1064 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
1065 | + | |
1066 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
1067 | + | |
1068 | + </ul> | |
1069 | + </div> | |
1070 | + | |
1071 | + | |
1072 | + | |
1073 | + <div class="method-subsection declared-in-section"> | |
1074 | + <h4 class="method-subtitle">Declared In</h4> | |
1075 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1076 | + </div> | |
1077 | + | |
1078 | + | |
1079 | +</div> | |
1080 | + | |
1081 | + <div class="section-method"> | |
1082 | + <a name="//api/name/isRootChanged" title="isRootChanged"></a> | |
1083 | + <h3 class="subsubtitle method-title">isRootChanged</h3> | |
1084 | + | |
1085 | + | |
1086 | + | |
1087 | + <div class="method-subsection brief-description"> | |
1088 | + <p>Denotes a special event sent when there is a change to one of the URLs you asked to watch.</p> | |
1089 | + </div> | |
1090 | + | |
1091 | + | |
1092 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isRootChanged</code></div> | |
1093 | + | |
1094 | + | |
1095 | + | |
1096 | + | |
1097 | + <div class="method-subsection return"> | |
1098 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1099 | + <p><code>YES</code> if there is a change to one of the URLs you asked to watch, otherwise <code>NO</code>.</p> | |
1100 | + </div> | |
1101 | + | |
1102 | + | |
1103 | + | |
1104 | + <div class="method-subsection availability"> | |
1105 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1106 | + <p>1.1.0</p> | |
1107 | + </div> | |
1108 | + | |
1109 | + | |
1110 | + | |
1111 | + <div class="method-subsection discussion-section"> | |
1112 | + <h4 class="method-subtitle">Discussion</h4> | |
1113 | + <p>Denotes a special event sent when there is a change to one of the URLs you asked to watch.</p> | |
1114 | + | |
1115 | +<p>Denotes a special event sent when there is a change to one of the URLs you | |
1116 | +asked to watch. When this method returns <code>YES</code>, the event | |
1117 | +<a href="#//api/name/identifier">identifier</a> is zero and the <code>URL</code> corresponds to one of the URLs | |
1118 | +you asked to watch (specifically, the one that changed). The <a href="#//api/name/URL">URL</a> may no | |
1119 | +longer exist because it or one of its parents was deleted or renamed. Events | |
1120 | +with this flag set will only be sent if you passed the flag | |
1121 | +<code>kFSEventStreamCreateFlagWatchRoot</code> to the <a href="../Classes/CDEvents.html">CDEvents</a>.</p> | |
1122 | + </div> | |
1123 | + | |
1124 | + | |
1125 | + | |
1126 | + | |
1127 | + | |
1128 | + <div class="method-subsection see-also-section"> | |
1129 | + <h4 class="method-subtitle">See Also</h4> | |
1130 | + <ul> | |
1131 | + | |
1132 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
1133 | + | |
1134 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
1135 | + | |
1136 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
1137 | + | |
1138 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
1139 | + | |
1140 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
1141 | + | |
1142 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
1143 | + | |
1144 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
1145 | + | |
1146 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
1147 | + | |
1148 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
1149 | + | |
1150 | + <li><code><p><a href="../Classes/CDEvents.html">CDEvents</a></p></code></li> | |
1151 | + | |
1152 | + </ul> | |
1153 | + </div> | |
1154 | + | |
1155 | + | |
1156 | + | |
1157 | + <div class="method-subsection declared-in-section"> | |
1158 | + <h4 class="method-subtitle">Declared In</h4> | |
1159 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1160 | + </div> | |
1161 | + | |
1162 | + | |
1163 | +</div> | |
1164 | + | |
1165 | + <div class="section-method"> | |
1166 | + <a name="//api/name/isUserDropped" title="isUserDropped"></a> | |
1167 | + <h3 class="subsubtitle method-title">isUserDropped</h3> | |
1168 | + | |
1169 | + | |
1170 | + | |
1171 | + <div class="method-subsection brief-description"> | |
1172 | + <p>Provides some information as to what might have caused the need to rescan the <a href="#//api/name/URL">URL</a> including its children.</p> | |
1173 | + </div> | |
1174 | + | |
1175 | + | |
1176 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL isUserDropped</code></div> | |
1177 | + | |
1178 | + | |
1179 | + | |
1180 | + | |
1181 | + <div class="method-subsection return"> | |
1182 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1183 | + <p><code>YES</code> if <a href="#//api/name/mustRescanSubDirectories">mustRescanSubDirectories</a> returns <code>YES</code> and the cause were in userland, otherwise <code>NO</code>.</p> | |
1184 | + </div> | |
1185 | + | |
1186 | + | |
1187 | + | |
1188 | + <div class="method-subsection availability"> | |
1189 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1190 | + <p>1.1.0</p> | |
1191 | + </div> | |
1192 | + | |
1193 | + | |
1194 | + | |
1195 | + <div class="method-subsection discussion-section"> | |
1196 | + <h4 class="method-subtitle">Discussion</h4> | |
1197 | + <p>Provides some information as to what might have caused the need to rescan the <a href="#//api/name/URL">URL</a> including its children.</p> | |
1198 | + </div> | |
1199 | + | |
1200 | + | |
1201 | + | |
1202 | + | |
1203 | + | |
1204 | + <div class="method-subsection see-also-section"> | |
1205 | + <h4 class="method-subtitle">See Also</h4> | |
1206 | + <ul> | |
1207 | + | |
1208 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
1209 | + | |
1210 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
1211 | + | |
1212 | + <li><code><p><a href="#//api/name/mustRescanSubDirectories">@property mustRescanSubDirectories</a></p></code></li> | |
1213 | + | |
1214 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
1215 | + | |
1216 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
1217 | + | |
1218 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
1219 | + | |
1220 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
1221 | + | |
1222 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
1223 | + | |
1224 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
1225 | + | |
1226 | + </ul> | |
1227 | + </div> | |
1228 | + | |
1229 | + | |
1230 | + | |
1231 | + <div class="method-subsection declared-in-section"> | |
1232 | + <h4 class="method-subtitle">Declared In</h4> | |
1233 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1234 | + </div> | |
1235 | + | |
1236 | + | |
1237 | +</div> | |
1238 | + | |
1239 | + <div class="section-method"> | |
1240 | + <a name="//api/name/mustRescanSubDirectories" title="mustRescanSubDirectories"></a> | |
1241 | + <h3 class="subsubtitle method-title">mustRescanSubDirectories</h3> | |
1242 | + | |
1243 | + | |
1244 | + | |
1245 | + <div class="method-subsection brief-description"> | |
1246 | + <p>Wheter you must rescan the whole <a href="#//api/name/URL">URL</a> including its children.</p> | |
1247 | + </div> | |
1248 | + | |
1249 | + | |
1250 | + <div class="method-subsection method-declaration"><code>@property (readonly) BOOL mustRescanSubDirectories</code></div> | |
1251 | + | |
1252 | + | |
1253 | + | |
1254 | + | |
1255 | + <div class="method-subsection return"> | |
1256 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1257 | + <p><code>YES</code> if you must rescan the whole directory including its children, otherwise <code>NO</code>.</p> | |
1258 | + </div> | |
1259 | + | |
1260 | + | |
1261 | + | |
1262 | + <div class="method-subsection availability"> | |
1263 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1264 | + <p>1.1.0</p> | |
1265 | + </div> | |
1266 | + | |
1267 | + | |
1268 | + | |
1269 | + <div class="method-subsection discussion-section"> | |
1270 | + <h4 class="method-subtitle">Discussion</h4> | |
1271 | + <p>Wheter you must rescan the whole <a href="#//api/name/URL">URL</a> including its children.</p> | |
1272 | + | |
1273 | +<p>Wheter your application must rescan not just the <a href="#//api/name/URL">URL</a> given in the event, but | |
1274 | +all its children, recursively. This can happen if there was a problem whereby | |
1275 | +events were coalesced hierarchically. For example, an event in | |
1276 | +<code>/Users/jsmith/Music</code> and an event in | |
1277 | +<code>/Users/jsmith/Pictures</code> might be coalesced into an event with | |
1278 | +this flag set and <a href="#//api/name/URL">URL</a> <code>= /Users/jsmith</code>. If this flag is set | |
1279 | +you may be able to get an idea of whether the bottleneck happened in the | |
1280 | +kernel (less likely) or in your client (more likely) by checking if | |
1281 | +<a href="#//api/name/isUserDropped">isUserDropped</a> or <a href="#//api/name/isKernelDropped">isKernelDropped</a> returns <code>YES</code>.</p> | |
1282 | + </div> | |
1283 | + | |
1284 | + | |
1285 | + | |
1286 | + | |
1287 | + | |
1288 | + <div class="method-subsection see-also-section"> | |
1289 | + <h4 class="method-subtitle">See Also</h4> | |
1290 | + <ul> | |
1291 | + | |
1292 | + <li><code><p><a href="#//api/name/flags">@property flags</a></p></code></li> | |
1293 | + | |
1294 | + <li><code><p><a href="#//api/name/isGenericChange">@property isGenericChange</a></p></code></li> | |
1295 | + | |
1296 | + <li><code><p><a href="#//api/name/isUserDropped">@property isUserDropped</a></p></code></li> | |
1297 | + | |
1298 | + <li><code><p><a href="#//api/name/isKernelDropped">@property isKernelDropped</a></p></code></li> | |
1299 | + | |
1300 | + <li><code><p><a href="#//api/name/isEventIdentifiersWrapped">@property isEventIdentifiersWrapped</a></p></code></li> | |
1301 | + | |
1302 | + <li><code><p><a href="#//api/name/isHistoryDone">@property isHistoryDone</a></p></code></li> | |
1303 | + | |
1304 | + <li><code><p><a href="#//api/name/isRootChanged">@property isRootChanged</a></p></code></li> | |
1305 | + | |
1306 | + <li><code><p><a href="#//api/name/didVolumeMount">@property didVolumeMount</a></p></code></li> | |
1307 | + | |
1308 | + <li><code><p><a href="#//api/name/didVolumeUnmount">@property didVolumeUnmount</a></p></code></li> | |
1309 | + | |
1310 | + </ul> | |
1311 | + </div> | |
1312 | + | |
1313 | + | |
1314 | + | |
1315 | + <div class="method-subsection declared-in-section"> | |
1316 | + <h4 class="method-subtitle">Declared In</h4> | |
1317 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1318 | + </div> | |
1319 | + | |
1320 | + | |
1321 | +</div> | |
1322 | + | |
1323 | + </div> | |
1324 | + | |
1325 | + | |
1326 | + | |
1327 | + <div class="section section-methods"> | |
1328 | + <a title="Class Methods" name="class_methods"></a> | |
1329 | + <h2 class="subtitle subtitle-methods">Class Methods</h2> | |
1330 | + | |
1331 | + <div class="section-method"> | |
1332 | + <a name="//api/name/eventWithIdentifier:date:URL:flags:" title="eventWithIdentifier:date:URL:flags:"></a> | |
1333 | + <h3 class="subsubtitle method-title">eventWithIdentifier:date:URL:flags:</h3> | |
1334 | + | |
1335 | + | |
1336 | + | |
1337 | + <div class="method-subsection brief-description"> | |
1338 | + <p>Returns an <code>CDEvent</code> created with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p> | |
1339 | + </div> | |
1340 | + | |
1341 | + | |
1342 | + <div class="method-subsection method-declaration"><code>+ (CDEvent *)eventWithIdentifier:(NSUInteger)<em>identifier</em> date:(NSDate *)<em>date</em> URL:(NSURL *)<em>URL</em> flags:(CDEventFlags)<em>flags</em></code></div> | |
1343 | + | |
1344 | + | |
1345 | + <div class="method-subsection arguments-section parameters"> | |
1346 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
1347 | + | |
1348 | + <dl class="argument-def parameter-def"> | |
1349 | + <dt><em>identifier</em></dt> | |
1350 | + <dd><p>The <a href="#//api/name/identifier">identifier</a> of the the event.</p></dd> | |
1351 | + </dl> | |
1352 | + | |
1353 | + <dl class="argument-def parameter-def"> | |
1354 | + <dt><em>date</em></dt> | |
1355 | + <dd><p>The <a href="#//api/name/date">date</a> when the event occured.</p></dd> | |
1356 | + </dl> | |
1357 | + | |
1358 | + <dl class="argument-def parameter-def"> | |
1359 | + <dt><em>URL</em></dt> | |
1360 | + <dd><p>The <a href="#//api/name/URL">URL</a> of the item the event concerns.</p></dd> | |
1361 | + </dl> | |
1362 | + | |
1363 | + <dl class="argument-def parameter-def"> | |
1364 | + <dt><em>flags</em></dt> | |
1365 | + <dd><p>The <a href="#//api/name/flags">flags</a> of the event.</p></dd> | |
1366 | + </dl> | |
1367 | + | |
1368 | + </div> | |
1369 | + | |
1370 | + | |
1371 | + | |
1372 | + <div class="method-subsection return"> | |
1373 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1374 | + <p>An <code>CDEvent</code> created with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p> | |
1375 | + </div> | |
1376 | + | |
1377 | + | |
1378 | + | |
1379 | + <div class="method-subsection availability"> | |
1380 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1381 | + <p>1.0.0</p> | |
1382 | + </div> | |
1383 | + | |
1384 | + | |
1385 | + | |
1386 | + <div class="method-subsection discussion-section"> | |
1387 | + <h4 class="method-subtitle">Discussion</h4> | |
1388 | + <p>Returns an <code>CDEvent</code> created with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p> | |
1389 | + </div> | |
1390 | + | |
1391 | + | |
1392 | + | |
1393 | + | |
1394 | + | |
1395 | + <div class="method-subsection see-also-section"> | |
1396 | + <h4 class="method-subtitle">See Also</h4> | |
1397 | + <ul> | |
1398 | + | |
1399 | + <li><code><p><a href="#//api/name/initWithIdentifier:date:URL:flags:">– initWithIdentifier:date:URL:flags:</a></p></code></li> | |
1400 | + | |
1401 | + </ul> | |
1402 | + </div> | |
1403 | + | |
1404 | + | |
1405 | + | |
1406 | + <div class="method-subsection declared-in-section"> | |
1407 | + <h4 class="method-subtitle">Declared In</h4> | |
1408 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1409 | + </div> | |
1410 | + | |
1411 | + | |
1412 | +</div> | |
1413 | + | |
1414 | + </div> | |
1415 | + | |
1416 | + | |
1417 | + | |
1418 | + <div class="section section-methods"> | |
1419 | + <a title="Instance Methods" name="instance_methods"></a> | |
1420 | + <h2 class="subtitle subtitle-methods">Instance Methods</h2> | |
1421 | + | |
1422 | + <div class="section-method"> | |
1423 | + <a name="//api/name/initWithIdentifier:date:URL:flags:" title="initWithIdentifier:date:URL:flags:"></a> | |
1424 | + <h3 class="subsubtitle method-title">initWithIdentifier:date:URL:flags:</h3> | |
1425 | + | |
1426 | + | |
1427 | + | |
1428 | + <div class="method-subsection brief-description"> | |
1429 | + <p>Returns an <code>CDEvent</code> object initialized with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p> | |
1430 | + </div> | |
1431 | + | |
1432 | + | |
1433 | + <div class="method-subsection method-declaration"><code>- (id)initWithIdentifier:(NSUInteger)<em>identifier</em> date:(NSDate *)<em>date</em> URL:(NSURL *)<em>URL</em> flags:(CDEventFlags)<em>flags</em></code></div> | |
1434 | + | |
1435 | + | |
1436 | + <div class="method-subsection arguments-section parameters"> | |
1437 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
1438 | + | |
1439 | + <dl class="argument-def parameter-def"> | |
1440 | + <dt><em>identifier</em></dt> | |
1441 | + <dd><p>The <a href="#//api/name/identifier">identifier</a> of the the event.</p></dd> | |
1442 | + </dl> | |
1443 | + | |
1444 | + <dl class="argument-def parameter-def"> | |
1445 | + <dt><em>date</em></dt> | |
1446 | + <dd><p>The <a href="#//api/name/date">date</a> when the event occured.</p></dd> | |
1447 | + </dl> | |
1448 | + | |
1449 | + <dl class="argument-def parameter-def"> | |
1450 | + <dt><em>URL</em></dt> | |
1451 | + <dd><p>The <a href="#//api/name/URL">URL</a> of the item the event concerns.</p></dd> | |
1452 | + </dl> | |
1453 | + | |
1454 | + <dl class="argument-def parameter-def"> | |
1455 | + <dt><em>flags</em></dt> | |
1456 | + <dd><p>The <a href="#//api/name/flags">flags</a> of the event.</p></dd> | |
1457 | + </dl> | |
1458 | + | |
1459 | + </div> | |
1460 | + | |
1461 | + | |
1462 | + | |
1463 | + <div class="method-subsection return"> | |
1464 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1465 | + <p>An <code>CDEvent</code> object initialized with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p> | |
1466 | + </div> | |
1467 | + | |
1468 | + | |
1469 | + | |
1470 | + <div class="method-subsection availability"> | |
1471 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1472 | + <p>1.0.0</p> | |
1473 | + </div> | |
1474 | + | |
1475 | + | |
1476 | + | |
1477 | + <div class="method-subsection discussion-section"> | |
1478 | + <h4 class="method-subtitle">Discussion</h4> | |
1479 | + <p>Returns an <code>CDEvent</code> object initialized with the given <a href="#//api/name/identifier">identifier</a>, <a href="#//api/name/date">date</a>, <a href="#//api/name/URL">URL</a> and <a href="#//api/name/flags">flags</a>.</p> | |
1480 | + </div> | |
1481 | + | |
1482 | + | |
1483 | + | |
1484 | + | |
1485 | + | |
1486 | + <div class="method-subsection see-also-section"> | |
1487 | + <h4 class="method-subtitle">See Also</h4> | |
1488 | + <ul> | |
1489 | + | |
1490 | + <li><code><p><a href="#//api/name/eventWithIdentifier:date:URL:flags:">+ eventWithIdentifier:date:URL:flags:</a></p></code></li> | |
1491 | + | |
1492 | + </ul> | |
1493 | + </div> | |
1494 | + | |
1495 | + | |
1496 | + | |
1497 | + <div class="method-subsection declared-in-section"> | |
1498 | + <h4 class="method-subtitle">Declared In</h4> | |
1499 | + <code class="declared-in-ref">CDEvent.h</code><br /> | |
1500 | + </div> | |
1501 | + | |
1502 | + | |
1503 | +</div> | |
1504 | + | |
1505 | + </div> | |
1506 | + | |
1507 | + | |
1508 | + </div> | |
1509 | + <div class="main-navigation navigation-bottom"> | |
1510 | + <ul> | |
1511 | + <li><a href="../index.html">Index</a></li> | |
1512 | + <li><a href="../hierarchy.html">Hierarchy</a></li> | |
1513 | +</ul> | |
1514 | + </div> | |
1515 | + <div id="footer"> | |
1516 | + <hr /> | |
1517 | + <div class="footer-copyright"> | |
1518 | + <p><span class="copyright">© 2011 Aron Cedercrantz. All rights reserved. (Last updated: 2011-11-02)</span><br /> | |
1519 | + | |
1520 | + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> | |
1521 | + | |
1522 | + </div> | |
1523 | + </div> | |
1524 | + </div> | |
1525 | + </article> | |
1526 | + <script type="text/javascript"> | |
1527 | + function jumpToChange() | |
1528 | + { | |
1529 | + window.location.hash = this.options[this.selectedIndex].value; | |
1530 | + } | |
1531 | + | |
1532 | + function toggleTOC() | |
1533 | + { | |
1534 | + var contents = document.getElementById('contents'); | |
1535 | + var tocContainer = document.getElementById('tocContainer'); | |
1536 | + | |
1537 | + if (this.getAttribute('class') == 'open') | |
1538 | + { | |
1539 | + this.setAttribute('class', ''); | |
1540 | + contents.setAttribute('class', ''); | |
1541 | + tocContainer.setAttribute('class', ''); | |
1542 | + | |
1543 | + window.name = "hideTOC"; | |
1544 | + } | |
1545 | + else | |
1546 | + { | |
1547 | + this.setAttribute('class', 'open'); | |
1548 | + contents.setAttribute('class', 'isShowingTOC'); | |
1549 | + tocContainer.setAttribute('class', 'isShowingTOC'); | |
1550 | + | |
1551 | + window.name = ""; | |
1552 | + } | |
1553 | + return false; | |
1554 | + } | |
1555 | + | |
1556 | + function toggleTOCEntryChildren(e) | |
1557 | + { | |
1558 | + e.stopPropagation(); | |
1559 | + var currentClass = this.getAttribute('class'); | |
1560 | + if (currentClass == 'children') { | |
1561 | + this.setAttribute('class', 'children open'); | |
1562 | + } | |
1563 | + else if (currentClass == 'children open') { | |
1564 | + this.setAttribute('class', 'children'); | |
1565 | + } | |
1566 | + return false; | |
1567 | + } | |
1568 | + | |
1569 | + function tocEntryClick(e) | |
1570 | + { | |
1571 | + e.stopPropagation(); | |
1572 | + return true; | |
1573 | + } | |
1574 | + | |
1575 | + function init() | |
1576 | + { | |
1577 | + var selectElement = document.getElementById('jumpTo'); | |
1578 | + selectElement.addEventListener('change', jumpToChange, false); | |
1579 | + | |
1580 | + var tocButton = document.getElementById('table_of_contents'); | |
1581 | + tocButton.addEventListener('click', toggleTOC, false); | |
1582 | + | |
1583 | + var taskTreeItem = document.getElementById('task_treeitem'); | |
1584 | + if (taskTreeItem.getElementsByTagName('li').length > 0) | |
1585 | + { | |
1586 | + taskTreeItem.setAttribute('class', 'children'); | |
1587 | + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); | |
1588 | + } | |
1589 | + | |
1590 | + var tocList = document.getElementById('toc'); | |
1591 | + | |
1592 | + var tocEntries = tocList.getElementsByTagName('li'); | |
1593 | + for (var i = 0; i < tocEntries.length; i++) { | |
1594 | + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); | |
1595 | + } | |
1596 | + | |
1597 | + var tocLinks = tocList.getElementsByTagName('a'); | |
1598 | + for (var i = 0; i < tocLinks.length; i++) { | |
1599 | + tocLinks[i].addEventListener('click', tocEntryClick, false); | |
1600 | + } | |
1601 | + | |
1602 | + if (window.name == "hideTOC") { | |
1603 | + toggleTOC.call(tocButton); | |
1604 | + } | |
1605 | + } | |
1606 | + | |
1607 | + window.onload = init; | |
1608 | + </script> | |
1609 | + </body> | |
1610 | +</html> | |
\ No newline at end of file |
@@ -0,0 +1,1391 @@ | ||
1 | +<!DOCTYPE HTML> | |
2 | +<html> | |
3 | + <head> | |
4 | + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> | |
5 | + <title>CDEvents Class Reference</title> | |
6 | + <meta id="xcode-display" name="xcode-display" content="render"/> | |
7 | + <meta name="viewport" content="width=550" /> | |
8 | + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> | |
9 | + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> | |
10 | + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> | |
11 | + </head> | |
12 | + <body> | |
13 | + <header id="top_header"> | |
14 | + <div id="library" class="hideInXcode"> | |
15 | + <h1><a id="libraryTitle" href="../index.html">CDEvents </a></h1> | |
16 | + <a id="developerHome" href="../index.html">Aron Cedercrantz</a> | |
17 | + </div> | |
18 | + | |
19 | + <div id="title" role="banner"> | |
20 | + <h1 class="hideInXcode">CDEvents Class Reference</h1> | |
21 | + </div> | |
22 | + <ul id="headerButtons" role="toolbar"> | |
23 | + <li id="toc_button"> | |
24 | + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> | |
25 | + </li> | |
26 | + <li id="jumpto_button" role="navigation"> | |
27 | + <select id="jumpTo"> | |
28 | + <option value="top">Jump To…</option> | |
29 | + | |
30 | + <option value="overview">Overview</option> | |
31 | + | |
32 | + | |
33 | + | |
34 | + | |
35 | + <option value="tasks">Tasks</option> | |
36 | + | |
37 | + | |
38 | + | |
39 | + | |
40 | + | |
41 | + <option value="properties">Properties</option> | |
42 | + | |
43 | + <option value="//api/name/excludedURLs"> excludedURLs</option> | |
44 | + | |
45 | + <option value="//api/name/id"> id</option> | |
46 | + | |
47 | + <option value="//api/name/ignoreEventsFromSubDirectories"> ignoreEventsFromSubDirectories</option> | |
48 | + | |
49 | + <option value="//api/name/lastEvent"> lastEvent</option> | |
50 | + | |
51 | + <option value="//api/name/notificationLatency"> notificationLatency</option> | |
52 | + | |
53 | + <option value="//api/name/sinceEventIdentifier"> sinceEventIdentifier</option> | |
54 | + | |
55 | + <option value="//api/name/watchedURLs"> watchedURLs</option> | |
56 | + | |
57 | + | |
58 | + | |
59 | + | |
60 | + <option value="class_methods">Class Methods</option> | |
61 | + | |
62 | + <option value="//api/name/currentEventIdentifier"> + currentEventIdentifier</option> | |
63 | + | |
64 | + | |
65 | + | |
66 | + | |
67 | + <option value="instance_methods">Instance Methods</option> | |
68 | + | |
69 | + <option value="//api/name/flushAsynchronously"> - flushAsynchronously</option> | |
70 | + | |
71 | + <option value="//api/name/flushSynchronously"> - flushSynchronously</option> | |
72 | + | |
73 | + <option value="//api/name/initWithURLs:delegate:"> - initWithURLs:delegate:</option> | |
74 | + | |
75 | + <option value="//api/name/initWithURLs:delegate:onRunLoop:"> - initWithURLs:delegate:onRunLoop:</option> | |
76 | + | |
77 | + <option value="//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:"> - initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</option> | |
78 | + | |
79 | + <option value="//api/name/streamDescription"> - streamDescription</option> | |
80 | + | |
81 | + | |
82 | + | |
83 | +</select> | |
84 | + </li> | |
85 | + </ul> | |
86 | + </header> | |
87 | + <nav id="tocContainer" class="isShowingTOC"> | |
88 | + <ul id="toc" role="tree"> | |
89 | + | |
90 | +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> | |
91 | + | |
92 | + | |
93 | + | |
94 | + | |
95 | +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> | |
96 | + | |
97 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Managing the Delegate">Managing the Delegate</a></span></li> | |
98 | + | |
99 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Getting Event Watcher Properties">Getting Event Watcher Properties</a></span></li> | |
100 | + | |
101 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Configuring the Event watcher">Configuring the Event watcher</a></span></li> | |
102 | + | |
103 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Current Event Identifier">Current Event Identifier</a></span></li> | |
104 | + | |
105 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Creating CDEvents Objects">Creating CDEvents Objects</a></span></li> | |
106 | + | |
107 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Flushing Events">Flushing Events</a></span></li> | |
108 | + | |
109 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Events Description">Events Description</a></span></li> | |
110 | + | |
111 | +</ul></li> | |
112 | + | |
113 | + | |
114 | + | |
115 | + | |
116 | + | |
117 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> | |
118 | + | |
119 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/excludedURLs">excludedURLs</a></span></li> | |
120 | + | |
121 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/id">id</a></span></li> | |
122 | + | |
123 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/ignoreEventsFromSubDirectories">ignoreEventsFromSubDirectories</a></span></li> | |
124 | + | |
125 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/lastEvent">lastEvent</a></span></li> | |
126 | + | |
127 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/notificationLatency">notificationLatency</a></span></li> | |
128 | + | |
129 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sinceEventIdentifier">sinceEventIdentifier</a></span></li> | |
130 | + | |
131 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/watchedURLs">watchedURLs</a></span></li> | |
132 | + | |
133 | +</ul></li> | |
134 | + | |
135 | + | |
136 | + | |
137 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> | |
138 | + | |
139 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/currentEventIdentifier">currentEventIdentifier</a></span></li> | |
140 | + | |
141 | +</ul></li> | |
142 | + | |
143 | + | |
144 | + | |
145 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> | |
146 | + | |
147 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/flushAsynchronously">flushAsynchronously</a></span></li> | |
148 | + | |
149 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/flushSynchronously">flushSynchronously</a></span></li> | |
150 | + | |
151 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithURLs:delegate:">initWithURLs:delegate:</a></span></li> | |
152 | + | |
153 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithURLs:delegate:onRunLoop:">initWithURLs:delegate:onRunLoop:</a></span></li> | |
154 | + | |
155 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:">initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</a></span></li> | |
156 | + | |
157 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/streamDescription">streamDescription</a></span></li> | |
158 | + | |
159 | +</ul></li> | |
160 | + | |
161 | + | |
162 | + </ul> | |
163 | + </nav> | |
164 | + <article> | |
165 | + <div id="contents" class="isShowingTOC" role="main"> | |
166 | + <a title="CDEvents Class Reference" name="top"></a> | |
167 | + <div class="main-navigation navigation-top"> | |
168 | + <ul> | |
169 | + <li><a href="../index.html">Index</a></li> | |
170 | + <li><a href="../hierarchy.html">Hierarchy</a></li> | |
171 | +</ul> | |
172 | + </div> | |
173 | + <div id="header"> | |
174 | + <div class="section-header"> | |
175 | + <h1 class="title title-header">CDEvents Class Reference</h1> | |
176 | + </div> | |
177 | + </div> | |
178 | + <div id="container"> | |
179 | + | |
180 | + <div class="section section-specification"><table cellspacing="0"><tbody> | |
181 | + <tr> | |
182 | + <td class="specification-title">Inherits from</td> | |
183 | + <td class="specification-value">NSObject</td> | |
184 | +</tr><tr> | |
185 | + <td class="specification-title">Conforms to</td> | |
186 | + <td class="specification-value">NSCopying</td> | |
187 | +</tr><tr> | |
188 | + <td class="specification-title">Declared in</td> | |
189 | + <td class="specification-value">CDEvents.h</td> | |
190 | +</tr> | |
191 | + </tbody></table></div> | |
192 | + | |
193 | + | |
194 | + | |
195 | + | |
196 | + <div class="section section-overview"> | |
197 | + <a title="Overview" name="overview"></a> | |
198 | + <h2 class="subtitle subtitle-overview">Overview</h2> | |
199 | + <p>An Objective-C wrapper for the <code>FSEvents</code> C API.</p> | |
200 | + | |
201 | +<p>@note Inpired by <code>SCEvents</code> class of the <code>SCEvents</code> project by Stuart Connolly.</p> | |
202 | + </div> | |
203 | + | |
204 | + | |
205 | + | |
206 | + | |
207 | + | |
208 | + <div class="section section-tasks"> | |
209 | + <a title="Tasks" name="tasks"></a> | |
210 | + <h2 class="subtitle subtitle-tasks">Tasks</h2> | |
211 | + | |
212 | + | |
213 | + <a title="Managing the Delegate" name="task_Managing the Delegate"></a> | |
214 | + <h3 class="subsubtitle task-title">Managing the Delegate</h3> | |
215 | + | |
216 | + <ul class="task-list"> | |
217 | + <li> | |
218 | + <span class="tooltip"> | |
219 | + <code><a href="#//api/name/id"> id</a></code> | |
220 | + <span class="tooltip"><p>The delegate object the <code>CDEvents</code> object calls when it recieves an event.</p></span> | |
221 | + </span> | |
222 | + <span class="task-item-suffix">property</span> | |
223 | + | |
224 | +</li> | |
225 | + </ul> | |
226 | + | |
227 | + | |
228 | + <a title="Getting Event Watcher Properties" name="task_Getting Event Watcher Properties"></a> | |
229 | + <h3 class="subsubtitle task-title">Getting Event Watcher Properties</h3> | |
230 | + | |
231 | + <ul class="task-list"> | |
232 | + <li> | |
233 | + <span class="tooltip"> | |
234 | + <code><a href="#//api/name/notificationLatency"> notificationLatency</a></code> | |
235 | + <span class="tooltip"><p>The (approximate) time intervall between notifications sent to the delegate.</p></span> | |
236 | + </span> | |
237 | + <span class="task-item-suffix">property</span> | |
238 | + | |
239 | +</li><li> | |
240 | + <span class="tooltip"> | |
241 | + <code><a href="#//api/name/sinceEventIdentifier"> sinceEventIdentifier</a></code> | |
242 | + <span class="tooltip"><p>The event identifier from which events will be supplied to the delegate.</p></span> | |
243 | + </span> | |
244 | + <span class="task-item-suffix">property</span> | |
245 | + | |
246 | +</li><li> | |
247 | + <span class="tooltip"> | |
248 | + <code><a href="#//api/name/lastEvent"> lastEvent</a></code> | |
249 | + <span class="tooltip"><p>The last event that occured and thas has been delivered to the delegate.</p></span> | |
250 | + </span> | |
251 | + <span class="task-item-suffix">property</span> | |
252 | + | |
253 | +</li><li> | |
254 | + <span class="tooltip"> | |
255 | + <code><a href="#//api/name/watchedURLs"> watchedURLs</a></code> | |
256 | + <span class="tooltip"><p>The URLs that we watch for events.</p></span> | |
257 | + </span> | |
258 | + <span class="task-item-suffix">property</span> | |
259 | + | |
260 | +</li> | |
261 | + </ul> | |
262 | + | |
263 | + | |
264 | + <a title="Configuring the Event watcher" name="task_Configuring the Event watcher"></a> | |
265 | + <h3 class="subsubtitle task-title">Configuring the Event watcher</h3> | |
266 | + | |
267 | + <ul class="task-list"> | |
268 | + <li> | |
269 | + <span class="tooltip"> | |
270 | + <code><a href="#//api/name/excludedURLs"> excludedURLs</a></code> | |
271 | + <span class="tooltip"><p>The URLs that we should ignore events from.</p></span> | |
272 | + </span> | |
273 | + <span class="task-item-suffix">property</span> | |
274 | + | |
275 | +</li><li> | |
276 | + <span class="tooltip"> | |
277 | + <code><a href="#//api/name/ignoreEventsFromSubDirectories"> ignoreEventsFromSubDirectories</a></code> | |
278 | + <span class="tooltip"><p>Wheter events from sub-directories of the watched URLs should be ignored or not.</p></span> | |
279 | + </span> | |
280 | + <span class="task-item-suffix">property</span> | |
281 | + | |
282 | +</li> | |
283 | + </ul> | |
284 | + | |
285 | + | |
286 | + <a title="Current Event Identifier" name="task_Current Event Identifier"></a> | |
287 | + <h3 class="subsubtitle task-title">Current Event Identifier</h3> | |
288 | + | |
289 | + <ul class="task-list"> | |
290 | + <li> | |
291 | + <span class="tooltip"> | |
292 | + <code><a href="#//api/name/currentEventIdentifier">+ currentEventIdentifier</a></code> | |
293 | + <span class="tooltip"><p>The current event identifier.</p></span> | |
294 | + </span> | |
295 | + | |
296 | + | |
297 | +</li> | |
298 | + </ul> | |
299 | + | |
300 | + | |
301 | + <a title="Creating CDEvents Objects" name="task_Creating CDEvents Objects"></a> | |
302 | + <h3 class="subsubtitle task-title">Creating CDEvents Objects</h3> | |
303 | + | |
304 | + <ul class="task-list"> | |
305 | + <li> | |
306 | + <span class="tooltip"> | |
307 | + <code><a href="#//api/name/initWithURLs:delegate:">– initWithURLs:delegate:</a></code> | |
308 | + <span class="tooltip"><p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch.</p></span> | |
309 | + </span> | |
310 | + | |
311 | + | |
312 | +</li><li> | |
313 | + <span class="tooltip"> | |
314 | + <code><a href="#//api/name/initWithURLs:delegate:onRunLoop:">– initWithURLs:delegate:onRunLoop:</a></code> | |
315 | + <span class="tooltip"><p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch and schedules the watcher on the given run loop.</p></span> | |
316 | + </span> | |
317 | + | |
318 | + | |
319 | +</li><li> | |
320 | + <span class="tooltip"> | |
321 | + <code><a href="#//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:">– initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</a></code> | |
322 | + <span class="tooltip"><p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch, URLs to exclude, wheter events from sub-directories are ignored or not and schedules the watcher on the given run loop.</p></span> | |
323 | + </span> | |
324 | + | |
325 | + | |
326 | +</li> | |
327 | + </ul> | |
328 | + | |
329 | + | |
330 | + <a title="Flushing Events" name="task_Flushing Events"></a> | |
331 | + <h3 class="subsubtitle task-title">Flushing Events</h3> | |
332 | + | |
333 | + <ul class="task-list"> | |
334 | + <li> | |
335 | + <span class="tooltip"> | |
336 | + <code><a href="#//api/name/flushSynchronously">– flushSynchronously</a></code> | |
337 | + <span class="tooltip"><p>Flushes the event stream synchronously.</p></span> | |
338 | + </span> | |
339 | + | |
340 | + | |
341 | +</li><li> | |
342 | + <span class="tooltip"> | |
343 | + <code><a href="#//api/name/flushAsynchronously">– flushAsynchronously</a></code> | |
344 | + <span class="tooltip"><p>Flushes the event stream asynchronously.</p></span> | |
345 | + </span> | |
346 | + | |
347 | + | |
348 | +</li> | |
349 | + </ul> | |
350 | + | |
351 | + | |
352 | + <a title="Events Description" name="task_Events Description"></a> | |
353 | + <h3 class="subsubtitle task-title">Events Description</h3> | |
354 | + | |
355 | + <ul class="task-list"> | |
356 | + <li> | |
357 | + <span class="tooltip"> | |
358 | + <code><a href="#//api/name/streamDescription">– streamDescription</a></code> | |
359 | + <span class="tooltip"><p>Returns a NSString containing the description of the current event stream.</p></span> | |
360 | + </span> | |
361 | + | |
362 | + | |
363 | +</li> | |
364 | + </ul> | |
365 | + | |
366 | + </div> | |
367 | + | |
368 | + | |
369 | + | |
370 | + | |
371 | + | |
372 | + <div class="section section-methods"> | |
373 | + <a title="Properties" name="properties"></a> | |
374 | + <h2 class="subtitle subtitle-methods">Properties</h2> | |
375 | + | |
376 | + <div class="section-method"> | |
377 | + <a name="//api/name/excludedURLs" title="excludedURLs"></a> | |
378 | + <h3 class="subsubtitle method-title">excludedURLs</h3> | |
379 | + | |
380 | + | |
381 | + | |
382 | + <div class="method-subsection brief-description"> | |
383 | + <p>The URLs that we should ignore events from.</p> | |
384 | + </div> | |
385 | + | |
386 | + | |
387 | + <div class="method-subsection method-declaration"><code>@property (copy) NSArray *excludedURLs</code></div> | |
388 | + | |
389 | + | |
390 | + | |
391 | + | |
392 | + <div class="method-subsection return"> | |
393 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
394 | + <p>An array of <code>NSURL</code> object for the URLs which we want to ignore. | |
395 | +@discussion Events from concerning these URLs and there sub-directories will not be delivered to the delegate.</p> | |
396 | + </div> | |
397 | + | |
398 | + | |
399 | + | |
400 | + <div class="method-subsection availability"> | |
401 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
402 | + <p>1.0.0</p> | |
403 | + </div> | |
404 | + | |
405 | + | |
406 | + | |
407 | + <div class="method-subsection discussion-section"> | |
408 | + <h4 class="method-subtitle">Discussion</h4> | |
409 | + <p>The URLs that we should ignore events from.</p> | |
410 | + </div> | |
411 | + | |
412 | + | |
413 | + | |
414 | + | |
415 | + | |
416 | + | |
417 | + | |
418 | + <div class="method-subsection declared-in-section"> | |
419 | + <h4 class="method-subtitle">Declared In</h4> | |
420 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
421 | + </div> | |
422 | + | |
423 | + | |
424 | +</div> | |
425 | + | |
426 | + <div class="section-method"> | |
427 | + <a name="//api/name/id" title="id"></a> | |
428 | + <h3 class="subsubtitle method-title">id</h3> | |
429 | + | |
430 | + | |
431 | + | |
432 | + <div class="method-subsection brief-description"> | |
433 | + <p>The delegate object the <code>CDEvents</code> object calls when it recieves an event.</p> | |
434 | + </div> | |
435 | + | |
436 | + | |
437 | + <div class="method-subsection method-declaration"><code>@property (assign) __weak id</code></div> | |
438 | + | |
439 | + | |
440 | + <div class="method-subsection arguments-section parameters"> | |
441 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
442 | + | |
443 | + <dl class="argument-def parameter-def"> | |
444 | + <dt><em>delegate</em></dt> | |
445 | + <dd><p>Delegate for the events object. <code>nil</code> removes the delegate.</p></dd> | |
446 | + </dl> | |
447 | + | |
448 | + </div> | |
449 | + | |
450 | + | |
451 | + | |
452 | + <div class="method-subsection return"> | |
453 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
454 | + <p>The events’s delegate.</p> | |
455 | + </div> | |
456 | + | |
457 | + | |
458 | + | |
459 | + <div class="method-subsection availability"> | |
460 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
461 | + <p>1.0.0</p> | |
462 | + </div> | |
463 | + | |
464 | + | |
465 | + | |
466 | + <div class="method-subsection discussion-section"> | |
467 | + <h4 class="method-subtitle">Discussion</h4> | |
468 | + <p>The delegate object the <code>CDEvents</code> object calls when it recieves an event.</p> | |
469 | + </div> | |
470 | + | |
471 | + | |
472 | + | |
473 | + | |
474 | + | |
475 | + <div class="method-subsection see-also-section"> | |
476 | + <h4 class="method-subtitle">See Also</h4> | |
477 | + <ul> | |
478 | + | |
479 | + <li><code><p><a href="../Protocols/CDEventsDelegate.html">CDEventsDelegate</a></p></code></li> | |
480 | + | |
481 | + </ul> | |
482 | + </div> | |
483 | + | |
484 | + | |
485 | + | |
486 | + <div class="method-subsection declared-in-section"> | |
487 | + <h4 class="method-subtitle">Declared In</h4> | |
488 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
489 | + </div> | |
490 | + | |
491 | + | |
492 | +</div> | |
493 | + | |
494 | + <div class="section-method"> | |
495 | + <a name="//api/name/ignoreEventsFromSubDirectories" title="ignoreEventsFromSubDirectories"></a> | |
496 | + <h3 class="subsubtitle method-title">ignoreEventsFromSubDirectories</h3> | |
497 | + | |
498 | + | |
499 | + | |
500 | + <div class="method-subsection brief-description"> | |
501 | + <p>Wheter events from sub-directories of the watched URLs should be ignored or not.</p> | |
502 | + </div> | |
503 | + | |
504 | + | |
505 | + <div class="method-subsection method-declaration"><code>@property (assign) BOOL ignoreEventsFromSubDirectories</code></div> | |
506 | + | |
507 | + | |
508 | + <div class="method-subsection arguments-section parameters"> | |
509 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
510 | + | |
511 | + <dl class="argument-def parameter-def"> | |
512 | + <dt><em>flag</em></dt> | |
513 | + <dd><p>Wheter events from sub-directories of the watched URLs shouled be ignored or not.</p></dd> | |
514 | + </dl> | |
515 | + | |
516 | + </div> | |
517 | + | |
518 | + | |
519 | + | |
520 | + <div class="method-subsection return"> | |
521 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
522 | + <p><code>YES</code> if events from sub-directories should be ignored, otherwise <code>NO</code>.</p> | |
523 | + </div> | |
524 | + | |
525 | + | |
526 | + | |
527 | + <div class="method-subsection availability"> | |
528 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
529 | + <p>1.0.0</p> | |
530 | + </div> | |
531 | + | |
532 | + | |
533 | + | |
534 | + <div class="method-subsection discussion-section"> | |
535 | + <h4 class="method-subtitle">Discussion</h4> | |
536 | + <p>Wheter events from sub-directories of the watched URLs should be ignored or not.</p> | |
537 | + </div> | |
538 | + | |
539 | + | |
540 | + | |
541 | + | |
542 | + | |
543 | + | |
544 | + | |
545 | + <div class="method-subsection declared-in-section"> | |
546 | + <h4 class="method-subtitle">Declared In</h4> | |
547 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
548 | + </div> | |
549 | + | |
550 | + | |
551 | +</div> | |
552 | + | |
553 | + <div class="section-method"> | |
554 | + <a name="//api/name/lastEvent" title="lastEvent"></a> | |
555 | + <h3 class="subsubtitle method-title">lastEvent</h3> | |
556 | + | |
557 | + | |
558 | + | |
559 | + <div class="method-subsection brief-description"> | |
560 | + <p>The last event that occured and thas has been delivered to the delegate.</p> | |
561 | + </div> | |
562 | + | |
563 | + | |
564 | + <div class="method-subsection method-declaration"><code>@property (retain, readonly) CDEvent *lastEvent</code></div> | |
565 | + | |
566 | + | |
567 | + | |
568 | + | |
569 | + <div class="method-subsection return"> | |
570 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
571 | + <p>The last event that occured and thas has been delivered to the delegate.</p> | |
572 | + </div> | |
573 | + | |
574 | + | |
575 | + | |
576 | + <div class="method-subsection availability"> | |
577 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
578 | + <p>1.0.0</p> | |
579 | + </div> | |
580 | + | |
581 | + | |
582 | + | |
583 | + <div class="method-subsection discussion-section"> | |
584 | + <h4 class="method-subtitle">Discussion</h4> | |
585 | + <p>The last event that occured and thas has been delivered to the delegate.</p> | |
586 | + </div> | |
587 | + | |
588 | + | |
589 | + | |
590 | + | |
591 | + | |
592 | + | |
593 | + | |
594 | + <div class="method-subsection declared-in-section"> | |
595 | + <h4 class="method-subtitle">Declared In</h4> | |
596 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
597 | + </div> | |
598 | + | |
599 | + | |
600 | +</div> | |
601 | + | |
602 | + <div class="section-method"> | |
603 | + <a name="//api/name/notificationLatency" title="notificationLatency"></a> | |
604 | + <h3 class="subsubtitle method-title">notificationLatency</h3> | |
605 | + | |
606 | + | |
607 | + | |
608 | + <div class="method-subsection brief-description"> | |
609 | + <p>The (approximate) time intervall between notifications sent to the delegate.</p> | |
610 | + </div> | |
611 | + | |
612 | + | |
613 | + <div class="method-subsection method-declaration"><code>@property (readonly) CFTimeInterval notificationLatency</code></div> | |
614 | + | |
615 | + | |
616 | + | |
617 | + | |
618 | + <div class="method-subsection return"> | |
619 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
620 | + <p>The time intervall between notifications.</p> | |
621 | + </div> | |
622 | + | |
623 | + | |
624 | + | |
625 | + <div class="method-subsection availability"> | |
626 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
627 | + <p>1.0.0</p> | |
628 | + </div> | |
629 | + | |
630 | + | |
631 | + | |
632 | + <div class="method-subsection discussion-section"> | |
633 | + <h4 class="method-subtitle">Discussion</h4> | |
634 | + <p>The (approximate) time intervall between notifications sent to the delegate.</p> | |
635 | + </div> | |
636 | + | |
637 | + | |
638 | + | |
639 | + | |
640 | + | |
641 | + | |
642 | + | |
643 | + <div class="method-subsection declared-in-section"> | |
644 | + <h4 class="method-subtitle">Declared In</h4> | |
645 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
646 | + </div> | |
647 | + | |
648 | + | |
649 | +</div> | |
650 | + | |
651 | + <div class="section-method"> | |
652 | + <a name="//api/name/sinceEventIdentifier" title="sinceEventIdentifier"></a> | |
653 | + <h3 class="subsubtitle method-title">sinceEventIdentifier</h3> | |
654 | + | |
655 | + | |
656 | + | |
657 | + <div class="method-subsection brief-description"> | |
658 | + <p>The event identifier from which events will be supplied to the delegate.</p> | |
659 | + </div> | |
660 | + | |
661 | + | |
662 | + <div class="method-subsection method-declaration"><code>@property (readonly) CDEventIdentifier sinceEventIdentifier</code></div> | |
663 | + | |
664 | + | |
665 | + | |
666 | + | |
667 | + <div class="method-subsection return"> | |
668 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
669 | + <p>The event identifier from which events will be supplied to the delegate.</p> | |
670 | + </div> | |
671 | + | |
672 | + | |
673 | + | |
674 | + <div class="method-subsection availability"> | |
675 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
676 | + <p>1.0.0</p> | |
677 | + </div> | |
678 | + | |
679 | + | |
680 | + | |
681 | + <div class="method-subsection discussion-section"> | |
682 | + <h4 class="method-subtitle">Discussion</h4> | |
683 | + <p>The event identifier from which events will be supplied to the delegate.</p> | |
684 | + </div> | |
685 | + | |
686 | + | |
687 | + | |
688 | + | |
689 | + | |
690 | + | |
691 | + | |
692 | + <div class="method-subsection declared-in-section"> | |
693 | + <h4 class="method-subtitle">Declared In</h4> | |
694 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
695 | + </div> | |
696 | + | |
697 | + | |
698 | +</div> | |
699 | + | |
700 | + <div class="section-method"> | |
701 | + <a name="//api/name/watchedURLs" title="watchedURLs"></a> | |
702 | + <h3 class="subsubtitle method-title">watchedURLs</h3> | |
703 | + | |
704 | + | |
705 | + | |
706 | + <div class="method-subsection brief-description"> | |
707 | + <p>The URLs that we watch for events.</p> | |
708 | + </div> | |
709 | + | |
710 | + | |
711 | + <div class="method-subsection method-declaration"><code>@property (readonly) NSArray *watchedURLs</code></div> | |
712 | + | |
713 | + | |
714 | + | |
715 | + | |
716 | + <div class="method-subsection return"> | |
717 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
718 | + <p>An array of <code>NSURL</code> object for the URLs which we watch for events.</p> | |
719 | + </div> | |
720 | + | |
721 | + | |
722 | + | |
723 | + <div class="method-subsection availability"> | |
724 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
725 | + <p>1.0.0</p> | |
726 | + </div> | |
727 | + | |
728 | + | |
729 | + | |
730 | + <div class="method-subsection discussion-section"> | |
731 | + <h4 class="method-subtitle">Discussion</h4> | |
732 | + <p>The URLs that we watch for events.</p> | |
733 | + </div> | |
734 | + | |
735 | + | |
736 | + | |
737 | + | |
738 | + | |
739 | + | |
740 | + | |
741 | + <div class="method-subsection declared-in-section"> | |
742 | + <h4 class="method-subtitle">Declared In</h4> | |
743 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
744 | + </div> | |
745 | + | |
746 | + | |
747 | +</div> | |
748 | + | |
749 | + </div> | |
750 | + | |
751 | + | |
752 | + | |
753 | + <div class="section section-methods"> | |
754 | + <a title="Class Methods" name="class_methods"></a> | |
755 | + <h2 class="subtitle subtitle-methods">Class Methods</h2> | |
756 | + | |
757 | + <div class="section-method"> | |
758 | + <a name="//api/name/currentEventIdentifier" title="currentEventIdentifier"></a> | |
759 | + <h3 class="subsubtitle method-title">currentEventIdentifier</h3> | |
760 | + | |
761 | + | |
762 | + | |
763 | + <div class="method-subsection brief-description"> | |
764 | + <p>The current event identifier.</p> | |
765 | + </div> | |
766 | + | |
767 | + | |
768 | + <div class="method-subsection method-declaration"><code>+ (CDEventIdentifier)currentEventIdentifier</code></div> | |
769 | + | |
770 | + | |
771 | + | |
772 | + | |
773 | + <div class="method-subsection return"> | |
774 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
775 | + <p>The current event identifier.</p> | |
776 | + </div> | |
777 | + | |
778 | + | |
779 | + | |
780 | + <div class="method-subsection availability"> | |
781 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
782 | + <p>1.0.0</p> | |
783 | + </div> | |
784 | + | |
785 | + | |
786 | + | |
787 | + <div class="method-subsection discussion-section"> | |
788 | + <h4 class="method-subtitle">Discussion</h4> | |
789 | + <p>The current event identifier.</p> | |
790 | + </div> | |
791 | + | |
792 | + | |
793 | + | |
794 | + | |
795 | + | |
796 | + <div class="method-subsection see-also-section"> | |
797 | + <h4 class="method-subtitle">See Also</h4> | |
798 | + <ul> | |
799 | + | |
800 | + <li><code><p>FSEventsGetCurrentEventId(vo<a href="#//api/name/id">@property id</a>)</p></code></li> | |
801 | + | |
802 | + </ul> | |
803 | + </div> | |
804 | + | |
805 | + | |
806 | + | |
807 | + <div class="method-subsection declared-in-section"> | |
808 | + <h4 class="method-subtitle">Declared In</h4> | |
809 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
810 | + </div> | |
811 | + | |
812 | + | |
813 | +</div> | |
814 | + | |
815 | + </div> | |
816 | + | |
817 | + | |
818 | + | |
819 | + <div class="section section-methods"> | |
820 | + <a title="Instance Methods" name="instance_methods"></a> | |
821 | + <h2 class="subtitle subtitle-methods">Instance Methods</h2> | |
822 | + | |
823 | + <div class="section-method"> | |
824 | + <a name="//api/name/flushAsynchronously" title="flushAsynchronously"></a> | |
825 | + <h3 class="subsubtitle method-title">flushAsynchronously</h3> | |
826 | + | |
827 | + | |
828 | + | |
829 | + <div class="method-subsection brief-description"> | |
830 | + <p>Flushes the event stream asynchronously.</p> | |
831 | + </div> | |
832 | + | |
833 | + | |
834 | + <div class="method-subsection method-declaration"><code>- (void)flushAsynchronously</code></div> | |
835 | + | |
836 | + | |
837 | + | |
838 | + | |
839 | + | |
840 | + | |
841 | + <div class="method-subsection availability"> | |
842 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
843 | + <p>1.0.0</p> | |
844 | + </div> | |
845 | + | |
846 | + | |
847 | + | |
848 | + <div class="method-subsection discussion-section"> | |
849 | + <h4 class="method-subtitle">Discussion</h4> | |
850 | + <p>Flushes the event stream asynchronously.</p> | |
851 | + | |
852 | +<p>Flushes the event stream asynchronously by sending events that have already occurred but not yet delivered.</p> | |
853 | + </div> | |
854 | + | |
855 | + | |
856 | + | |
857 | + | |
858 | + | |
859 | + <div class="method-subsection see-also-section"> | |
860 | + <h4 class="method-subtitle">See Also</h4> | |
861 | + <ul> | |
862 | + | |
863 | + <li><code><p><a href="#//api/name/flushSynchronously">– flushSynchronously</a></p></code></li> | |
864 | + | |
865 | + </ul> | |
866 | + </div> | |
867 | + | |
868 | + | |
869 | + | |
870 | + <div class="method-subsection declared-in-section"> | |
871 | + <h4 class="method-subtitle">Declared In</h4> | |
872 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
873 | + </div> | |
874 | + | |
875 | + | |
876 | +</div> | |
877 | + | |
878 | + <div class="section-method"> | |
879 | + <a name="//api/name/flushSynchronously" title="flushSynchronously"></a> | |
880 | + <h3 class="subsubtitle method-title">flushSynchronously</h3> | |
881 | + | |
882 | + | |
883 | + | |
884 | + <div class="method-subsection brief-description"> | |
885 | + <p>Flushes the event stream synchronously.</p> | |
886 | + </div> | |
887 | + | |
888 | + | |
889 | + <div class="method-subsection method-declaration"><code>- (void)flushSynchronously</code></div> | |
890 | + | |
891 | + | |
892 | + | |
893 | + | |
894 | + | |
895 | + | |
896 | + <div class="method-subsection availability"> | |
897 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
898 | + <p>1.0.0</p> | |
899 | + </div> | |
900 | + | |
901 | + | |
902 | + | |
903 | + <div class="method-subsection discussion-section"> | |
904 | + <h4 class="method-subtitle">Discussion</h4> | |
905 | + <p>Flushes the event stream synchronously.</p> | |
906 | + | |
907 | +<p>Flushes the event stream synchronously by sending events that have already occurred but not yet delivered.</p> | |
908 | + </div> | |
909 | + | |
910 | + | |
911 | + | |
912 | + | |
913 | + | |
914 | + <div class="method-subsection see-also-section"> | |
915 | + <h4 class="method-subtitle">See Also</h4> | |
916 | + <ul> | |
917 | + | |
918 | + <li><code><p><a href="#//api/name/flushAsynchronously">– flushAsynchronously</a></p></code></li> | |
919 | + | |
920 | + </ul> | |
921 | + </div> | |
922 | + | |
923 | + | |
924 | + | |
925 | + <div class="method-subsection declared-in-section"> | |
926 | + <h4 class="method-subtitle">Declared In</h4> | |
927 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
928 | + </div> | |
929 | + | |
930 | + | |
931 | +</div> | |
932 | + | |
933 | + <div class="section-method"> | |
934 | + <a name="//api/name/initWithURLs:delegate:" title="initWithURLs:delegate:"></a> | |
935 | + <h3 class="subsubtitle method-title">initWithURLs:delegate:</h3> | |
936 | + | |
937 | + | |
938 | + | |
939 | + <div class="method-subsection brief-description"> | |
940 | + <p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch.</p> | |
941 | + </div> | |
942 | + | |
943 | + | |
944 | + <div class="method-subsection method-declaration"><code>- (id)initWithURLs:(NSArray *)<em>URLs</em> delegate:(id<CDEventsDelegate>)<em>delegate</em></code></div> | |
945 | + | |
946 | + | |
947 | + <div class="method-subsection arguments-section parameters"> | |
948 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
949 | + | |
950 | + <dl class="argument-def parameter-def"> | |
951 | + <dt><em>URLs</em></dt> | |
952 | + <dd><p>An array of URLs we want to watch.</p></dd> | |
953 | + </dl> | |
954 | + | |
955 | + <dl class="argument-def parameter-def"> | |
956 | + <dt><em>delegate</em></dt> | |
957 | + <dd><p>The delegate object the <a href="CDEvents.html">CDEvents</a> object calls when it recieves an event.</p></dd> | |
958 | + </dl> | |
959 | + | |
960 | + </div> | |
961 | + | |
962 | + | |
963 | + | |
964 | + <div class="method-subsection return"> | |
965 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
966 | + <p>An <a href="CDEvents.html">CDEvents</a> object initialized with the given URLs to watch. | |
967 | +@throws NSInvalidArgumentException if <em>URLs</em> is empty or points to <code>nil</code>. | |
968 | +@throws NSInvalidArgumentException if <em>delegate</em>is <code>nil</code>. | |
969 | +@throws CDEventsEventStreamCreationFailureException if we failed to create a event stream.</p> | |
970 | + </div> | |
971 | + | |
972 | + | |
973 | + | |
974 | + <div class="method-subsection availability"> | |
975 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
976 | + <p>1.0.0</p> | |
977 | + </div> | |
978 | + | |
979 | + | |
980 | + | |
981 | + <div class="method-subsection discussion-section"> | |
982 | + <h4 class="method-subtitle">Discussion</h4> | |
983 | + <p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch.</p> | |
984 | + </div> | |
985 | + | |
986 | + | |
987 | + | |
988 | + | |
989 | + | |
990 | + <div class="method-subsection see-also-section"> | |
991 | + <h4 class="method-subtitle">See Also</h4> | |
992 | + <ul> | |
993 | + | |
994 | + <li><code><p><a href="#//api/name/initWithURLs:delegate:onRunLoop:">– initWithURLs:delegate:onRunLoop:</a></p></code></li> | |
995 | + | |
996 | + <li><code><p><a href="#//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:">– initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</a></p></code></li> | |
997 | + | |
998 | + <li><code><p><a href="../Protocols/CDEventsDelegate.html">CDEventsDelegate</a></p></code></li> | |
999 | + | |
1000 | + <li><code><p>kCDEventsSinceEventNow</p> | |
1001 | + | |
1002 | +<p>@discussion Calls <a href="#//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:">– initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</a> | |
1003 | +with <code>sinceEventIdentifier</code> with the event identifier for “event | |
1004 | +since now”, <code>notificationLatency</code> set to 3.0 seconds, | |
1005 | +<code>ignoreEventsFromSubDirectories</code> set to <code>NO</code>, | |
1006 | +<code>excludedURLs</code> to <code>nil</code>, the event stream creation | |
1007 | +flags will be set to <code>kCDEventsDefaultEventStreamFlags</code> and | |
1008 | +schedueled on the current run loop.</p></code></li> | |
1009 | + | |
1010 | + </ul> | |
1011 | + </div> | |
1012 | + | |
1013 | + | |
1014 | + | |
1015 | + <div class="method-subsection declared-in-section"> | |
1016 | + <h4 class="method-subtitle">Declared In</h4> | |
1017 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
1018 | + </div> | |
1019 | + | |
1020 | + | |
1021 | +</div> | |
1022 | + | |
1023 | + <div class="section-method"> | |
1024 | + <a name="//api/name/initWithURLs:delegate:onRunLoop:" title="initWithURLs:delegate:onRunLoop:"></a> | |
1025 | + <h3 class="subsubtitle method-title">initWithURLs:delegate:onRunLoop:</h3> | |
1026 | + | |
1027 | + | |
1028 | + | |
1029 | + <div class="method-subsection brief-description"> | |
1030 | + <p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch and schedules the watcher on the given run loop.</p> | |
1031 | + </div> | |
1032 | + | |
1033 | + | |
1034 | + <div class="method-subsection method-declaration"><code>- (id)initWithURLs:(NSArray *)<em>URLs</em> delegate:(id<CDEventsDelegate>)<em>delegate</em> onRunLoop:(NSRunLoop *)<em>runLoop</em></code></div> | |
1035 | + | |
1036 | + | |
1037 | + <div class="method-subsection arguments-section parameters"> | |
1038 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
1039 | + | |
1040 | + <dl class="argument-def parameter-def"> | |
1041 | + <dt><em>URLs</em></dt> | |
1042 | + <dd><p>An array of URLs we want to watch.</p></dd> | |
1043 | + </dl> | |
1044 | + | |
1045 | + <dl class="argument-def parameter-def"> | |
1046 | + <dt><em>delegate</em></dt> | |
1047 | + <dd><p>The delegate object the <a href="CDEvents.html">CDEvents</a> object calls when it recieves an event.</p></dd> | |
1048 | + </dl> | |
1049 | + | |
1050 | + <dl class="argument-def parameter-def"> | |
1051 | + <dt><em>runLoop</em></dt> | |
1052 | + <dd><p>The run loop which the which the watcher should be schedueled on.</p></dd> | |
1053 | + </dl> | |
1054 | + | |
1055 | + </div> | |
1056 | + | |
1057 | + | |
1058 | + | |
1059 | + <div class="method-subsection return"> | |
1060 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1061 | + <p>An <a href="CDEvents.html">CDEvents</a> object initialized with the given URLs to watch. | |
1062 | +@throws NSInvalidArgumentException if <em>URLs</em> is empty or points to <code>nil</code>. | |
1063 | +@throws NSInvalidArgumentException if <em>delegate</em>is <code>nil</code>. | |
1064 | +@throws CDEventsEventStreamCreationFailureException if we failed to create a event stream.</p> | |
1065 | + </div> | |
1066 | + | |
1067 | + | |
1068 | + | |
1069 | + <div class="method-subsection availability"> | |
1070 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1071 | + <p>1.0.0</p> | |
1072 | + </div> | |
1073 | + | |
1074 | + | |
1075 | + | |
1076 | + <div class="method-subsection discussion-section"> | |
1077 | + <h4 class="method-subtitle">Discussion</h4> | |
1078 | + <p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch and schedules the watcher on the given run loop.</p> | |
1079 | + </div> | |
1080 | + | |
1081 | + | |
1082 | + | |
1083 | + | |
1084 | + | |
1085 | + <div class="method-subsection see-also-section"> | |
1086 | + <h4 class="method-subtitle">See Also</h4> | |
1087 | + <ul> | |
1088 | + | |
1089 | + <li><code><p><a href="#//api/name/initWithURLs:delegate:">– initWithURLs:delegate:</a></p></code></li> | |
1090 | + | |
1091 | + <li><code><p><a href="#//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:">– initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</a></p></code></li> | |
1092 | + | |
1093 | + <li><code><p><a href="../Protocols/CDEventsDelegate.html">CDEventsDelegate</a></p></code></li> | |
1094 | + | |
1095 | + <li><code><p>kCDEventsSinceEventNow</p> | |
1096 | + | |
1097 | +<p>@discussion Calls <a href="#//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:">– initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</a> | |
1098 | +with <code>sinceEventIdentifier</code> with the event identifier for “event | |
1099 | +since now”, <code>notificationLatency</code> set to 3.0 seconds, | |
1100 | +<code>ignoreEventsFromSubDirectories</code> set to <code>NO</code>, | |
1101 | +<code>excludedURLs</code> to <code>nil</code> and the event stream creation | |
1102 | +flags will be set to <code>kCDEventsDefaultEventStreamFlags</code>.</p></code></li> | |
1103 | + | |
1104 | + </ul> | |
1105 | + </div> | |
1106 | + | |
1107 | + | |
1108 | + | |
1109 | + <div class="method-subsection declared-in-section"> | |
1110 | + <h4 class="method-subtitle">Declared In</h4> | |
1111 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
1112 | + </div> | |
1113 | + | |
1114 | + | |
1115 | +</div> | |
1116 | + | |
1117 | + <div class="section-method"> | |
1118 | + <a name="//api/name/initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:" title="initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:"></a> | |
1119 | + <h3 class="subsubtitle method-title">initWithURLs:delegate:onRunLoop:sinceEventIdentifier:notificationLantency:ignoreEventsFromSubDirs:excludeURLs:streamCreationFlags:</h3> | |
1120 | + | |
1121 | + | |
1122 | + | |
1123 | + <div class="method-subsection brief-description"> | |
1124 | + <p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch, URLs to exclude, wheter events from sub-directories are ignored or not and schedules the watcher on the given run loop.</p> | |
1125 | + </div> | |
1126 | + | |
1127 | + | |
1128 | + <div class="method-subsection method-declaration"><code>- (id)initWithURLs:(NSArray *)<em>URLs</em> delegate:(id<CDEventsDelegate>)<em>delegate</em> onRunLoop:(NSRunLoop *)<em>runLoop</em> sinceEventIdentifier:(CDEventIdentifier)<em>sinceEventIdentifier</em> notificationLantency:(CFTimeInterval)<em>notificationLatency</em> ignoreEventsFromSubDirs:(BOOL)<em>ignoreEventsFromSubDirs</em> excludeURLs:(NSArray *)<em>exludeURLs</em> streamCreationFlags:(CDEventsEventStreamCreationFlags)<em>streamCreationFlags</em></code></div> | |
1129 | + | |
1130 | + | |
1131 | + <div class="method-subsection arguments-section parameters"> | |
1132 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
1133 | + | |
1134 | + <dl class="argument-def parameter-def"> | |
1135 | + <dt><em>URLs</em></dt> | |
1136 | + <dd><p>An array of URLs (<code>NSURL</code>) we want to watch.</p></dd> | |
1137 | + </dl> | |
1138 | + | |
1139 | + <dl class="argument-def parameter-def"> | |
1140 | + <dt><em>delegate</em></dt> | |
1141 | + <dd><p>The delegate object the <a href="CDEvents.html">CDEvents</a> object calls when it recieves an event.</p></dd> | |
1142 | + </dl> | |
1143 | + | |
1144 | + <dl class="argument-def parameter-def"> | |
1145 | + <dt><em>runLoop</em></dt> | |
1146 | + <dd><p>The run loop which the which the watcher should be schedueled on.</p></dd> | |
1147 | + </dl> | |
1148 | + | |
1149 | + <dl class="argument-def parameter-def"> | |
1150 | + <dt><em>sinceEventIdentifier</em></dt> | |
1151 | + <dd><p>Events that have happened after the given event identifier will be supplied.</p></dd> | |
1152 | + </dl> | |
1153 | + | |
1154 | + <dl class="argument-def parameter-def"> | |
1155 | + <dt><em>notificationLatency</em></dt> | |
1156 | + <dd><p>The (approximate) time intervall between notifications sent to the delegate.</p></dd> | |
1157 | + </dl> | |
1158 | + | |
1159 | + <dl class="argument-def parameter-def"> | |
1160 | + <dt><em>ignoreEventsFromSubDirs</em></dt> | |
1161 | + <dd><p>Wheter events from sub-directories of the watched URLs should be ignored or not.</p></dd> | |
1162 | + </dl> | |
1163 | + | |
1164 | + <dl class="argument-def parameter-def"> | |
1165 | + <dt><em>exludeURLs</em></dt> | |
1166 | + <dd><p>An array of URLs that we should ignore events from. Pass <code>nil</code> if none should be excluded.</p></dd> | |
1167 | + </dl> | |
1168 | + | |
1169 | + <dl class="argument-def parameter-def"> | |
1170 | + <dt><em>streamCreationFlags</em></dt> | |
1171 | + <dd><p>The event stream creation flags.</p></dd> | |
1172 | + </dl> | |
1173 | + | |
1174 | + </div> | |
1175 | + | |
1176 | + | |
1177 | + | |
1178 | + <div class="method-subsection return"> | |
1179 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1180 | + <p>An <a href="CDEvents.html">CDEvents</a> object initialized with the given URLs to watch, URLs to exclude, wheter events from sub-directories are ignored or not and run on the given run loop. | |
1181 | +@throws NSInvalidArgumentException if the parameter URLs is empty or points to <code>nil</code>. | |
1182 | +@throws NSInvalidArgumentException if <em>delegate</em>is <code>nil</code>. | |
1183 | +@throws CDEventsEventStreamCreationFailureException if we failed to create a event stream.</p> | |
1184 | + </div> | |
1185 | + | |
1186 | + | |
1187 | + | |
1188 | + <div class="method-subsection availability"> | |
1189 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1190 | + <p>1.0.0</p> | |
1191 | + </div> | |
1192 | + | |
1193 | + | |
1194 | + | |
1195 | + <div class="method-subsection discussion-section"> | |
1196 | + <h4 class="method-subtitle">Discussion</h4> | |
1197 | + <p>Returns an <code>CDEvents</code> object initialized with the given URLs to watch, URLs to exclude, wheter events from sub-directories are ignored or not and schedules the watcher on the given run loop.</p> | |
1198 | + </div> | |
1199 | + | |
1200 | + | |
1201 | + | |
1202 | + | |
1203 | + | |
1204 | + <div class="method-subsection see-also-section"> | |
1205 | + <h4 class="method-subtitle">See Also</h4> | |
1206 | + <ul> | |
1207 | + | |
1208 | + <li><code><p><a href="#//api/name/initWithURLs:delegate:">– initWithURLs:delegate:</a></p></code></li> | |
1209 | + | |
1210 | + <li><code><p><a href="#//api/name/initWithURLs:delegate:onRunLoop:">– initWithURLs:delegate:onRunLoop:</a></p></code></li> | |
1211 | + | |
1212 | + <li><code><p><a href="#//api/name/ignoreEventsFromSubDirectories">@property ignoreEventsFromSubDirectories</a></p></code></li> | |
1213 | + | |
1214 | + <li><code><p><a href="#//api/name/excludedURLs">@property excludedURLs</a></p></code></li> | |
1215 | + | |
1216 | + <li><code><p><a href="../Protocols/CDEventsDelegate.html">CDEventsDelegate</a></p></code></li> | |
1217 | + | |
1218 | + <li><code><p>FSEventStreamCreateFlags</p> | |
1219 | + | |
1220 | +<p>@discussion To ask for events “since now” pass the return value of | |
1221 | +<a href="#//api/name/currentEventIdentifier">+ currentEventIdentifier</a> as the parameter <code>sinceEventIdentifier</code>. | |
1222 | +CDEventStreamCreationFailureException should be extremely rare.</p></code></li> | |
1223 | + | |
1224 | + </ul> | |
1225 | + </div> | |
1226 | + | |
1227 | + | |
1228 | + | |
1229 | + <div class="method-subsection declared-in-section"> | |
1230 | + <h4 class="method-subtitle">Declared In</h4> | |
1231 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
1232 | + </div> | |
1233 | + | |
1234 | + | |
1235 | +</div> | |
1236 | + | |
1237 | + <div class="section-method"> | |
1238 | + <a name="//api/name/streamDescription" title="streamDescription"></a> | |
1239 | + <h3 class="subsubtitle method-title">streamDescription</h3> | |
1240 | + | |
1241 | + | |
1242 | + | |
1243 | + <div class="method-subsection brief-description"> | |
1244 | + <p>Returns a NSString containing the description of the current event stream.</p> | |
1245 | + </div> | |
1246 | + | |
1247 | + | |
1248 | + <div class="method-subsection method-declaration"><code>- (NSString *)streamDescription</code></div> | |
1249 | + | |
1250 | + | |
1251 | + | |
1252 | + | |
1253 | + <div class="method-subsection return"> | |
1254 | + <h4 class="method-subtitle parameter-title">Return Value</h4> | |
1255 | + <p>A NSString containing the description of the current event stream.</p> | |
1256 | + </div> | |
1257 | + | |
1258 | + | |
1259 | + | |
1260 | + <div class="method-subsection availability"> | |
1261 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
1262 | + <p>1.0.0</p> | |
1263 | + </div> | |
1264 | + | |
1265 | + | |
1266 | + | |
1267 | + <div class="method-subsection discussion-section"> | |
1268 | + <h4 class="method-subtitle">Discussion</h4> | |
1269 | + <p>Returns a NSString containing the description of the current event stream.</p> | |
1270 | + </div> | |
1271 | + | |
1272 | + | |
1273 | + | |
1274 | + | |
1275 | + | |
1276 | + | |
1277 | + | |
1278 | + <div class="method-subsection declared-in-section"> | |
1279 | + <h4 class="method-subtitle">Declared In</h4> | |
1280 | + <code class="declared-in-ref">CDEvents.h</code><br /> | |
1281 | + </div> | |
1282 | + | |
1283 | + | |
1284 | +</div> | |
1285 | + | |
1286 | + </div> | |
1287 | + | |
1288 | + | |
1289 | + </div> | |
1290 | + <div class="main-navigation navigation-bottom"> | |
1291 | + <ul> | |
1292 | + <li><a href="../index.html">Index</a></li> | |
1293 | + <li><a href="../hierarchy.html">Hierarchy</a></li> | |
1294 | +</ul> | |
1295 | + </div> | |
1296 | + <div id="footer"> | |
1297 | + <hr /> | |
1298 | + <div class="footer-copyright"> | |
1299 | + <p><span class="copyright">© 2011 Aron Cedercrantz. All rights reserved. (Last updated: 2011-11-02)</span><br /> | |
1300 | + | |
1301 | + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> | |
1302 | + | |
1303 | + </div> | |
1304 | + </div> | |
1305 | + </div> | |
1306 | + </article> | |
1307 | + <script type="text/javascript"> | |
1308 | + function jumpToChange() | |
1309 | + { | |
1310 | + window.location.hash = this.options[this.selectedIndex].value; | |
1311 | + } | |
1312 | + | |
1313 | + function toggleTOC() | |
1314 | + { | |
1315 | + var contents = document.getElementById('contents'); | |
1316 | + var tocContainer = document.getElementById('tocContainer'); | |
1317 | + | |
1318 | + if (this.getAttribute('class') == 'open') | |
1319 | + { | |
1320 | + this.setAttribute('class', ''); | |
1321 | + contents.setAttribute('class', ''); | |
1322 | + tocContainer.setAttribute('class', ''); | |
1323 | + | |
1324 | + window.name = "hideTOC"; | |
1325 | + } | |
1326 | + else | |
1327 | + { | |
1328 | + this.setAttribute('class', 'open'); | |
1329 | + contents.setAttribute('class', 'isShowingTOC'); | |
1330 | + tocContainer.setAttribute('class', 'isShowingTOC'); | |
1331 | + | |
1332 | + window.name = ""; | |
1333 | + } | |
1334 | + return false; | |
1335 | + } | |
1336 | + | |
1337 | + function toggleTOCEntryChildren(e) | |
1338 | + { | |
1339 | + e.stopPropagation(); | |
1340 | + var currentClass = this.getAttribute('class'); | |
1341 | + if (currentClass == 'children') { | |
1342 | + this.setAttribute('class', 'children open'); | |
1343 | + } | |
1344 | + else if (currentClass == 'children open') { | |
1345 | + this.setAttribute('class', 'children'); | |
1346 | + } | |
1347 | + return false; | |
1348 | + } | |
1349 | + | |
1350 | + function tocEntryClick(e) | |
1351 | + { | |
1352 | + e.stopPropagation(); | |
1353 | + return true; | |
1354 | + } | |
1355 | + | |
1356 | + function init() | |
1357 | + { | |
1358 | + var selectElement = document.getElementById('jumpTo'); | |
1359 | + selectElement.addEventListener('change', jumpToChange, false); | |
1360 | + | |
1361 | + var tocButton = document.getElementById('table_of_contents'); | |
1362 | + tocButton.addEventListener('click', toggleTOC, false); | |
1363 | + | |
1364 | + var taskTreeItem = document.getElementById('task_treeitem'); | |
1365 | + if (taskTreeItem.getElementsByTagName('li').length > 0) | |
1366 | + { | |
1367 | + taskTreeItem.setAttribute('class', 'children'); | |
1368 | + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); | |
1369 | + } | |
1370 | + | |
1371 | + var tocList = document.getElementById('toc'); | |
1372 | + | |
1373 | + var tocEntries = tocList.getElementsByTagName('li'); | |
1374 | + for (var i = 0; i < tocEntries.length; i++) { | |
1375 | + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); | |
1376 | + } | |
1377 | + | |
1378 | + var tocLinks = tocList.getElementsByTagName('a'); | |
1379 | + for (var i = 0; i < tocLinks.length; i++) { | |
1380 | + tocLinks[i].addEventListener('click', tocEntryClick, false); | |
1381 | + } | |
1382 | + | |
1383 | + if (window.name == "hideTOC") { | |
1384 | + toggleTOC.call(tocButton); | |
1385 | + } | |
1386 | + } | |
1387 | + | |
1388 | + window.onload = init; | |
1389 | + </script> | |
1390 | + </body> | |
1391 | +</html> | |
\ No newline at end of file |
@@ -0,0 +1,332 @@ | ||
1 | +<!DOCTYPE HTML> | |
2 | +<html> | |
3 | + <head> | |
4 | + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> | |
5 | + <title>CDEventsDelegate Protocol Reference</title> | |
6 | + <meta id="xcode-display" name="xcode-display" content="render"/> | |
7 | + <meta name="viewport" content="width=550" /> | |
8 | + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> | |
9 | + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> | |
10 | + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> | |
11 | + </head> | |
12 | + <body> | |
13 | + <header id="top_header"> | |
14 | + <div id="library" class="hideInXcode"> | |
15 | + <h1><a id="libraryTitle" href="../index.html">CDEvents </a></h1> | |
16 | + <a id="developerHome" href="../index.html">Aron Cedercrantz</a> | |
17 | + </div> | |
18 | + | |
19 | + <div id="title" role="banner"> | |
20 | + <h1 class="hideInXcode">CDEventsDelegate Protocol Reference</h1> | |
21 | + </div> | |
22 | + <ul id="headerButtons" role="toolbar"> | |
23 | + <li id="toc_button"> | |
24 | + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> | |
25 | + </li> | |
26 | + <li id="jumpto_button" role="navigation"> | |
27 | + <select id="jumpTo"> | |
28 | + <option value="top">Jump To…</option> | |
29 | + | |
30 | + <option value="overview">Overview</option> | |
31 | + | |
32 | + | |
33 | + | |
34 | + | |
35 | + <option value="tasks">Tasks</option> | |
36 | + | |
37 | + | |
38 | + | |
39 | + | |
40 | + | |
41 | + | |
42 | + | |
43 | + | |
44 | + | |
45 | + <option value="instance_methods">Instance Methods</option> | |
46 | + | |
47 | + <option value="//api/name/URLWatcher:eventOccurred:"> - URLWatcher:eventOccurred:</option> | |
48 | + | |
49 | + | |
50 | + | |
51 | +</select> | |
52 | + </li> | |
53 | + </ul> | |
54 | + </header> | |
55 | + <nav id="tocContainer" class="isShowingTOC"> | |
56 | + <ul id="toc" role="tree"> | |
57 | + | |
58 | +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> | |
59 | + | |
60 | + | |
61 | + | |
62 | + | |
63 | +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> | |
64 | + | |
65 | +</ul></li> | |
66 | + | |
67 | + | |
68 | + | |
69 | + | |
70 | + | |
71 | + | |
72 | + | |
73 | + | |
74 | + | |
75 | +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> | |
76 | + | |
77 | + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/URLWatcher:eventOccurred:">URLWatcher:eventOccurred:</a></span></li> | |
78 | + | |
79 | +</ul></li> | |
80 | + | |
81 | + | |
82 | + </ul> | |
83 | + </nav> | |
84 | + <article> | |
85 | + <div id="contents" class="isShowingTOC" role="main"> | |
86 | + <a title="CDEventsDelegate Protocol Reference" name="top"></a> | |
87 | + <div class="main-navigation navigation-top"> | |
88 | + <ul> | |
89 | + <li><a href="../index.html">Index</a></li> | |
90 | + <li><a href="../hierarchy.html">Hierarchy</a></li> | |
91 | +</ul> | |
92 | + </div> | |
93 | + <div id="header"> | |
94 | + <div class="section-header"> | |
95 | + <h1 class="title title-header">CDEventsDelegate Protocol Reference</h1> | |
96 | + </div> | |
97 | + </div> | |
98 | + <div id="container"> | |
99 | + | |
100 | + <div class="section section-specification"><table cellspacing="0"><tbody> | |
101 | + <tr> | |
102 | + <td class="specification-title">Declared in</td> | |
103 | + <td class="specification-value">CDEventsDelegate.h</td> | |
104 | +</tr> | |
105 | + </tbody></table></div> | |
106 | + | |
107 | + | |
108 | + | |
109 | + | |
110 | + <div class="section section-overview"> | |
111 | + <a title="Overview" name="overview"></a> | |
112 | + <h2 class="subtitle subtitle-overview">Overview</h2> | |
113 | + <p>The <a href="CDEventsDelegate.html">CDEventsDelegate</a> protocol defines the required methods implemented by delegates of <a href="../Classes/CDEvents.html">CDEvents</a> objects.</p> | |
114 | + </div> | |
115 | + | |
116 | + | |
117 | + | |
118 | + | |
119 | + | |
120 | + <div class="section section-tasks"> | |
121 | + <a title="Tasks" name="tasks"></a> | |
122 | + <h2 class="subtitle subtitle-tasks">Tasks</h2> | |
123 | + | |
124 | + | |
125 | + | |
126 | + | |
127 | + | |
128 | + <ul class="task-list"> | |
129 | + <li> | |
130 | + <span class="tooltip"> | |
131 | + <code><a href="#//api/name/URLWatcher:eventOccurred:">– URLWatcher:eventOccurred:</a></code> | |
132 | + <span class="tooltip"><p>The method called by the <code>CDEvents</code> object on its delegate object.</p></span> | |
133 | + </span> | |
134 | + | |
135 | + <span class="task-item-suffix">required method</span> | |
136 | +</li> | |
137 | + </ul> | |
138 | + | |
139 | + </div> | |
140 | + | |
141 | + | |
142 | + | |
143 | + | |
144 | + | |
145 | + | |
146 | + | |
147 | + | |
148 | + | |
149 | + <div class="section section-methods"> | |
150 | + <a title="Instance Methods" name="instance_methods"></a> | |
151 | + <h2 class="subtitle subtitle-methods">Instance Methods</h2> | |
152 | + | |
153 | + <div class="section-method"> | |
154 | + <a name="//api/name/URLWatcher:eventOccurred:" title="URLWatcher:eventOccurred:"></a> | |
155 | + <h3 class="subsubtitle method-title">URLWatcher:eventOccurred:</h3> | |
156 | + | |
157 | + | |
158 | + | |
159 | + <div class="method-subsection brief-description"> | |
160 | + <p>The method called by the <code>CDEvents</code> object on its delegate object.</p> | |
161 | + </div> | |
162 | + | |
163 | + | |
164 | + <div class="method-subsection method-declaration"><code>- (void)URLWatcher:(CDEvents *)<em>URLWatcher</em> eventOccurred:(CDEvent *)<em>event</em></code></div> | |
165 | + | |
166 | + | |
167 | + <div class="method-subsection arguments-section parameters"> | |
168 | + <h4 class="method-subtitle parameter-title">Parameters</h4> | |
169 | + | |
170 | + <dl class="argument-def parameter-def"> | |
171 | + <dt><em>URLWatcher</em></dt> | |
172 | + <dd><p>The <code>CDEvents</code> object which the event was recieved thru.</p></dd> | |
173 | + </dl> | |
174 | + | |
175 | + <dl class="argument-def parameter-def"> | |
176 | + <dt><em>event</em></dt> | |
177 | + <dd><p>The event data.</p></dd> | |
178 | + </dl> | |
179 | + | |
180 | + </div> | |
181 | + | |
182 | + | |
183 | + | |
184 | + | |
185 | + | |
186 | + <div class="method-subsection availability"> | |
187 | + <h4 class="method-subtitle parameter-title">Availability</h4> | |
188 | + <p>1.0.0</p> | |
189 | + </div> | |
190 | + | |
191 | + | |
192 | + | |
193 | + <div class="method-subsection discussion-section"> | |
194 | + <h4 class="method-subtitle">Discussion</h4> | |
195 | + <p>The method called by the <code>CDEvents</code> object on its delegate object.</p> | |
196 | + </div> | |
197 | + | |
198 | + | |
199 | + | |
200 | + | |
201 | + | |
202 | + <div class="method-subsection see-also-section"> | |
203 | + <h4 class="method-subtitle">See Also</h4> | |
204 | + <ul> | |
205 | + | |
206 | + <li><code><p><a href="../Classes/CDEvents.html">CDEvents</a></p></code></li> | |
207 | + | |
208 | + <li><code><p><a href="../Classes/CDEvent.html">CDEvent</a></p> | |
209 | + | |
210 | +<p>@discussion Conforming objects' implementation of this method will be called | |
211 | +whenever an event occurs. The instance of <a href="../Classes/CDEvents.html">CDEvents</a> which received the event | |
212 | +and the event itself are passed as parameters.</p></code></li> | |
213 | + | |
214 | + </ul> | |
215 | + </div> | |
216 | + | |
217 | + | |
218 | + | |
219 | + <div class="method-subsection declared-in-section"> | |
220 | + <h4 class="method-subtitle">Declared In</h4> | |
221 | + <code class="declared-in-ref">CDEventsDelegate.h</code><br /> | |
222 | + </div> | |
223 | + | |
224 | + | |
225 | +</div> | |
226 | + | |
227 | + </div> | |
228 | + | |
229 | + | |
230 | + </div> | |
231 | + <div class="main-navigation navigation-bottom"> | |
232 | + <ul> | |
233 | + <li><a href="../index.html">Index</a></li> | |
234 | + <li><a href="../hierarchy.html">Hierarchy</a></li> | |
235 | +</ul> | |
236 | + </div> | |
237 | + <div id="footer"> | |
238 | + <hr /> | |
239 | + <div class="footer-copyright"> | |
240 | + <p><span class="copyright">© 2011 Aron Cedercrantz. All rights reserved. (Last updated: 2011-11-02)</span><br /> | |
241 | + | |
242 | + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> | |
243 | + | |
244 | + </div> | |
245 | + </div> | |
246 | + </div> | |
247 | + </article> | |
248 | + <script type="text/javascript"> | |
249 | + function jumpToChange() | |
250 | + { | |
251 | + window.location.hash = this.options[this.selectedIndex].value; | |
252 | + } | |
253 | + | |
254 | + function toggleTOC() | |
255 | + { | |
256 | + var contents = document.getElementById('contents'); | |
257 | + var tocContainer = document.getElementById('tocContainer'); | |
258 | + | |
259 | + if (this.getAttribute('class') == 'open') | |
260 | + { | |
261 | + this.setAttribute('class', ''); | |
262 | + contents.setAttribute('class', ''); | |
263 | + tocContainer.setAttribute('class', ''); | |
264 | + | |
265 | + window.name = "hideTOC"; | |
266 | + } | |
267 | + else | |
268 | + { | |
269 | + this.setAttribute('class', 'open'); | |
270 | + contents.setAttribute('class', 'isShowingTOC'); | |
271 | + tocContainer.setAttribute('class', 'isShowingTOC'); | |
272 | + | |
273 | + window.name = ""; | |
274 | + } | |
275 | + return false; | |
276 | + } | |
277 | + | |
278 | + function toggleTOCEntryChildren(e) | |
279 | + { | |
280 | + e.stopPropagation(); | |
281 | + var currentClass = this.getAttribute('class'); | |
282 | + if (currentClass == 'children') { | |
283 | + this.setAttribute('class', 'children open'); | |
284 | + } | |
285 | + else if (currentClass == 'children open') { | |
286 | + this.setAttribute('class', 'children'); | |
287 | + } | |
288 | + return false; | |
289 | + } | |
290 | + | |
291 | + function tocEntryClick(e) | |
292 | + { | |
293 | + e.stopPropagation(); | |
294 | + return true; | |
295 | + } | |
296 | + | |
297 | + function init() | |
298 | + { | |
299 | + var selectElement = document.getElementById('jumpTo'); | |
300 | + selectElement.addEventListener('change', jumpToChange, false); | |
301 | + | |
302 | + var tocButton = document.getElementById('table_of_contents'); | |
303 | + tocButton.addEventListener('click', toggleTOC, false); | |
304 | + | |
305 | + var taskTreeItem = document.getElementById('task_treeitem'); | |
306 | + if (taskTreeItem.getElementsByTagName('li').length > 0) | |
307 | + { | |
308 | + taskTreeItem.setAttribute('class', 'children'); | |
309 | + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); | |
310 | + } | |
311 | + | |
312 | + var tocList = document.getElementById('toc'); | |
313 | + | |
314 | + var tocEntries = tocList.getElementsByTagName('li'); | |
315 | + for (var i = 0; i < tocEntries.length; i++) { | |
316 | + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); | |
317 | + } | |
318 | + | |
319 | + var tocLinks = tocList.getElementsByTagName('a'); | |
320 | + for (var i = 0; i < tocLinks.length; i++) { | |
321 | + tocLinks[i].addEventListener('click', tocEntryClick, false); | |
322 | + } | |
323 | + | |
324 | + if (window.name == "hideTOC") { | |
325 | + toggleTOC.call(tocButton); | |
326 | + } | |
327 | + } | |
328 | + | |
329 | + window.onload = init; | |
330 | + </script> | |
331 | + </body> | |
332 | +</html> | |
\ No newline at end of file |
@@ -0,0 +1,535 @@ | ||
1 | +body { | |
2 | + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; | |
3 | + font-size: 13px; | |
4 | +} | |
5 | + | |
6 | +code { | |
7 | + font-family: Courier, Consolas, monospace; | |
8 | + font-size: 13px; | |
9 | + color: #666; | |
10 | +} | |
11 | + | |
12 | +pre { | |
13 | + font-family: Courier, Consolas, monospace; | |
14 | + font-size: 13px; | |
15 | + line-height: 18px; | |
16 | + tab-interval: 0.5em; | |
17 | + border: 1px solid #C7CFD5; | |
18 | + background-color: #F1F5F9; | |
19 | + color: #666; | |
20 | + padding: 0.3em 1em; | |
21 | +} | |
22 | + | |
23 | +ul { | |
24 | + list-style-type: square; | |
25 | +} | |
26 | + | |
27 | +li { | |
28 | + margin-bottom: 10px; | |
29 | +} | |
30 | + | |
31 | +a { | |
32 | + text-decoration: none; | |
33 | + color: #36C; | |
34 | +} | |
35 | + | |
36 | +a:hover { | |
37 | + text-decoration: underline; | |
38 | + color: #36C; | |
39 | +} | |
40 | + | |
41 | +h2 { | |
42 | + border-bottom: 1px solid #8391A8; | |
43 | + color: #3C4C6C; | |
44 | + font-size: 187%; | |
45 | + font-weight: normal; | |
46 | + margin-top: 1.75em; | |
47 | + padding-bottom: 2px; | |
48 | +} | |
49 | + | |
50 | +/* @group Common page elements */ | |
51 | + | |
52 | +#top_header { | |
53 | + height: 91px; | |
54 | + left: 0; | |
55 | + min-width: 598px; | |
56 | + position: absolute; | |
57 | + right: 0; | |
58 | + top: 0; | |
59 | + z-index: 900; | |
60 | +} | |
61 | + | |
62 | +#footer { | |
63 | + clear: both; | |
64 | + padding-top: 20px; | |
65 | + text-align: center; | |
66 | +} | |
67 | + | |
68 | +#contents, #overview_contents { | |
69 | + border-top: 1px solid #2B334F; | |
70 | + position: absolute; | |
71 | + top: 91px; | |
72 | + left: 0; | |
73 | + right: 0; | |
74 | + bottom: 0; | |
75 | + overflow-x: hidden; | |
76 | + overflow-y: auto; | |
77 | + padding-left: 2em; | |
78 | + padding-right: 2em; | |
79 | + padding-top: 1em; | |
80 | + min-width: 550px; | |
81 | +} | |
82 | + | |
83 | +#contents.isShowingTOC { | |
84 | + left: 230px; | |
85 | + min-width: 320px; | |
86 | +} | |
87 | + | |
88 | +.copyright { | |
89 | + font-size: 12px; | |
90 | +} | |
91 | + | |
92 | +.generator { | |
93 | + font-size: 11px; | |
94 | +} | |
95 | + | |
96 | +.main-navigation ul li { | |
97 | + display: inline; | |
98 | + margin-left: 15px; | |
99 | + list-style: none; | |
100 | +} | |
101 | + | |
102 | +.navigation-top { | |
103 | + clear: both; | |
104 | + float: right; | |
105 | +} | |
106 | + | |
107 | +.navigation-bottom { | |
108 | + clear: both; | |
109 | + float: right; | |
110 | + margin-top: 20px; | |
111 | + margin-bottom: -10px; | |
112 | +} | |
113 | + | |
114 | +.open > .disclosure { | |
115 | + background-image: url("../img/disclosure_open.png"); | |
116 | +} | |
117 | + | |
118 | +.disclosure { | |
119 | + background: url("../img/disclosure.png") no-repeat scroll 0 0; | |
120 | +} | |
121 | + | |
122 | +.disclosure, .nodisclosure { | |
123 | + display: inline-block; | |
124 | + height: 8px; | |
125 | + margin-right: 5px; | |
126 | + position: relative; | |
127 | + width: 9px; | |
128 | +} | |
129 | + | |
130 | +/* @end */ | |
131 | + | |
132 | +/* @group Header */ | |
133 | + | |
134 | +#top_header #library { | |
135 | + background: url("../img/library_background.png") repeat-x 0 0 #485E78; | |
136 | + background-color: #ccc; | |
137 | + height: 35px; | |
138 | + font-size: 115%; | |
139 | +} | |
140 | + | |
141 | +#top_header #library #libraryTitle { | |
142 | + color: #FFFFFF; | |
143 | + margin-left: 15px; | |
144 | + text-shadow: 0 -1px 0 #485E78; | |
145 | + top: 8px; | |
146 | + position: absolute; | |
147 | +} | |
148 | + | |
149 | +#top_header #library #developerHome { | |
150 | + color: #92979E; | |
151 | + right: 15px; | |
152 | + top: 8px; | |
153 | + position: absolute; | |
154 | +} | |
155 | + | |
156 | +#top_header #library a:hover { | |
157 | + text-decoration: none; | |
158 | +} | |
159 | + | |
160 | +#top_header #title { | |
161 | + background: url("../img/title_background.png") repeat-x 0 0 #8A98A9; | |
162 | + border-bottom: 1px solid #B6B6B6; | |
163 | + height: 25px; | |
164 | + overflow: hidden; | |
165 | +} | |
166 | + | |
167 | +#top_header h1 { | |
168 | + font-size: 115%; | |
169 | + font-weight: normal; | |
170 | + margin: 0; | |
171 | + padding: 3px 0 2px; | |
172 | + text-align: center; | |
173 | + text-shadow: 0 1px 0 #D5D5D5; | |
174 | + white-space: nowrap; | |
175 | +} | |
176 | + | |
177 | +#headerButtons { | |
178 | + background-color: #D8D8D8; | |
179 | + background-image: url("../img/button_bar_background.png"); | |
180 | + border-bottom: 1px solid #EDEDED; | |
181 | + border-top: 1px solid #2B334F; | |
182 | + font-size: 8pt; | |
183 | + height: 28px; | |
184 | + left: 0; | |
185 | + list-style: none outside none; | |
186 | + margin: 0; | |
187 | + overflow: hidden; | |
188 | + padding: 0; | |
189 | + position: absolute; | |
190 | + right: 0; | |
191 | + top: 61px; | |
192 | +} | |
193 | + | |
194 | +#headerButtons li { | |
195 | + background-repeat: no-repeat; | |
196 | + display: inline; | |
197 | + margin-top: 0; | |
198 | + margin-bottom: 0; | |
199 | + padding: 0; | |
200 | +} | |
201 | + | |
202 | +#toc_button button { | |
203 | + border-color: #ACACAC; | |
204 | + border-style: none solid none none; | |
205 | + border-width: 0 1px 0 0; | |
206 | + height: 28px; | |
207 | + margin: 0; | |
208 | + padding-left: 30px; | |
209 | + text-align: left; | |
210 | + width: 230px; | |
211 | +} | |
212 | + | |
213 | +li#jumpto_button { | |
214 | + left: 230px; | |
215 | + margin-left: 0; | |
216 | + position: absolute; | |
217 | +} | |
218 | + | |
219 | +li#jumpto_button select { | |
220 | + height: 22px; | |
221 | + margin: 5px 2px 0 10px; | |
222 | + max-width: 300px; | |
223 | +} | |
224 | + | |
225 | +/* @end */ | |
226 | + | |
227 | +/* @group Table of contents */ | |
228 | + | |
229 | +#tocContainer.isShowingTOC { | |
230 | + border-right: 1px solid #ACACAC; | |
231 | + display: block; | |
232 | + overflow-x: hidden; | |
233 | + overflow-y: auto; | |
234 | + padding: 0; | |
235 | +} | |
236 | + | |
237 | +#tocContainer { | |
238 | + background-color: #E4EBF7; | |
239 | + border-top: 1px solid #2B334F; | |
240 | + bottom: 0; | |
241 | + display: none; | |
242 | + left: 0; | |
243 | + overflow: hidden; | |
244 | + position: absolute; | |
245 | + top: 91px; | |
246 | + width: 229px; | |
247 | +} | |
248 | + | |
249 | +#tocContainer > ul#toc { | |
250 | + font-size: 11px; | |
251 | + margin: 0; | |
252 | + padding: 12px 0 18px; | |
253 | + width: 209px; | |
254 | + -moz-user-select: none; | |
255 | + -webkit-user-select: none; | |
256 | + user-select: none; | |
257 | +} | |
258 | + | |
259 | +#tocContainer > ul#toc > li { | |
260 | + margin: 0; | |
261 | + padding: 0 0 7px 30px; | |
262 | + text-indent: -15px; | |
263 | +} | |
264 | + | |
265 | +#tocContainer > ul#toc > li > .sectionName a { | |
266 | + color: #000000; | |
267 | + font-weight: bold; | |
268 | +} | |
269 | + | |
270 | +#tocContainer > ul#toc > li > .sectionName a:hover { | |
271 | + text-decoration: none; | |
272 | +} | |
273 | + | |
274 | +#tocContainer > ul#toc li.children > ul { | |
275 | + display: none; | |
276 | + height: 0; | |
277 | +} | |
278 | + | |
279 | +#tocContainer > ul#toc > li > ul { | |
280 | + margin: 0; | |
281 | + padding: 0; | |
282 | +} | |
283 | + | |
284 | +#tocContainer > ul#toc > li > ul, ul#toc > li > ul > li { | |
285 | + margin-left: 0; | |
286 | + margin-bottom: 0; | |
287 | + padding-left: 15px; | |
288 | +} | |
289 | + | |
290 | +#tocContainer > ul#toc > li ul { | |
291 | + list-style: none; | |
292 | + margin-right: 0; | |
293 | + padding-right: 0; | |
294 | +} | |
295 | + | |
296 | +#tocContainer > ul#toc li.children.open > ul { | |
297 | + display: block; | |
298 | + height: auto; | |
299 | + margin-left: -15px; | |
300 | + padding-left: 0; | |
301 | +} | |
302 | + | |
303 | +#tocContainer > ul#toc > li > ul, ul#toc > li > ul > li { | |
304 | + margin-left: 0; | |
305 | + padding-left: 15px; | |
306 | +} | |
307 | + | |
308 | +#tocContainer li ul li { | |
309 | + margin-top: 0.583em; | |
310 | + overflow: hidden; | |
311 | + text-overflow: ellipsis; | |
312 | + white-space: nowrap; | |
313 | +} | |
314 | + | |
315 | +#tocContainer li ul li span.sectionName { | |
316 | + white-space: normal; | |
317 | +} | |
318 | + | |
319 | +#tocContainer > ul#toc > li > ul > li > .sectionName a { | |
320 | + font-weight: bold; | |
321 | +} | |
322 | + | |
323 | +#tocContainer > ul#toc > li > ul a { | |
324 | + color: #4F4F4F; | |
325 | +} | |
326 | + | |
327 | +/* @end */ | |
328 | + | |
329 | +/* @group Index formatting */ | |
330 | + | |
331 | +.index-title { | |
332 | + font-size: 13px; | |
333 | + font-weight: normal; | |
334 | +} | |
335 | + | |
336 | +.index-column { | |
337 | + float: left; | |
338 | + width: 30%; | |
339 | + min-width: 200px; | |
340 | + font-size: 11px; | |
341 | +} | |
342 | + | |
343 | +.index-column ul { | |
344 | + margin: 8px 0 0 0; | |
345 | + padding: 0; | |
346 | + list-style: none; | |
347 | +} | |
348 | + | |
349 | +.index-column ul li { | |
350 | + margin: 0 0 3px 0; | |
351 | + padding: 0; | |
352 | +} | |
353 | + | |
354 | +.hierarchy-column { | |
355 | + min-width: 400px; | |
356 | +} | |
357 | + | |
358 | +.hierarchy-column ul { | |
359 | + margin: 3px 0 0 15px; | |
360 | +} | |
361 | + | |
362 | +.hierarchy-column ul li { | |
363 | + list-style-type: square; | |
364 | +} | |
365 | + | |
366 | +/* @end */ | |
367 | + | |
368 | +/* @group Common formatting elements */ | |
369 | + | |
370 | +.title { | |
371 | + font-weight: normal; | |
372 | + font-size: 215%; | |
373 | + margin-top:0; | |
374 | +} | |
375 | + | |
376 | +.subtitle { | |
377 | + font-weight: normal; | |
378 | + font-size: 180%; | |
379 | + color: #3C4C6C; | |
380 | + border-bottom: 1px solid #5088C5; | |
381 | +} | |
382 | + | |
383 | +.subsubtitle { | |
384 | + font-weight: normal; | |
385 | + font-size: 145%; | |
386 | + height: 0.7em; | |
387 | +} | |
388 | + | |
389 | +.warning { | |
390 | + border: 1px solid #5088C5; | |
391 | + background-color: #F0F3F7; | |
392 | + margin-bottom: 0.5em; | |
393 | + padding: 0.3em 0.8em; | |
394 | +} | |
395 | + | |
396 | +.bug { | |
397 | + border: 1px solid #000; | |
398 | + background-color: #ffffcc; | |
399 | + margin-bottom: 0.5em; | |
400 | + padding: 0.3em 0.8em; | |
401 | +} | |
402 | + | |
403 | +.deprecated { | |
404 | + color: #F60425; | |
405 | +} | |
406 | + | |
407 | +/* @end */ | |
408 | + | |
409 | +/* @group Common layout */ | |
410 | + | |
411 | +.section { | |
412 | + margin-top: 3em; | |
413 | +} | |
414 | + | |
415 | +/* @end */ | |
416 | + | |
417 | +/* @group Object specification section */ | |
418 | + | |
419 | +.section-specification { | |
420 | + margin-left: 2.5em; | |
421 | + margin-right: 2.5em; | |
422 | + font-size: 12px; | |
423 | +} | |
424 | + | |
425 | +.section-specification table { | |
426 | + border-top: 1px solid #d6e0e5; | |
427 | +} | |
428 | + | |
429 | +.section-specification td { | |
430 | + vertical-align: top; | |
431 | + border-bottom: 1px solid #d6e0e5; | |
432 | + padding: .6em; | |
433 | +} | |
434 | + | |
435 | +.section-specification .specification-title { | |
436 | + font-weight: bold; | |
437 | +} | |
438 | + | |
439 | +/* @end */ | |
440 | + | |
441 | +/* @group Tasks section */ | |
442 | + | |
443 | +.task-list { | |
444 | + list-style-type: none; | |
445 | + padding-left: 0px; | |
446 | +} | |
447 | + | |
448 | +.task-list li { | |
449 | + margin-bottom: 3px; | |
450 | +} | |
451 | + | |
452 | +.task-item-suffix { | |
453 | + color: #996; | |
454 | + font-size: 12px; | |
455 | + font-style: italic; | |
456 | + margin-left: 0.5em; | |
457 | +} | |
458 | + | |
459 | +span.tooltip span.tooltip { | |
460 | + font-size: 1.0em; | |
461 | + display: none; | |
462 | + padding: 0.3em; | |
463 | + border: 1px solid #aaa; | |
464 | + background-color: #fdfec8; | |
465 | + color: #000; | |
466 | + text-align: left; | |
467 | +} | |
468 | + | |
469 | +span.tooltip:hover span.tooltip { | |
470 | + display: block; | |
471 | + position: absolute; | |
472 | + margin-left: 2em; | |
473 | +} | |
474 | + | |
475 | +/* @end */ | |
476 | + | |
477 | +/* @group Method section */ | |
478 | + | |
479 | +.section-method { | |
480 | + margin-top: 2.3em; | |
481 | +} | |
482 | + | |
483 | +.method-title { | |
484 | + margin-bottom: 1.5em; | |
485 | +} | |
486 | + | |
487 | +.method-subtitle { | |
488 | + margin-top: 0.7em; | |
489 | + margin-bottom: 0.2em; | |
490 | +} | |
491 | + | |
492 | +.method-subsection p { | |
493 | + margin-top: 0.4em; | |
494 | + margin-bottom: 0.8em; | |
495 | +} | |
496 | + | |
497 | +.method-declaration { | |
498 | + margin-top:1.182em; | |
499 | + margin-bottom:.909em; | |
500 | +} | |
501 | + | |
502 | +.method-declaration code { | |
503 | + font:14px Courier, Consolas, monospace; | |
504 | + color:#000; | |
505 | +} | |
506 | + | |
507 | +.declaration { | |
508 | + color: #000; | |
509 | +} | |
510 | + | |
511 | +.argument-def { | |
512 | + margin-top: 0.3em; | |
513 | + margin-bottom: 0.3em; | |
514 | +} | |
515 | + | |
516 | +.argument-def dd { | |
517 | + margin-left: 1.25em; | |
518 | +} | |
519 | + | |
520 | +.see-also-section ul { | |
521 | + list-style-type: none; | |
522 | + padding-left: 0px; | |
523 | + margin-top: 0; | |
524 | +} | |
525 | + | |
526 | +.see-also-section li { | |
527 | + margin-bottom: 3px; | |
528 | +} | |
529 | + | |
530 | +.declared-in-ref { | |
531 | + color: #666; | |
532 | +} | |
533 | + | |
534 | +/* @end */ | |
535 | + |
@@ -0,0 +1,22 @@ | ||
1 | + | |
2 | +header { | |
3 | + display: none; | |
4 | +} | |
5 | + | |
6 | +div.main-navigation, div.navigation-top { | |
7 | + display: none; | |
8 | +} | |
9 | + | |
10 | +div#overview_contents, div#contents.isShowingTOC, div#contents { | |
11 | + overflow: visible; | |
12 | + position: relative; | |
13 | + top: 0px; | |
14 | + border: none; | |
15 | + left: 0; | |
16 | +} | |
17 | +#tocContainer.isShowingTOC { | |
18 | + display: none; | |
19 | +} | |
20 | +nav { | |
21 | + display: none; | |
22 | +} | |
\ No newline at end of file |
@@ -0,0 +1,84 @@ | ||
1 | +<!DOCTYPE HTML> | |
2 | +<html> | |
3 | + <head> | |
4 | + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
5 | + <title>CDEvents Hierarchy</title> | |
6 | + <link rel="stylesheet" type="text/css" href="css/styles.css" media="all" /> | |
7 | + <link rel="stylesheet" type="text/css" media="print" href="css/stylesPrint.css" /> | |
8 | + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> | |
9 | + </head> | |
10 | + <body> | |
11 | + <header id="top_header"> | |
12 | + <div id="library" class="hideInXcode"> | |
13 | + <h1><a id="libraryTitle" href="index.html">CDEvents </a></h1> | |
14 | + <a id="developerHome" href="index.html">Aron Cedercrantz</a> | |
15 | + </div> | |
16 | + | |
17 | + <div id="title" role="banner"> | |
18 | + <h1 class="hideInXcode">CDEvents Hierarchy</h1> | |
19 | + </div> | |
20 | + <ul id="headerButtons" role="toolbar"></ul> | |
21 | + </header> | |
22 | + <article> | |
23 | + <div id="overview_contents" role="main"> | |
24 | + <div class="main-navigation navigation-top"> | |
25 | + <a href="index.html">Previous</a> | |
26 | + </div> | |
27 | + <div id="header"> | |
28 | + <div class="section-header"> | |
29 | + <h1 class="title title-header">CDEvents Hierarchy</h1> | |
30 | + </div> | |
31 | + </div> | |
32 | + <div id="container"> | |
33 | + | |
34 | + <div class="index-column hierarchy-column"> | |
35 | + <h2 class="index-title">Class Hierarchy</h2> | |
36 | + | |
37 | + <ul> | |
38 | + | |
39 | + <li>NSObject | |
40 | + <ul> | |
41 | + | |
42 | + <li><a href="Classes/CDEvent.html">CDEvent</a></li> | |
43 | + | |
44 | + <li><a href="Classes/CDEvents.html">CDEvents</a></li> | |
45 | + | |
46 | + </ul> | |
47 | +</li> | |
48 | + | |
49 | + </ul> | |
50 | + | |
51 | + </div> | |
52 | + | |
53 | + | |
54 | + | |
55 | + <div class="index-column"> | |
56 | + | |
57 | + <h2 class="index-title">Protocol References</h2> | |
58 | + <ul> | |
59 | + | |
60 | + <li><a href="Protocols/CDEventsDelegate.html">CDEventsDelegate</a></li> | |
61 | + | |
62 | + </ul> | |
63 | + | |
64 | + | |
65 | + </div> | |
66 | + | |
67 | + </div> | |
68 | + <div class="main-navigation navigation-bottom"> | |
69 | + <a href="index.html">Previous</a> | |
70 | + </div> | |
71 | + <div id="footer"> | |
72 | + <hr /> | |
73 | + <div class="footer-copyright"> | |
74 | + <p><span class="copyright">© 2011 Aron Cedercrantz. All rights reserved. (Last updated: 2011-11-02)</span><br /> | |
75 | + | |
76 | + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> | |
77 | + | |
78 | + | |
79 | + </div> | |
80 | + </div> | |
81 | + </div> | |
82 | + </article> | |
83 | + </body> | |
84 | +</html> | |
\ No newline at end of file |
@@ -0,0 +1,78 @@ | ||
1 | +<!DOCTYPE HTML> | |
2 | +<html> | |
3 | + <head> | |
4 | + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
5 | + <title>CDEvents Reference</title> | |
6 | + <link rel="stylesheet" type="text/css" href="css/styles.css" media="all" /> | |
7 | + <link rel="stylesheet" type="text/css" media="print" href="css/stylesPrint.css" /> | |
8 | + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> | |
9 | + </head> | |
10 | + <body> | |
11 | + <header id="top_header"> | |
12 | + <div id="library" class="hideInXcode"> | |
13 | + <h1><a id="libraryTitle" href="index.html">CDEvents </a></h1> | |
14 | + <a id="developerHome" href="index.html">Aron Cedercrantz</a> | |
15 | + </div> | |
16 | + | |
17 | + <div id="title" role="banner"> | |
18 | + <h1 class="hideInXcode">CDEvents Reference</h1> | |
19 | + </div> | |
20 | + <ul id="headerButtons" role="toolbar"></ul> | |
21 | + </header> | |
22 | + <article> | |
23 | + <div id="overview_contents" role="main"> | |
24 | + <div class="main-navigation navigation-top"> | |
25 | + <a href="hierarchy.html">Next</a> | |
26 | + </div> | |
27 | + <div id="header"> | |
28 | + <div class="section-header"> | |
29 | + <h1 class="title title-header">CDEvents Reference</h1> | |
30 | + </div> | |
31 | + </div> | |
32 | + <div id="container"> | |
33 | + | |
34 | + | |
35 | + | |
36 | + <div class="index-column"> | |
37 | + <h2 class="index-title">Class References</h2> | |
38 | + <ul> | |
39 | + | |
40 | + <li><a href="Classes/CDEvent.html">CDEvent</a></li> | |
41 | + | |
42 | + <li><a href="Classes/CDEvents.html">CDEvents</a></li> | |
43 | + | |
44 | + </ul> | |
45 | + </div> | |
46 | + | |
47 | + | |
48 | + | |
49 | + <div class="index-column"> | |
50 | + | |
51 | + <h2 class="index-title">Protocol References</h2> | |
52 | + <ul> | |
53 | + | |
54 | + <li><a href="Protocols/CDEventsDelegate.html">CDEventsDelegate</a></li> | |
55 | + | |
56 | + </ul> | |
57 | + | |
58 | + | |
59 | + </div> | |
60 | + | |
61 | + </div> | |
62 | + <div class="main-navigation navigation-bottom"> | |
63 | + <a href="hierarchy.html">Next</a> | |
64 | + </div> | |
65 | + <div id="footer"> | |
66 | + <hr /> | |
67 | + <div class="footer-copyright"> | |
68 | + <p><span class="copyright">© 2011 Aron Cedercrantz. All rights reserved. (Last updated: 2011-11-02)</span><br /> | |
69 | + | |
70 | + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> | |
71 | + | |
72 | + | |
73 | + </div> | |
74 | + </div> | |
75 | + </div> | |
76 | + </article> | |
77 | + </body> | |
78 | +</html> | |
\ No newline at end of file |