epoc32/include/mw/aknswallpaperutils.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2002-2004 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:  Defines an internal concrete class CAknsAppSkinInstance and
    15 *                related types. This class encapsulates the concrete skin 
    16 *                instance which is a singleton in thread scope.
    17 *
    18 */
    19 
    20 
    21 #ifndef AKNSWALLPAPERUTILS_H
    22 #define AKNSWALLPAPERUTILS_H
    23 
    24 #include <e32base.h>
    25 #include <badesca.h>
    26 
    27 class CCoeEnv;
    28 
    29 /*
    30   Special error codes for SetIdleWallpaper.
    31 */
    32 enum TAknsWpuError 
    33    {
    34    // Returned when the drm protected image has
    35    // only preview rights
    36    KAknsWpuErrorPreviewOnly = -8000
    37    };
    38 
    39 /*
    40 * An utility class for manipulating the Idle state wallpaper. This function will show
    41 * all drm related messages and queries, if the content is drm protected.
    42 *
    43 * No copies of the given file, but the file is used directly where it is located.
    44 *
    45 * 
    46 * @since 3.0
    47 */
    48 class AknsWallpaperUtils
    49 {
    50     public:
    51         /*
    52         * Sets the idle state wallpaper
    53         *
    54         * @param aFilename, the filename(incl. full path) of the image to be 
    55         * set as the idle state wallpaper, or KNullDesC if wallpaper is to
    56         * be removed. If resource id:s are given, the user must ensure that
    57         * the correct resource file is loaded to the given aCCoeEnv. The 
    58         * waitnote is type of CAknWaitNoteWrapper and is automatically launched
    59         * when correct resource id:s are given. 
    60         *
    61         * @param aCoeEnv a valid pointer to Control Environment, or NULL. As this function will potentially
    62         * show drm related messages, a valid coeenv is needed. If no messages are wanted, NULL can be given
    63         * as the parameter. Note that even when passing NULL, DRM related stuff will not be skipped, but
    64         * they are done silenty.
    65         *
    66         * @param aWaitNoteResourceTextID the resource id of the waitnote text to show
    67         * @param aWaitNoteResourceID the resource id of the wait note to show.
    68         * @return KErrNone on success or one of the system wide error codes.
    69         */
    70         IMPORT_C static TInt SetIdleWallpaper(const TDesC& aFilename, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
    71 
    72         IMPORT_C static TInt SetSlidesetWallpaper(CDesCArray& aSelectedFiles, CCoeEnv* aCoeEnv, TInt aWaitNoteTextResourceID = 0, TInt aWaitNoteResourceID = 0);
    73 
    74 };
    75 
    76 
    77 #endif // AKNSAPPSKININSTANCE_H
    78             
    79 // End of File