Symbian^3 Application Developer Library >

RConsole Class Reference

class RConsole : public RSessionBase

Inherits from

Public Member Functions
IMPORT_C TInt ClearScreen ()
IMPORT_C TInt ClearToEndOfLine ()
TInt Connect ()
IMPORT_C TInt Control (const TDesC &)
IMPORT_C TInt Create ()
IMPORT_C TInt CursorPos ( TPoint &)
IMPORT_C TInt Destroy ()
IMPORT_C void GetPaletteEntry ( TUint , TUint8 &, TUint8 &, TUint8 &)
IMPORT_C TInt Init (const TDesC &, const TSize &)
IMPORT_C TInt Read ( TConsoleKey &)
IMPORT_C void Read ( TConsoleKey &, TRequestStatus &)
IMPORT_C TInt ReadCancel ()
IMPORT_C TInt ScreenSize ( TSize &)
IMPORT_C TInt SetCursorHeight ( TInt )
IMPORT_C TInt SetCursorPosAbs (const TPoint &)
IMPORT_C TInt SetCursorPosRel (const TPoint &)
IMPORT_C TInt SetMode ( TVideoMode )
IMPORT_C void SetPaletteEntry ( TUint , TUint8 , TUint8 , TUint8 )
IMPORT_C TInt SetSize (const TSize &)
IMPORT_C void SetTextAttribute ( TTextAttribute )
IMPORT_C void SetTextColors ( TUint , TUint )
IMPORT_C TInt SetTitle (const TDesC &)
IMPORT_C void SetUIColors ( TUint , TUint , TUint )
IMPORT_C TInt SetWindowPosAbs (const TPoint &)
IMPORT_C TInt Size ( TSize &)
IMPORT_C TVersion Version ()
IMPORT_C TInt Write (const TDesC &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Inherited Attributes
RHandleBase::iHandle

Member Functions Documentation

ClearScreen()

IMPORT_C TInt ClearScreen ( )

ClearToEndOfLine()

IMPORT_C TInt ClearToEndOfLine ( )

Connect()

TInt Connect ( )

Control(const TDesC &)

IMPORT_C TInt Control ( const TDesC & aDes )

Parameters

const TDesC & aDes

Create()

IMPORT_C TInt Create ( )

CursorPos(TPoint &)

IMPORT_C TInt CursorPos ( TPoint & aPosition ) const

Parameters

TPoint & aPosition

Destroy()

IMPORT_C TInt Destroy ( )

GetPaletteEntry(TUint, TUint8 &, TUint8 &, TUint8 &)

IMPORT_C void GetPaletteEntry ( TUint anIndex,
TUint8 & aRed,
TUint8 & aGreen,
TUint8 & aBlue
)

Parameters

TUint anIndex
TUint8 & aRed
TUint8 & aGreen
TUint8 & aBlue

Init(const TDesC &, const TSize &)

IMPORT_C TInt Init ( const TDesC & aName,
const TSize & aSize
)

Parameters

const TDesC & aName
const TSize & aSize

Read(TConsoleKey &)

IMPORT_C TInt Read ( TConsoleKey & aKeystroke )

Parameters

TConsoleKey & aKeystroke

Read(TConsoleKey &, TRequestStatus &)

IMPORT_C void Read ( TConsoleKey & aKeystroke,
TRequestStatus & aStatus
)

Parameters

TConsoleKey & aKeystroke
TRequestStatus & aStatus

ReadCancel()

IMPORT_C TInt ReadCancel ( )

ScreenSize(TSize &)

IMPORT_C TInt ScreenSize ( TSize & aSize ) const

Parameters

TSize & aSize

SetCursorHeight(TInt)

IMPORT_C TInt SetCursorHeight ( TInt aPercentage )

Parameters

TInt aPercentage

SetCursorPosAbs(const TPoint &)

IMPORT_C TInt SetCursorPosAbs ( const TPoint & aPosition )

Parameters

const TPoint & aPosition

SetCursorPosRel(const TPoint &)

IMPORT_C TInt SetCursorPosRel ( const TPoint & aVector )

Parameters

const TPoint & aVector

SetMode(TVideoMode)

IMPORT_C TInt SetMode ( TVideoMode aMode )

Parameters

TVideoMode aMode

SetPaletteEntry(TUint, TUint8, TUint8, TUint8)

IMPORT_C void SetPaletteEntry ( TUint anIndex,
TUint8 aRed,
TUint8 aGreen,
TUint8 aBlue
)

Parameters

TUint anIndex
TUint8 aRed
TUint8 aGreen
TUint8 aBlue

SetSize(const TSize &)

IMPORT_C TInt SetSize ( const TSize & aSize )

Parameters

const TSize & aSize

SetTextAttribute(TTextAttribute)

IMPORT_C void SetTextAttribute ( TTextAttribute anAttribute )

Parameters

TTextAttribute anAttribute

SetTextColors(TUint, TUint)

IMPORT_C void SetTextColors ( TUint anFgColor,
TUint aBgColor
)

Parameters

TUint anFgColor
TUint aBgColor

SetTitle(const TDesC &)

IMPORT_C TInt SetTitle ( const TDesC & aName )

Parameters

const TDesC & aName

SetUIColors(TUint, TUint, TUint)

IMPORT_C void SetUIColors ( TUint aWindowBgColor,
TUint aBorderColor,
TUint aScreenColor
)

Parameters

TUint aWindowBgColor
TUint aBorderColor
TUint aScreenColor

SetWindowPosAbs(const TPoint &)

IMPORT_C TInt SetWindowPosAbs ( const TPoint & aPosition )

Parameters

const TPoint & aPosition

Size(TSize &)

IMPORT_C TInt Size ( TSize & aSize ) const

Parameters

TSize & aSize

Version()

IMPORT_C TVersion Version ( )

Write(const TDesC &)

IMPORT_C TInt Write ( const TDesC & aDes )

Parameters

const TDesC & aDes

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.