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