epoc32/include/e32twin.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1995-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@2
     4
// 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
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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
// e32\include\e32twin.h
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef __E32TWIN_H__
williamr@2
    19
#define __E32TWIN_H__
williamr@2
    20
#include <e32cons.h>
williamr@2
    21
//
williamr@2
    22
williamr@2
    23
/** @internalComponent */
williamr@2
    24
_LIT(KE32WindowServer,"!E32WindowServer");
williamr@2
    25
williamr@2
    26
/** @internalTechnology */
williamr@2
    27
enum TEventType
williamr@2
    28
    {
williamr@2
    29
    EKeyPress,
williamr@2
    30
    EMouseClick
williamr@2
    31
    };
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
@publishedPartner
williamr@2
    35
@released
williamr@2
    36
*/
williamr@2
    37
enum TVideoMode
williamr@2
    38
	{
williamr@2
    39
	EMono=1,
williamr@2
    40
	EGray4=2,
williamr@2
    41
	EGray16=4,
williamr@2
    42
	EColor256=8,
williamr@2
    43
	EColor4K=12,
williamr@2
    44
	EColor64K=16,
williamr@2
    45
	EColor16M=24
williamr@2
    46
williamr@2
    47
	};
williamr@2
    48
williamr@2
    49
/** @internalTechnology */
williamr@2
    50
struct SConsoleKey
williamr@2
    51
	{
williamr@2
    52
 	TKeyCode iCode;
williamr@2
    53
	TUint iModifiers;
williamr@2
    54
    TPoint iMousePos;
williamr@2
    55
    TInt iType;
williamr@2
    56
	};
williamr@2
    57
williamr@2
    58
/** @internalTechnology */
williamr@2
    59
class TConsoleKey : public TPckgBuf<SConsoleKey>
williamr@2
    60
	{
williamr@2
    61
public:
williamr@2
    62
	IMPORT_C TKeyCode Code() const;
williamr@2
    63
	IMPORT_C TInt Modifiers() const;
williamr@2
    64
    IMPORT_C TInt Type() const;
williamr@2
    65
    IMPORT_C TPoint MousePos() const;
williamr@2
    66
	};
williamr@2
    67
williamr@2
    68
/** @internalTechnology */
williamr@2
    69
class RConsole : public RSessionBase
williamr@2
    70
	{
williamr@2
    71
public:
williamr@2
    72
	IMPORT_C TVersion Version();
williamr@2
    73
	TInt Connect();
williamr@2
    74
	IMPORT_C TInt Create();
williamr@2
    75
	IMPORT_C TInt Init(const TDesC &aName,const TSize &aSize);
williamr@2
    76
	IMPORT_C TInt Write(const TDesC &aDes);
williamr@2
    77
	IMPORT_C TInt ClearScreen();
williamr@2
    78
	IMPORT_C TInt ClearToEndOfLine();
williamr@2
    79
	IMPORT_C TInt Destroy();
williamr@2
    80
	IMPORT_C TInt SetTitle(const TDesC &aName);
williamr@2
    81
	IMPORT_C TInt SetSize(const TSize &aSize);
williamr@2
    82
	IMPORT_C TInt SetWindowPosAbs(const TPoint &aPosition);
williamr@2
    83
	IMPORT_C TInt SetCursorHeight(TInt aPercentage);
williamr@2
    84
	IMPORT_C TInt SetCursorPosAbs(const TPoint &aPosition);
williamr@2
    85
	IMPORT_C TInt SetCursorPosRel(const TPoint &aVector);
williamr@2
    86
	IMPORT_C TInt Size(TSize &aSize) const;
williamr@2
    87
	IMPORT_C TInt ScreenSize(TSize &aSize) const;
williamr@2
    88
	IMPORT_C TInt CursorPos(TPoint &aPosition) const;
williamr@2
    89
	IMPORT_C TInt Control(const TDesC &aDes);
williamr@2
    90
	IMPORT_C TInt Read(TConsoleKey &aKeystroke);
williamr@2
    91
	IMPORT_C void Read(TConsoleKey &aKeystroke,TRequestStatus &aStatus);
williamr@2
    92
	IMPORT_C TInt ReadCancel();
williamr@2
    93
	IMPORT_C TInt SetMode(TVideoMode aMode);
williamr@2
    94
	IMPORT_C void SetPaletteEntry(TUint anIndex,TUint8 aRed,TUint8 aGreen,TUint8 aBlue);
williamr@2
    95
	IMPORT_C void GetPaletteEntry(TUint anIndex,TUint8 &aRed,TUint8 &aGreen,TUint8 &aBlue);
williamr@2
    96
	IMPORT_C void SetTextColors(TUint anFgColor,TUint aBgColor);
williamr@2
    97
	IMPORT_C void SetUIColors(TUint aWindowBgColor,TUint aBorderColor,TUint aScreenColor);
williamr@2
    98
	IMPORT_C void SetTextAttribute(TTextAttribute anAttribute);
williamr@2
    99
	};
williamr@2
   100
williamr@2
   101
/** @internalComponent */
williamr@2
   102
NONSHARABLE_CLASS(CConsoleTextWin) : public CConsoleBase
williamr@2
   103
	{
williamr@2
   104
public:
williamr@2
   105
	static CConsoleTextWin *NewL(const TDesC &aTitle,TSize aSize);
williamr@2
   106
	CConsoleTextWin();
williamr@2
   107
	virtual ~CConsoleTextWin();
williamr@2
   108
	virtual TInt Create(const TDesC &aTitle,TSize aSize);
williamr@2
   109
	virtual void Read(TRequestStatus &aStatus);
williamr@2
   110
	virtual void ReadCancel();
williamr@2
   111
	virtual void Write(const TDesC &aDes);
williamr@2
   112
	virtual TPoint CursorPos() const;
williamr@2
   113
	virtual void SetCursorPosAbs(const TPoint &aPoint);
williamr@2
   114
	virtual void SetCursorPosRel(const TPoint &aPoint);
williamr@2
   115
	virtual void SetCursorHeight(TInt aPercentage);
williamr@2
   116
	virtual void SetTitle(const TDesC &aTitle);
williamr@2
   117
	virtual void ClearScreen();
williamr@2
   118
	virtual void ClearToEndOfLine();
williamr@2
   119
	virtual TSize ScreenSize() const;
williamr@2
   120
	virtual TKeyCode KeyCode() const;
williamr@2
   121
	virtual TUint KeyModifiers() const;
williamr@2
   122
	virtual void SetTextAttribute(TTextAttribute anAttribute);
williamr@2
   123
	RConsole &Console();
williamr@2
   124
private:
williamr@2
   125
	TConsoleKey iKey;
williamr@2
   126
	RConsole iConsole;
williamr@2
   127
	};
williamr@2
   128
#endif