1.1 --- a/epoc32/include/mw/aknswallpaperutils.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/aknswallpaperutils.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,79 @@
     1.4 -aknswallpaperutils.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Defines an internal concrete class CAknsAppSkinInstance and
    1.19 +*                related types. This class encapsulates the concrete skin 
    1.20 +*                instance which is a singleton in thread scope.
    1.21 +*
    1.22 +*/
    1.23 +
    1.24 +
    1.25 +#ifndef AKNSWALLPAPERUTILS_H
    1.26 +#define AKNSWALLPAPERUTILS_H
    1.27 +
    1.28 +#include <e32base.h>
    1.29 +#include <badesca.h>
    1.30 +
    1.31 +class CCoeEnv;
    1.32 +
    1.33 +/*
    1.34 +  Special error codes for SetIdleWallpaper.
    1.35 +*/
    1.36 +enum TAknsWpuError 
    1.37 +   {
    1.38 +   // Returned when the drm protected image has
    1.39 +   // only preview rights
    1.40 +   KAknsWpuErrorPreviewOnly = -8000
    1.41 +   };
    1.42 +
    1.43 +/*
    1.44 +* An utility class for manipulating the Idle state wallpaper. This function will show
    1.45 +* all drm related messages and queries, if the content is drm protected.
    1.46 +*
    1.47 +* No copies of the given file, but the file is used directly where it is located.
    1.48 +*
    1.49 +* 
    1.50 +* @since 3.0
    1.51 +*/
    1.52 +class AknsWallpaperUtils
    1.53 +{
    1.54 +    public:
    1.55 +        /*
    1.56 +        * Sets the idle state wallpaper
    1.57 +        *
    1.58 +        * @param aFilename, the filename(incl. full path) of the image to be 
    1.59 +        * set as the idle state wallpaper, or KNullDesC if wallpaper is to
    1.60 +        * be removed. If resource id:s are given, the user must ensure that
    1.61 +        * the correct resource file is loaded to the given aCCoeEnv. The 
    1.62 +        * waitnote is type of CAknWaitNoteWrapper and is automatically launched
    1.63 +        * when correct resource id:s are given. 
    1.64 +        *
    1.65 +        * @param aCoeEnv a valid pointer to Control Environment, or NULL. As this function will potentially
    1.66 +        * show drm related messages, a valid coeenv is needed. If no messages are wanted, NULL can be given
    1.67 +        * as the parameter. Note that even when passing NULL, DRM related stuff will not be skipped, but
    1.68 +        * they are done silenty.
    1.69 +        *
    1.70 +        * @param aWaitNoteResourceTextID the resource id of the waitnote text to show
    1.71 +        * @param aWaitNoteResourceID the resource id of the wait note to show.
    1.72 +        * @return KErrNone on success or one of the system wide error codes.
    1.73 +        */
    1.74 +        IMPORT_C static TInt SetIdleWallpaper(const TDesC& aFilename, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
    1.75 +
    1.76 +        IMPORT_C static TInt SetSlidesetWallpaper(CDesCArray& aSelectedFiles, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
    1.77 +
    1.78 +};
    1.79 +
    1.80 +
    1.81 +#endif // AKNSAPPSKININSTANCE_H
    1.82 +            
    1.83 +// End of File