classicui_plat/personalisation_framework_api/inc/MPslnFWAppThemeObserver.h
changeset 37 89c890c70182
parent 34 6b5204869ed5
child 45 667edd0b8678
equal deleted inserted replaced
34:6b5204869ed5 37:89c890c70182
     1 /*
       
     2 * Copyright (c) 2005-2006 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:  Observer interface for application specific theme events.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPSLNFWAPPTHEMEOBSERVER_H
       
    20 #define MPSLNFWAPPTHEMEOBSERVER_H
       
    21 
       
    22 #include <e32base.h>
       
    23 #include <XnThemeManagement.h>
       
    24 
       
    25 class CXnODT;
       
    26 
       
    27 /**
       
    28  *  Observer interface for application specific theme events.
       
    29  *
       
    30  *  PslnFramework passes events from XUIKON through this observer.
       
    31  *
       
    32  *  @lib PslnFramework.lib
       
    33  *  @since S60 3.1
       
    34  */
       
    35 class MPslnFWAppThemeObserver
       
    36     {
       
    37 
       
    38 public:
       
    39 
       
    40     /**
       
    41      * New indication of application's theme list. Implementation of this
       
    42      * MUST NOT leave.
       
    43      *
       
    44      * @param aMessage indication message. Can be one of the following:
       
    45      * 
       
    46      *   EXnGetListHeadersEmpty    - no themes currently available, please destroy 
       
    47      *                               existing list of themes (if given previously)
       
    48      *   EXnGetListHeadersFailed   - theme retrieval failed, updates are not working.
       
    49      *   EXnServiceRequestCanceled - theme retrieval has been cancelled.
       
    50      *   EXnServiceRequestError    - an error occured while retrieving latest theme, 
       
    51      *                               theme updation is still ongoing.
       
    52      */
       
    53     virtual void HandleMessage( TXnServiceCompletedMessage aMessage ) = 0;
       
    54 
       
    55     /**
       
    56      * New indication of application's theme list. Implementation of this
       
    57      * MUST NOT leave. 
       
    58      *
       
    59      * @param aMessage indication message. Can be one of the following:
       
    60      * 
       
    61      *   EXnGetListHeadersUpdate  - either a new skin has appeared, or framework
       
    62      *                              has received all applicable skins from server.
       
    63      *   EXnGetListHeadersRestart - old application theme list is not 
       
    64      *                              valid anymore, please use the new one.
       
    65      * @param aAppThemeList list of themes
       
    66      */
       
    67     virtual void HandleMessage( 
       
    68         const TXnServiceCompletedMessage aMessage,
       
    69         CArrayPtrFlat<CXnODT>& aAppThemeList ) = 0;
       
    70     };
       
    71 
       
    72 
       
    73 #endif // MPSLNFWAPPTHEMEOBSERVER_H