commonuisupport/uikon/coresrc/EIKGULUTIL.CPP
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #include <gulutil.h>
       
    17 #include <gulcolor.h>
       
    18 #include <eikenv.h>
       
    19 
       
    20 
       
    21 EXPORT_C CColorList* ColorUtils::CreateSystemColorListL(RFs&)
       
    22 /** Creates and returns a system colour list, which is a palette of standard 
       
    23 colours used by the system.
       
    24 
       
    25 The list is read from a system colour scheme file. The function returns NULL
       
    26 if no such file can be found. In this case, clients are expected to create 
       
    27 the list using some other means (typically from a resource file).
       
    28 
       
    29 Note that this method is implemented in eikcore.dll and clients should link
       
    30 to eikcore.lib.
       
    31 
       
    32 @deprecated
       
    33 @see CEikonEnv::CreateSystemColorListL
       
    34 
       
    35 @param aFs The file server session.
       
    36 @return Pointer to the system colour list.*/
       
    37 	{ // static
       
    38 	return CEikonEnv::Static()->CreateSystemColorListL();
       
    39 	}
       
    40 
       
    41 EXPORT_C CColorList* ColorUtils::CreateSystemColorListL(RFs&,const CColorList& aColorList)
       
    42 /** Creates a system colour list, using the other overload of this function 
       
    43 and merges it with the colour list specified.
       
    44 
       
    45 Note that this method is implemented in eikcore.dll and clients should link
       
    46 to eikcore.lib.
       
    47 
       
    48 @deprecated
       
    49 @see CEikonEnv::CreateSystemColorListL
       
    50 
       
    51 @param aFs The file server session.
       
    52 @param aColorList The color list to merge in.
       
    53 @return Pointer to the system colour list. */
       
    54 	{ // static
       
    55 	return CEikonEnv::Static()->CreateSystemColorListL(aColorList);
       
    56 	}
       
    57 
       
    58 //
       
    59 // Writes aColorList out to file.  Callers are responsible for broadcasting a scheme
       
    60 // changed message after calling this.
       
    61 //
       
    62 EXPORT_C void ColorUtils::UpdateSystemColorListL(RFs&,CColorList& aColorList)
       
    63 /** Replaces the system colour list with the list specified.
       
    64 
       
    65 If no system colour list exists, one is created.
       
    66 
       
    67 Note that this method is implemented in eikcore.dll and clients should link
       
    68 to eikcore.lib.
       
    69 
       
    70 @deprecated
       
    71 @see CEikonEnv::UpdateSystemColorListL
       
    72 
       
    73 @param aFs The file server session.
       
    74 @param aColorList The new colour list.
       
    75 @capability WriteDeviceData		To protect against tampering.
       
    76 */
       
    77 	{ // static
       
    78 	return CEikonEnv::Static()->UpdateSystemColorListL(aColorList);
       
    79 	}
       
    80