epoc32/include/mw/AknNotify.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
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@4
     1
/*
williamr@4
     2
* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description: 
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@4
    18
#ifndef __AKNNOTIFY_H__
williamr@4
    19
#define __AKNNOTIFY_H__
williamr@4
    20
williamr@4
    21
// INCLUDES
williamr@4
    22
#include <e32base.h>
williamr@4
    23
williamr@4
    24
// FORWARD DECLARATIONS 
williamr@4
    25
class CAknSDData;
williamr@4
    26
williamr@4
    27
// CLASS DECLARATION
williamr@4
    28
class RNotifier2 : public RNotifier
williamr@4
    29
    {
williamr@4
    30
public:
williamr@4
    31
    TInt Connect();
williamr@4
    32
    };
williamr@4
    33
    
williamr@4
    34
/**
williamr@4
    35
*  Base class for handling @c RNotifier.
williamr@4
    36
*
williamr@4
    37
*  @since S60 0.9
williamr@4
    38
*/
williamr@4
    39
NONSHARABLE_CLASS(CAknNotifyBase) : public CBase
williamr@4
    40
    {
williamr@4
    41
public:
williamr@4
    42
    /**
williamr@4
    43
    * Destructor.
williamr@4
    44
    */
williamr@4
    45
    IMPORT_C ~CAknNotifyBase();
williamr@4
    46
williamr@4
    47
    /**
williamr@4
    48
     * @since S60 3.1
williamr@4
    49
     * Sets additional information to be sent to secondary display.
williamr@4
    50
     * Takes ownership of object.
williamr@4
    51
     * Must be called before sending data to notifier to have effect.
williamr@4
    52
     * @internal to S60
williamr@4
    53
     *
williamr@4
    54
     * @aparam aData data to be sent to cover UI
williamr@4
    55
     */
williamr@4
    56
    IMPORT_C void SetSecondaryDisplayData(CAknSDData* aData);
williamr@4
    57
williamr@4
    58
protected:
williamr@4
    59
    /**
williamr@4
    60
    * C++ constructor.
williamr@4
    61
    * @param aUid The UID identifying the plug-in notifier.
williamr@4
    62
    */
williamr@4
    63
    CAknNotifyBase(TUid aUid);
williamr@4
    64
    
williamr@4
    65
    /**
williamr@4
    66
    * 2nd phase constructor.
williamr@4
    67
    * Connects to the notifier server.
williamr@4
    68
    */
williamr@4
    69
    void ConstructL();
williamr@4
    70
    
williamr@4
    71
    /**
williamr@4
    72
    * Starts or updates the notifier.
williamr@4
    73
    * @param aBuffer Data that can be passed to notifier.
williamr@4
    74
    * @param aResponse Data that can be returned by notifier.
williamr@4
    75
    */
williamr@4
    76
    void StartOrUpdateL(const TDesC8& aBuffer, TDes8& aResponse);
williamr@4
    77
    
williamr@4
    78
    /**
williamr@4
    79
    * Starts the notifier.
williamr@4
    80
    * @param aStatus The request status.
williamr@4
    81
    * @param aBuffer Data that can be passed to the notifier.
williamr@4
    82
    * @param aResponse Data that can be returned by the notifier.
williamr@4
    83
    */
williamr@4
    84
    void StartOrUpdateAndGetResponseL(
williamr@4
    85
        TRequestStatus& aStatus,
williamr@4
    86
        const TDesC8& aBuffer,
williamr@4
    87
        TDes8& aResponse);
williamr@4
    88
                                                                            
williamr@4
    89
    // We don't give this funtionality out of library at the moment
williamr@4
    90
    // returns instance of secondary display data if set.
williamr@4
    91
    CAknSDData* SecondaryDisplayData();
williamr@4
    92
                                                                          
williamr@4
    93
private:
williamr@4
    94
    IMPORT_C void CAknNotifyBase_Reserved();
williamr@4
    95
williamr@4
    96
private:
williamr@4
    97
    TUid iUid;
williamr@4
    98
    TBool iStarted;
williamr@4
    99
    RNotifier2 iNotify;
williamr@4
   100
    CAknSDData* iSecondaryDisplayData;
williamr@4
   101
    };
williamr@4
   102
williamr@4
   103
#endif // __AKNNOTIFY_H__