psln/PslnLibraryLoaders/inc/pslnwallpaperutilsloader.h
changeset 0 2f259fa3e83a
child 14 3320e4e6e8bb
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     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 AknsWallpaperUtils dynamically.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_PSLNWALLPAPERUTILSLOADER
       
    20 #define C_PSLNWALLPAPERUTILSLOADER
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 /**
       
    25 *  Interface class for wallpaper utils library.
       
    26 *  
       
    27 *  @lib PslnWallpaperUtilsLoader.lib
       
    28 *  @since Series 60 3.1
       
    29 */
       
    30 class MPslnWallpaperUtilsLoader
       
    31     {
       
    32     public:
       
    33         
       
    34         /**
       
    35         * Pure virtual method for setting Idle wallpaper.
       
    36         * @param aFilename filename of image.
       
    37         * @param aCoeEnv coe environment.
       
    38         * @param aWaitNoteTextResourceID wait note text if any.
       
    39         * @param aWaitNoteResourceID resource ID for wait note, if any.
       
    40         * @return error code, or KErrNone.
       
    41         */
       
    42         virtual TInt SetIdleWallpaper( 
       
    43             const TDesC& aFilename, 
       
    44             CCoeEnv* aCoeEnv, 
       
    45             TInt aWaitNoteTextResourceID = 0, 
       
    46             TInt aWaitNoteResourceID = 0 ) = 0;
       
    47 
       
    48     };
       
    49 
       
    50 /**
       
    51 *  This class is for dynamically loading AknsWallpaperUtils.dll that 
       
    52 *  enables setting of wallpaper.
       
    53 *
       
    54 *  @lib PslnWallpaperUtilsLoader.lib
       
    55 *  @since Series 60 3.1
       
    56 */
       
    57 class CPslnWallpaperUtilsLoader : public CBase, public MPslnWallpaperUtilsLoader
       
    58     {
       
    59 public:
       
    60     /**
       
    61     * Two-phased constructor.
       
    62     * @return new instance of CPslnWallpaperUtilsLoader.
       
    63     */
       
    64     static CPslnWallpaperUtilsLoader* NewL();
       
    65     
       
    66     /**
       
    67     * Destructor.
       
    68     */
       
    69     virtual ~CPslnWallpaperUtilsLoader();
       
    70 
       
    71     /**
       
    72     * Sets Idle wallpaper.
       
    73     * @param aFilename filename of image.
       
    74     * @param aCoeEnv coe environment.
       
    75     * @param aWaitNoteTextResourceID wait note text if any.
       
    76     * @param aWaitNoteResourceID resource ID for wait note, if any.
       
    77     * @return error code, or KErrNone.
       
    78     */
       
    79     TInt SetIdleWallpaper( 
       
    80         const TDesC& aFilename, 
       
    81         CCoeEnv* aCoeEnv, 
       
    82         TInt aWaitNoteTextResourceID = 0, 
       
    83         TInt aWaitNoteResourceID = 0 );
       
    84 
       
    85 private:
       
    86 
       
    87     /**
       
    88     * C++ default constructor.
       
    89     */
       
    90     CPslnWallpaperUtilsLoader();
       
    91 
       
    92     };
       
    93 
       
    94 // Environment gate function
       
    95 IMPORT_C TAny* GateFunction();
       
    96 
       
    97 #endif // C_PSLNWALLPAPERUTILSLOADER
       
    98             
       
    99 // End of File