accessoryservices/remotecontrolfw/client/sidekeyapi/public/remconsidekeyapi.h
changeset 74 9d35fd98f273
equal deleted inserted replaced
69:dc67b94625c5 74:9d35fd98f273
       
     1 // Copyright (c) 2004-2010 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @publishedPartner
       
    19  @released
       
    20 */
       
    21 
       
    22 #ifndef REMCONSIDEKEYAPI_H
       
    23 #define REMCONSIDEKEYAPI_H
       
    24 
       
    25 #include <e32base.h>
       
    26 
       
    27 /** Offset in the operation-specific data of the 'result' (this field exists 
       
    28 in both commands and responses, but logically only applies to responses). */
       
    29 const TUint KRemConSideKeyApiResultDataOffset = 0;
       
    30 
       
    31 /** Length of the results data/field in bytes. */
       
    32 const TUint KRemConSideKeyApiResultDataLength = 4;
       
    33 
       
    34 /** Used for checking operation-specific data. The operation-specific data of 
       
    35 an Side Key API message must always contain at least a results field, so the length 
       
    36 of the results field is the minimum length of this 'packet'. */
       
    37 const TUint KRemConSideKeyApiMinimumDataLength = KRemConSideKeyApiResultDataLength;
       
    38 
       
    39 /**
       
    40 The UID identifying the Side Key outer-layer RemCon interface.
       
    41 */
       
    42 const TInt KRemConSideKeyApiUid = 0x2002FF91;
       
    43 
       
    44 /**
       
    45 Operation ids belonging to the Side Key interface.
       
    46 These are public so bearers/converters can access them.
       
    47 */
       
    48 enum TRemConSideKeyOperationId
       
    49 	{
       
    50 	/** Side key up pressed. */
       
    51 	ERemConSideKeyUp			= 0x00,
       
    52 	/** Side key down pressed. */
       
    53 	ERemConSideKeyDown			= 0x01,
       
    54 	};
       
    55 
       
    56 /** Length of the button action data in bytes. */
       
    57 const TUint KRemConSideKeyApiButtonDataLength = 1;
       
    58 
       
    59 /** Button actions. */
       
    60 enum TRemConSideKeyApiButtonAction
       
    61 	{
       
    62 	/** A button has been pressed. */
       
    63 	ERemConSideKeyApiButtonPress	= 0,
       
    64 	/** A button has been released. */
       
    65 	ERemConSideKeyApiButtonRelease 	= 1,
       
    66 	/** A button has been clicked. */
       
    67 	ERemConSideKeyApiButtonClick	= 2,
       
    68 	};
       
    69 
       
    70 #endif // REMCONSIDEKEYAPI_H