source: trunk/SapphireLeopardFileEvents.h @ 427

Revision 427, 1.6 KB checked in by gbooker, 6 years ago (diff)

Added some missing documentation

Line 
1/*
2 * SapphireLeopardFileEvents.h
3 * Sapphire
4 *
5 * Created by Graham Booker on Dec. 19, 2007.
6 * Copyright 2007 Sapphire Development Team and/or www.nanopi.net
7 * All rights reserved.
8 *
9 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
10 * General Public License as published by the Free Software Foundation; either version 3 of the License,
11 * or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
14 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
15 * Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along with this program; if not,
18 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19 */
20
21#import <Cocoa/Cocoa.h>
22
23@class SapphireMetaDataCollection;
24
25/*!
26 * @brief Leopard only file event responding
27 *
28 * Leopard has an API to register for file change events within certain paths.  While it is possible to do the same thing in Tiger (AppleTV), this requires a completly different method, involving kernel APIs.
29 */
30@interface SapphireLeopardFileEvents : NSObject {
31        SapphireMetaDataCollection              *collection;    /*!< @brief The metadata collection*/
32        FSEventStreamRef                                stream;                 /*!< @brief The file event stream*/
33}
34/*!
35 * @brief Create a new file event watcher for a given collection
36 *
37 * @param coll The collection to watch
38 */
39- (id)initWithCollection:(SapphireMetaDataCollection *)coll;
40@end
Note: See TracBrowser for help on using the repository browser.