epoc32/include/mw/AknNotify.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/AknNotify.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,103 @@
     1.4 +/*
     1.5 +* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +#ifndef __AKNNOTIFY_H__
    1.22 +#define __AKNNOTIFY_H__
    1.23 +
    1.24 +// INCLUDES
    1.25 +#include <e32base.h>
    1.26 +
    1.27 +// FORWARD DECLARATIONS 
    1.28 +class CAknSDData;
    1.29 +
    1.30 +// CLASS DECLARATION
    1.31 +class RNotifier2 : public RNotifier
    1.32 +    {
    1.33 +public:
    1.34 +    TInt Connect();
    1.35 +    };
    1.36 +    
    1.37 +/**
    1.38 +*  Base class for handling @c RNotifier.
    1.39 +*
    1.40 +*  @since S60 0.9
    1.41 +*/
    1.42 +NONSHARABLE_CLASS(CAknNotifyBase) : public CBase
    1.43 +    {
    1.44 +public:
    1.45 +    /**
    1.46 +    * Destructor.
    1.47 +    */
    1.48 +    IMPORT_C ~CAknNotifyBase();
    1.49 +
    1.50 +    /**
    1.51 +     * @since S60 3.1
    1.52 +     * Sets additional information to be sent to secondary display.
    1.53 +     * Takes ownership of object.
    1.54 +     * Must be called before sending data to notifier to have effect.
    1.55 +     * @internal to S60
    1.56 +     *
    1.57 +     * @aparam aData data to be sent to cover UI
    1.58 +     */
    1.59 +    IMPORT_C void SetSecondaryDisplayData(CAknSDData* aData);
    1.60 +
    1.61 +protected:
    1.62 +    /**
    1.63 +    * C++ constructor.
    1.64 +    * @param aUid The UID identifying the plug-in notifier.
    1.65 +    */
    1.66 +    CAknNotifyBase(TUid aUid);
    1.67 +    
    1.68 +    /**
    1.69 +    * 2nd phase constructor.
    1.70 +    * Connects to the notifier server.
    1.71 +    */
    1.72 +    void ConstructL();
    1.73 +    
    1.74 +    /**
    1.75 +    * Starts or updates the notifier.
    1.76 +    * @param aBuffer Data that can be passed to notifier.
    1.77 +    * @param aResponse Data that can be returned by notifier.
    1.78 +    */
    1.79 +    void StartOrUpdateL(const TDesC8& aBuffer, TDes8& aResponse);
    1.80 +    
    1.81 +    /**
    1.82 +    * Starts the notifier.
    1.83 +    * @param aStatus The request status.
    1.84 +    * @param aBuffer Data that can be passed to the notifier.
    1.85 +    * @param aResponse Data that can be returned by the notifier.
    1.86 +    */
    1.87 +    void StartOrUpdateAndGetResponseL(
    1.88 +        TRequestStatus& aStatus,
    1.89 +        const TDesC8& aBuffer,
    1.90 +        TDes8& aResponse);
    1.91 +                                                                            
    1.92 +    // We don't give this funtionality out of library at the moment
    1.93 +    // returns instance of secondary display data if set.
    1.94 +    CAknSDData* SecondaryDisplayData();
    1.95 +                                                                          
    1.96 +private:
    1.97 +    IMPORT_C void CAknNotifyBase_Reserved();
    1.98 +
    1.99 +private:
   1.100 +    TUid iUid;
   1.101 +    TBool iStarted;
   1.102 +    RNotifier2 iNotify;
   1.103 +    CAknSDData* iSecondaryDisplayData;
   1.104 +    };
   1.105 +
   1.106 +#endif // __AKNNOTIFY_H__