devsound/a3facf/inc/msynccisupport.h
author hgs
Thu, 07 Oct 2010 22:34:12 +0100
changeset 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
// All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
// Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
// Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
// Description:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
 @file
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
 @publishedPartner 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
 @released
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
#ifndef MSYNCCISUPPORT_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
#define MSYNCCISUPPORT_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
#include <e32base.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
#include <a3f/a3fbase.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
const TUid KUidExtensionInferface = { 0x1028348B };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
 * An interface to get notifications from Custom Interface state change.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
 */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
class MCustomInterfaceSupportObserver
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
	/* *
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
	 * Called to state that CI is being removed use depends on which type of CI is involved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
	 * @param aUid the Uid of the CI.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
	 *
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
	 * @param aPtr on returns contains a pointer to the CI.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
	 */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
	virtual void CustomInterfaceRemoval(TUid aInterfaceUid, TAny* aPtr) = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
 * An interface to get Custom Interface.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
 */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
class MCustomInterfaceSupport
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
	{
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
	 * Request custom interface associated with aUid. 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
	 * Whether multiple calls returns the same pointer and/or
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
	 * ownership is transferred depends on the specific uid. 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
	 *
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
	 * @param aUid the Uid of the CI .
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
	 * @param aPtr on returns contains a pointer to the CI.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
	 */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
	virtual TInt RequestCustomInterface(TUid aUid, TAny*& aPtr) = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
	 * Registers an interface support observer.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
	 *
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
	 * The observer will be notified when the custom interface has been removed .
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
	 *
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
	 * @param aObserver the observer reference to register.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
	 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
	 */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
	virtual TInt RegisterObserver(MCustomInterfaceSupportObserver& aObserver) = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
	/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
	 * Unregisters an interface support observer.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
	 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
	 * @param aObserver the observer reference to unregister.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
	 * @return An error code. KErrNone on success, otherwise one of the system wide error codes.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
 	 */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
	virtual void UnRegisterObserver(MCustomInterfaceSupportObserver& aObserver) = 0; 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
	};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
#endif  // MSYNCCISUPPORT_H