williamr@2: /*
williamr@2: * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Defines an internal concrete class CAknsAppSkinInstance and
williamr@2: *                related types. This class encapsulates the concrete skin 
williamr@2: *                instance which is a singleton in thread scope.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef AKNSWALLPAPERUTILS_H
williamr@2: #define AKNSWALLPAPERUTILS_H
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <badesca.h>
williamr@2: 
williamr@2: class CCoeEnv;
williamr@2: 
williamr@2: /*
williamr@2:   Special error codes for SetIdleWallpaper.
williamr@2: */
williamr@2: enum TAknsWpuError 
williamr@2:    {
williamr@2:    // Returned when the drm protected image has
williamr@2:    // only preview rights
williamr@2:    KAknsWpuErrorPreviewOnly = -8000
williamr@2:    };
williamr@2: 
williamr@2: /*
williamr@2: * An utility class for manipulating the Idle state wallpaper. This function will show
williamr@2: * all drm related messages and queries, if the content is drm protected.
williamr@2: *
williamr@2: * No copies of the given file, but the file is used directly where it is located.
williamr@2: *
williamr@2: * 
williamr@2: * @since 3.0
williamr@2: */
williamr@2: class AknsWallpaperUtils
williamr@2: {
williamr@2:     public:
williamr@2:         /*
williamr@2:         * Sets the idle state wallpaper
williamr@2:         *
williamr@2:         * @param aFilename, the filename(incl. full path) of the image to be 
williamr@2:         * set as the idle state wallpaper, or KNullDesC if wallpaper is to
williamr@2:         * be removed. If resource id:s are given, the user must ensure that
williamr@2:         * the correct resource file is loaded to the given aCCoeEnv. The 
williamr@2:         * waitnote is type of CAknWaitNoteWrapper and is automatically launched
williamr@2:         * when correct resource id:s are given. 
williamr@2:         *
williamr@2:         * @param aCoeEnv a valid pointer to Control Environment, or NULL. As this function will potentially
williamr@2:         * show drm related messages, a valid coeenv is needed. If no messages are wanted, NULL can be given
williamr@2:         * as the parameter. Note that even when passing NULL, DRM related stuff will not be skipped, but
williamr@2:         * they are done silenty.
williamr@2:         *
williamr@2:         * @param aWaitNoteResourceTextID the resource id of the waitnote text to show
williamr@2:         * @param aWaitNoteResourceID the resource id of the wait note to show.
williamr@2:         * @return KErrNone on success or one of the system wide error codes.
williamr@2:         */
williamr@2:         IMPORT_C static TInt SetIdleWallpaper(const TDesC& aFilename, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
williamr@2: 
williamr@2:         IMPORT_C static TInt SetSlidesetWallpaper(CDesCArray& aSelectedFiles, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
williamr@2: 
williamr@2: };
williamr@2: 
williamr@2: 
williamr@2: #endif // AKNSAPPSKININSTANCE_H
williamr@2:             
williamr@2: // End of File