1 /*****************************************************************************
2 * MultiClickRemoteBehavior.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
32 #import <Cocoa/Cocoa.h>
33 #import "RemoteControl.h"
34
35 /**
36 A behavior that adds multiclick and hold events on top of a device.
37 Events are generated and send to a delegate
38 */
39 @interface MultiClickRemoteBehavior : NSObject {
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
init()56 - (id) init;
57
58 // Delegates are not retained
setDelegate:(id)59 - (void) setDelegate: (id) delegate;
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
simulateHoldEvent()65 - (BOOL) simulateHoldEvent;
setSimulateHoldEvent:(BOOL)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
clickCountingEnabled()74 - (BOOL) clickCountingEnabled;
setClickCountingEnabled:(BOOL)75 - (void) setClickCountingEnabled: (BOOL) value;
76
clickCountEnabledButtons()77 - (unsigned int) clickCountEnabledButtons;
setClickCountEnabledButtons:(unsigned int)78 - (void) setClickCountEnabledButtons: (unsigned int)value;
79
80 // the maximum time difference till which clicks are recognized as multi clicks
maximumClickCountTimeDifference()81 - (NSTimeInterval) maximumClickCountTimeDifference;
setMaximumClickCountTimeDifference:(NSTimeInterval)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
remoteButton:pressedDown:clickCount:(RemoteControlEventIdentifier,BOOL,unsigned int)91 - (void) remoteButton: (RemoteControlEventIdentifier)buttonIdentifier pressedDown: (BOOL) pressedDown clickCount: (unsigned int) count;
92
93 @end
94