apple_remote/source/MultiClickRemoteBehavior.h

   1 /* -*- Mode: ObjC; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*****************************************************************************
   3  * MultiClickRemoteBehavior.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 /**
  35     A behavior that adds multiclick and hold events on top of a device.
  36     Events are generated and send to a delegate
  37  */
  38 @interface MultiClickRemoteBehavior : NSObject
  39 {
  40     id delegate;
  41
  42     // state for simulating plus/minus hold
  43     BOOL simulateHoldEvents;
  44     BOOL lastEventSimulatedHold;
  45     RemoteControlEventIdentifier lastHoldEvent;
  46     NSTimeInterval lastHoldEventTime;
  47
  48     // state for multi click
  49     unsigned int clickCountEnabledButtons;
  50     NSTimeInterval maxClickTimeDifference;
  51     NSTimeInterval lastClickCountEventTime;
  52     RemoteControlEventIdentifier lastClickCountEvent;
  53     unsigned int eventClickCount;
  54 }
  55
  56 - (id)init;
  57
  58 // Delegates are not retained
  59 - (void)setDelegate:(id)delegate;
  60 - (id)delegate;
  61
  62 // Simulating hold events does deactivate sending of individual requests for pressed down/released.
  63 // Instead special hold events are being triggered when the user is pressing and holding a button for a small period.
  64 // Simulation is activated only for those buttons and remote control that do not have a separate event already
  65 - (BOOL)simulateHoldEvent;
  66 - (void)setSimulateHoldEvent:(BOOL)value;
  67
  68 // click counting makes it possible to recognize if the user has pressed a button repeatedly
  69 // click counting does delay each event as it has to wait if there is another event (second click)
  70 // therefore there is a slight time difference (maximumClickCountTimeDifference) between a single click
  71 // of the user and the call of your delegate method
  72 // click counting can be enabled individually for specific buttons. Use the property clickCountEnableButtons to
  73 // set the buttons for which click counting shall be enabled
  74 - (BOOL)clickCountingEnabled;
  75 - (void)setClickCountingEnabled:(BOOL)value;
  76
  77 - (unsigned int)clickCountEnabledButtons;
  78 - (void)setClickCountEnabledButtons:(unsigned int)value;
  79
  80 // the maximum time difference till which clicks are recognized as multi clicks
  81 - (NSTimeInterval)maximumClickCountTimeDifference;
  82 - (void)setMaximumClickCountTimeDifference:(NSTimeInterval)timeDiff;
  83
  84 @end
  85
  86 /*
  87  * Method definitions for the delegate of the MultiClickRemoteBehavior class
  88  */
  89 @interface NSObject (MultiClickRemoteBehaviorDelegate)
  90
  91 - (void)remoteButton:(RemoteControlEventIdentifier)buttonIdentifier
  92          pressedDown:(BOOL)pressedDown
  93           clickCount:(unsigned int)count;
  94
  95 @end
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */