apple_remote/source/HIDRemoteControlDevice.h

   1 /* -*- Mode: ObjC; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*****************************************************************************
   3  * HIDRemoteControlDevice.h
   4  * RemoteControlWrapper
   5  *
   6  * Created by Martin Kahr on 11.03.06 under a MIT-style license.
   7  * Copyright (c) 2006 martinkahr.com. All rights reserved.
   8  *
   9  * Code modified and adapted to OpenOffice.org
  10  * by Eric Bachard on 11.08.2008 under the same license
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a
  13  * copy of this software and associated documentation files (the "Software"),
  14  * to deal in the Software without restriction, including without limitation
  15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  16  * and/or sell copies of the Software, and to permit persons to whom the
  17  * Software is furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included
  20  * in all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  25  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  28  * THE SOFTWARE.
  29  *
  30  *****************************************************************************/
  31
  32 #import <apple_remote/RemoteControl.h>
  33
  34 #import <IOKit/hid/IOHIDLib.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 too 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
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */