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