xref: /AOO41X/main/apple_remote/inc/HIDRemoteControlDevice.h (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*****************************************************************************
2  * HIDRemoteControlDevice.h
3  * RemoteControlWrapper
4  *
5  * Created by Martin Kahr on 11.03.06 under a MIT-style license.
6  * Copyright (c) 2006 martinkahr.com. All rights reserved.
7  *
8  * Code modified and adapted to OpenOffice.org
9  * by Eric Bachard on 11.08.2008 under the same license
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included
19  * in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED ‚ÄúAS IS‚Äù, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27  * THE SOFTWARE.
28  *
29  *****************************************************************************/
30 
31 #import <Cocoa/Cocoa.h>
32 #import <IOKit/hid/IOHIDLib.h>
33 
34 #import "RemoteControl.h"
35 
36 /*
37     Base class for HID based remote control devices
38  */
39 @interface HIDRemoteControlDevice : RemoteControl {
40     IOHIDDeviceInterface** hidDeviceInterface; // see IOKit/hid/IOHIDLib.h
41     IOHIDQueueInterface**  queue;  // IOKit/hid/IOHIDLib.h
42     NSMutableArray*        allCookies;
43     NSMutableDictionary*   cookieToButtonMapping;
44     CFRunLoopSourceRef     eventSource;
45 
46     BOOL fixSecureEventInputBug;
47     BOOL openInExclusiveMode;
48     BOOL processesBacklog;
49 
50     int supportedButtonEvents;
51 }
52 
53 // When your application needs to much time on the main thread when processing an event other events
54 // may already be received which are put on a backlog. As soon as your main thread
55 // has some spare time this backlog is processed and may flood your delegate with calls.
56 // Backlog processing is turned off by default.
57 - (BOOL) processesBacklog;
58 - (void) setProcessesBacklog: (BOOL) value;
59 
60 // methods that should be overwritten by subclasses
61 - (void) setCookieMappingInDictionary: (NSMutableDictionary*) cookieToButtonMapping;
62 
63 - (void) sendRemoteButtonEvent: (RemoteControlEventIdentifier) event pressedDown: (BOOL) pressedDown;
64 
65 + (BOOL) isRemoteAvailable;
66 
67 @end
68