S60 3rd Edition API Reference: aknswallpaperutils.h Source File

aknswallpaperutils.h

Go to the documentation of this file.
00001 /*
00002 * ==============================================================================
00003 *  Name        : AknsWallpaperUtils.h
00004 *  Part of     : Avkon Skins / Skin Library
00005 *  Interface   : ?Interface_category, ?Interface_name
00006 *  Description : Defines an internal concrete class CAknsAppSkinInstance and
00007 *                related types. This class encapsulates the concrete skin 
00008 *                instance which is a singleton in thread scope.
00009 *  Version     : ?Version
00010 *
00011 *  Copyright © 2002-2004 Nokia Corporation.
00012 *  This material, including documentation and any related 
00013 *  computer programs, is protected by copyright controlled by 
00014 *  Nokia Corporation. All rights are reserved. Copying, 
00015 *  including reproducing, storing, adapting or translating, any 
00016 *  or all of this material requires the prior written consent of 
00017 *  Nokia Corporation. This material also contains confidential 
00018 *  information which may not be disclosed to others without the 
00019 *  prior written consent of Nokia Corporation.
00020 * ==============================================================================
00021 */
00022 
00023 #ifndef AKNSWALLPAPERUTILS_H
00024 #define AKNSWALLPAPERUTILS_H
00025 
00026 #include <e32base.h>
00027 #start_since SINCE_3_1_SDK
00028 #include <badesca.h>
00029 #end_since SINCE_3_1_SDK
00030 
00031 class CCoeEnv;
00032 
00033 #start_since SINCE_3_1_SDK
00034 
00038 enum TAknsWpuError 
00039    {
00040    // Returned when the drm protected image has
00041    // only preview rights
00042    KAknsWpuErrorPreviewOnly = -8000
00043    };
00044 #end_since SINCE_3_1_SDK
00045 
00046 /*
00047 * An utility class for manipulating the Idle state wallpaper. This function will show
00048 * all drm related messages and queries, if the content is drm protected.
00049 *
00050 * No copies of the given file, but the file is used directly where it is located.
00051 *
00052 * 
00053 * 
00054 */
00055 class AknsWallpaperUtils
00056 {
00057     public:
00058         /*
00059         * Sets the idle state wallpaper
00060         *
00061         * @param aFilename, the filename(incl. full path) of the image to be 
00062         * set as the idle state wallpaper, or KNullDesC if wallpaper is to
00063         * be removed. If resource id:s are given, the user must ensure that
00064         * the correct resource file is loaded to the given aCCoeEnv. The 
00065         * waitnote is type of CAknWaitNoteWrapper and is automatically launched
00066         * when correct resource id:s are given. 
00067         *
00068         * @param aCoeEnv a valid pointer to Control Environment, or NULL. As this function will potentially
00069         * show drm related messages, a valid coeenv is needed. If no messages are wanted, NULL can be given
00070         * as the parameter. Note that even when passing NULL, DRM related stuff will not be skipped, but
00071         * they are done silenty.
00072         *
00073         * @param aWaitNoteResourceTextID the resource id of the waitnote text to show
00074         * @param aWaitNoteResourceID the resource id of the wait note to show.
00075         * @return KErrNone on success or one of the system wide error codes.
00076         */
00077         IMPORT_C static TInt SetIdleWallpaper(const TDesC& aFilename, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
00078 #start_since SINCE_3_1_SDK
00079 
00082         IMPORT_C static TInt SetSlidesetWallpaper(CDesCArray& aSelectedFiles, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
00083 #end_since SINCE_3_1_SDK
00084 };
00085 
00086 
00087 // AKNSAPPSKININSTANCE_H
00088 #endif
00089             
00090 // End of File

Copyright © Nokia Corporation 2001-2007
Back to top