epoc32/include/palette.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.
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __PALETTE_H__
williamr@2
    17
#define __PALETTE_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class TColor256Util;
williamr@2
    22
williamr@2
    23
williamr@2
    24
class DynamicPalette
williamr@2
    25
/** Hooks to allow dynamic palette switching in 256 colour mode.
williamr@2
    26
williamr@2
    27
TRgb::Color256() transparently invokes hooks in this class. The behaviour 
williamr@2
    28
of the system can be customized by replacing the implementation in palette.dll 
williamr@2
    29
with device-specific functionality to switch the colour palette at run-time. 
williamr@2
    30
@publishedAll
williamr@2
    31
@released
williamr@2
    32
*/
williamr@2
    33
	{
williamr@2
    34
public:
williamr@2
    35
	/** Stores the index values of the palettes defined. This enum may be as 
williamr@2
    36
	short or as long as desired - there is no requirement that the size of the 
williamr@2
    37
	enum in any given implementation be limited to the five sample values given 
williamr@2
    38
	in this example implementation. */
williamr@2
    39
	enum TIndex
williamr@2
    40
		{
williamr@2
    41
		/** A palette index number. */
williamr@2
    42
		EIndex0,
williamr@2
    43
		/** A palette index number. */
williamr@2
    44
		EIndex1,
williamr@2
    45
		/** A palette index number. */
williamr@2
    46
		EIndex2,
williamr@2
    47
		/** A palette index number. */
williamr@2
    48
		EIndex4,
williamr@2
    49
		/** A palette index number. */
williamr@2
    50
		EIndex5,
williamr@2
    51
	};
williamr@2
    52
williamr@2
    53
	IMPORT_C static const TColor256Util* DefaultColor256Util();
williamr@2
    54
	IMPORT_C static void SetColor256Util(TIndex aIndex);
williamr@2
    55
williamr@2
    56
	IMPORT_C static const TUint32* Color16array();
williamr@2
    57
	IMPORT_C static const TUint8* Color16inverse();
williamr@2
    58
	};
williamr@2
    59
williamr@2
    60
#endif