epoc32/include/mw/mtclreg.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
williamr@2
    17
#if !defined __MTCLREG_H__
williamr@2
    18
#define __MTCLREG_H__
williamr@2
    19
williamr@2
    20
#include <e32base.h>		// CActive, TFileName etc.
williamr@2
    21
#include <msvreg.h>
williamr@2
    22
#include <msvapi.h>			// MMsvSessionObserver
williamr@2
    23
williamr@2
    24
// CObserverRegistry mixes in session notification API
williamr@2
    25
// this allows run-time update of the registries on the client-side.
williamr@2
    26
// the server registry should inherit from CMtmDllRegistry
williamr@2
    27
class CObserverRegistry : public CMtmDllRegistry, public MMsvSessionObserver
williamr@2
    28
/** Base class for client, UI and UI data MTM registries.
williamr@2
    29
williamr@2
    30
It implements the session observer interface to update the registry information 
williamr@2
    31
when MTM groups are installed or uninstalled.
williamr@2
    32
@publishedAll
williamr@2
    33
@released
williamr@2
    34
*/
williamr@2
    35
	{
williamr@2
    36
public:
williamr@2
    37
	IMPORT_C virtual void HandleSessionEventL(TMsvSessionEvent aEvent, TAny* aArg1, TAny* aArg2, TAny* aArg3);
williamr@2
    38
	IMPORT_C ~CObserverRegistry();
williamr@2
    39
williamr@2
    40
protected:
williamr@2
    41
	IMPORT_C CObserverRegistry(CMsvSession& aMsvSession,TUid aDllTypeUid,TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32);
williamr@2
    42
	IMPORT_C void ConstructL();
williamr@2
    43
williamr@2
    44
protected:
williamr@2
    45
	CMsvSession& iMsvSession;
williamr@2
    46
	TBool iIsAdded;
williamr@2
    47
	};
williamr@2
    48
williamr@2
    49
// Client side MTM registry
williamr@2
    50
class CClientMtmRegistry : public CObserverRegistry
williamr@2
    51
/** Accesses the Client-side MTM registry. 
williamr@2
    52
williamr@2
    53
This registry holds details of the all the Client-side MTMs currently available 
williamr@2
    54
on the system. Message client applications use this class to get a CBaseMtm-derived 
williamr@2
    55
object by which to access Client-side MTM functionality.
williamr@2
    56
williamr@2
    57
Note that the base class CMtmDllRegistry provides functions for discovering 
williamr@2
    58
what MTMs are present in the registry.
williamr@2
    59
 
williamr@2
    60
@publishedAll
williamr@2
    61
@released
williamr@2
    62
*/
williamr@2
    63
	{
williamr@2
    64
public:
williamr@2
    65
	IMPORT_C static CClientMtmRegistry* NewL(CMsvSession& aMsvSession, TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32=TTimeIntervalMicroSeconds32(30000000));
williamr@2
    66
	IMPORT_C ~CClientMtmRegistry();
williamr@2
    67
	IMPORT_C CBaseMtm* NewMtmL(TUid aMtmTypeUid);
williamr@2
    68
	//
williamr@2
    69
protected:
williamr@2
    70
	CClientMtmRegistry(CMsvSession& aMsvSession,TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32);
williamr@2
    71
	void ConstructL();
williamr@2
    72
	//
williamr@2
    73
private:
williamr@2
    74
	CBaseMtm* DoNewMtmL(const RLibrary& aLib, CRegisteredMtmDll& aReg) const;
williamr@2
    75
	};
williamr@2
    76
williamr@2
    77
#endif // __MTCLREG_H__