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