psln/PslnLibraryLoaders/inc/pslnxnclientloader.h
changeset 37 89c890c70182
parent 34 6b5204869ed5
child 45 667edd0b8678
equal deleted inserted replaced
34:6b5204869ed5 37:89c890c70182
     1 /*
       
     2 * Copyright (c) 2006-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:  Loads dynamically XnClient.dll.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_PSLNXNCLIENTLOADER
       
    20 #define C_PSLNXNCLIENTLOADER
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class CXnODT;
       
    25 class MXnThemeManagementServiceObserver;
       
    26 class CXnClient;
       
    27 
       
    28 /**
       
    29 *  Interface class for browser launch.
       
    30 *  
       
    31 *  @lib PslnXNClientLoader.lib
       
    32 *  @since Series 60 3.1
       
    33 */
       
    34 class MPslnXNClientLoader
       
    35     {
       
    36     public:
       
    37         
       
    38         /**
       
    39         * Pure virtual method for searching for relevant themes.
       
    40         * @param aSearchMask mask to use when searching themes (contains app UID).
       
    41         * @param aHeaderList list to append found themes to.
       
    42         * @return result of operation
       
    43         */
       
    44         virtual TXnServiceCompletedMessage GetListHeaders( 
       
    45             const CXnODT& aSearchMask,
       
    46             CArrayPtrFlat<CXnODT>& aHeaderList ) = 0;
       
    47 
       
    48         /**
       
    49         * Pure virtual method for applying active theme.
       
    50         * @param aSetMask mask to use when applying theme (contains skin UID).
       
    51         * @param aHeader on return this will contain the activated theme info.
       
    52         * @return result of operation
       
    53         */
       
    54         virtual TXnServiceCompletedMessage SetActiveTheme( 
       
    55             const CXnODT& aSetMask, 
       
    56             CXnODT& aHeader ) = 0;
       
    57 
       
    58         /**
       
    59         * Pure virtual method for getting the next found theme.
       
    60         */
       
    61         virtual void GetNextHeader() = 0;
       
    62 
       
    63         /**
       
    64         * Pure virtual method for cancelling theme list query.
       
    65         * @return result of operation
       
    66         */
       
    67         virtual TXnServiceCompletedMessage CancelGetListHeaders() = 0;
       
    68 
       
    69         /**
       
    70         * Pure virtual method for creating the XnClient object.
       
    71         * @param aObserver observer for XnClient.
       
    72         */
       
    73         virtual void CreateClientL( 
       
    74             MXnThemeManagementServiceObserver& aObserver ) = 0;
       
    75     };
       
    76 
       
    77 /**
       
    78 *  This class is for dynamically loading ProfilesSettingsView.dll that 
       
    79 *  enables setting of ringing tone for all profiles.
       
    80 *
       
    81 *  @lib PslnXNClientLoader.lib
       
    82 *  @since Series 60 3.1
       
    83 */
       
    84 class CPslnXNClientLoader : public CBase, public MPslnXNClientLoader
       
    85     {
       
    86 public:
       
    87     /**
       
    88     * Two-phased constructor.
       
    89     * @return new instance of CPslnXNClientLoader.
       
    90     */
       
    91     static CPslnXNClientLoader* NewL();
       
    92     
       
    93     /**
       
    94     * Destructor.
       
    95     */
       
    96     virtual ~CPslnXNClientLoader();
       
    97 
       
    98     /**
       
    99     * Searches for relevant application themes.
       
   100     * @param aSearchMask mask to use when searching themes (contains app UID).
       
   101     * @param aHeaderList list to append found themes to.
       
   102     * @return result of operation
       
   103     */
       
   104     TXnServiceCompletedMessage GetListHeaders( 
       
   105         const CXnODT& aSearchMask,
       
   106         CArrayPtrFlat<CXnODT>& aHeaderList );
       
   107 
       
   108     /**
       
   109     * Applies active theme.
       
   110     * @param aSetMask mask to use when applying theme (contains skin UID).
       
   111     * @param aHeader on return this will contain the activated theme info.
       
   112     * @return result of operation
       
   113     */
       
   114     TXnServiceCompletedMessage SetActiveTheme( 
       
   115         const CXnODT& aSetMask, 
       
   116         CXnODT& aHeader );
       
   117 
       
   118     /**
       
   119     * Gets the next found theme.
       
   120     */
       
   121     void GetNextHeader();
       
   122 
       
   123     /**
       
   124     * Cancels theme list query.
       
   125     * @return result of operation
       
   126     */
       
   127     TXnServiceCompletedMessage CancelGetListHeaders();
       
   128 
       
   129     /**
       
   130     * Creates the XnClient object.
       
   131     * @param aObserver observer for XnClient.
       
   132     */
       
   133     void CreateClientL( 
       
   134         MXnThemeManagementServiceObserver& aObserver );
       
   135 
       
   136 private:
       
   137 
       
   138     /**
       
   139     * C++ default constructor.
       
   140     */
       
   141     CPslnXNClientLoader();
       
   142 
       
   143 private:
       
   144 
       
   145     /**
       
   146     * Xuikon client interface for applying theme changes.
       
   147     * Own.
       
   148     */
       
   149     CXnClient* iXknClient;
       
   150 
       
   151     };
       
   152 
       
   153 // Environment gate function
       
   154 IMPORT_C TAny* GateFunction( TAny* aObserver );
       
   155 
       
   156 #endif // C_PSLNXNCLIENTLOADER
       
   157             
       
   158 // End of File