localconnectivityservice/locod/commoninc/locodservicepluginparams.h
author hgs
Fri, 25 Jun 2010 16:54:01 +0800
changeset 29 3ae5cb0b4c02
permissions -rw-r--r--
201025_07
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     1
/*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     3
* All rights reserved.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     8
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
     9
* Initial Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    11
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    12
* Contributors:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    13
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    14
* Description:  This is the LCD Service Plugin construction parameters
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    15
*                declaration
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    16
*
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    17
*/
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    18
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    19
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    20
#ifndef T_LOCODSERVICEPLUGINPARAMS_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    21
#define T_LOCODSERVICEPLUGINPARAMS_H
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    22
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    23
class MLocodServicePluginObserver;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    24
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    25
/**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    26
 *  LCD Service Plugin Callback construction parameters
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    27
 *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    28
 *  This interface class is used to pass construction parameters to the
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    29
 *  plugins.  These parameters include the callback interface (usually
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    30
 *  implemented by the LCD) and the ECOM plugin implementation UID 
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    31
 *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    32
 *  @lib ?library
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    33
 *  @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    34
 */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    35
class TLocodServicePluginParams
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    36
    {
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    37
public:
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    38
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    39
     * Constructor.
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    40
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    41
     * @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    42
     * @param  aUid      Implementation UID of the plugin being constructed
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    43
     * @param  aObserver Callback interface object
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    44
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    45
    TLocodServicePluginParams(TUid aUid, MLocodServicePluginObserver& aObserver);
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    46
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    47
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    48
     * Gets the implementation UID of the plugin
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    49
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    50
     * @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    51
     * @return Implementaion UID
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    52
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    53
    TUid ImplementationUid() const;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    54
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    55
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    56
     * Gets the observer interface object
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    57
     *
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    58
     * @since S60 v3.2
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    59
     * @return The observer object
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    60
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    61
    MLocodServicePluginObserver& Observer() const;    
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    62
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    63
private: // data
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    64
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    65
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    66
     * The implementation UID
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    67
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    68
    const TUid iImplementationUid;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    69
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    70
    /**
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    71
     * Reference to the observer object
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    72
     */
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    73
    MLocodServicePluginObserver& iObserver;
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    74
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    75
    };
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    76
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    77
#include "locodservicepluginparams.inl"
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    78
3ae5cb0b4c02 201025_07
hgs
parents:
diff changeset
    79
#endif // T_LOCODSERVICEPLUGINPARAMS_H