CEikConsoleScreen Class Reference

API published in: S60 1st Ed

Link against: eikdlg.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikconso.h>

Public Types
enum   TEikConsoleFlags { EUseBackedUpWindow = 0x1, ENoInitialCursor = 0x2 }

Public Member Functions
IMPORT_C  CEikConsoleScreen ()
  CEikConsoleScreen() constructor.
IMPORT_C  ~CEikConsoleScreen ()
  CEikConsoleScreen() destructor.
IMPORT_C TInt  Create (const TDesC &aTitle, TSize aSize)
  Create() Creates a console and sets title and size.
IMPORT_C void  Read (TRequestStatus &aStatus)
  Read() Not implemented.
IMPORT_C void  ReadCancel ()
  ReadCancel() Not implemented.
IMPORT_C TKeyCode  KeyCode () const
  KeyCode() Not implemented.
IMPORT_C TUint  KeyModifiers () const
  KeyModifiers() Not implemented.
IMPORT_C void  ConstructL (const TDesC &aTitle, TInt aFlags)
  ConstructL() Constructs a console and sets title.
IMPORT_C void  ConstructL (const TDesC &aTitle, const TSize &aSize, TInt aFlags, TEikConsWinUnits aUnit=EEikConsWinInChars)
  ConstructL() Constructs a console and sets title and size.
IMPORT_C void  ConstructL (const TDesC &aTitle, TPoint aTopLeft, const TSize &aSize, TInt aFlags, TEikConsWinUnits aUnit=EEikConsWinInChars)
  ConstructL() Constructs a console and sets title and position and size.
IMPORT_C void  SetConsWin (CEikConsoleControl *aConsWin)
  SetConsWin() Sets console window.
CEikConsoleControl *  ConsoleControl () const
  ConsoleControl() fetching console control.
IMPORT_C void  SetTitle (const TDesC &aTitle)
  SetTitle() Set title of the console.
IMPORT_C void  SetTitleL (const TDesC &aTitle)
  SetTitle() Set title of the console.
HBufC *  Title () const
  Title() Gets title of the console.
IMPORT_C TSize  ScreenSize () const
  ScreenSize() Gets size of the screen.
IMPORT_C void  FlushChars ()
  FlushChars() Updates the character buffers.
IMPORT_C TPoint  CursorPos () const
  CursorPos() Cursor position getter returns cursor position.
IMPORT_C void  SetCursorPosAbs (const TPoint &aPoint)
  SetCursorPosAbs Moving cursor to absolute position.
IMPORT_C void  SetCursorPosRel (const TPoint &aPoint)
  SetCursorPosRel Moving cursor to relative position.
IMPORT_C void  SetCursorHeight (TInt aPercentage)
  SetCursorHeight changes cursor height.
IMPORT_C void  Write (const TDesC &aDes)
  Write() Writes text to the console.
IMPORT_C void  ClearScreen ()
  ClearScreen() Clears the console screen.
IMPORT_C void  ClearToEndOfLine ()
  ClearToEndOfLine() Clears from cursor position to end of the line.
IMPORT_C void  ClearChars (const TRect &aRect, TUint aCharacterAttributes)
  ClearChars() Clears characters within rectangle matching attributes.
IMPORT_C TInt  HideCursor ()
  HideCursor() Hides cursor.
IMPORT_C void  DrawCursor ()
  DrawCursor() Draws cursor.
IMPORT_C void  DrawInSight (TPoint aPosition)
  DrawInSight Moves topleft corner.
IMPORT_C void  DrawCursorInSight ()
  DrawCursorInSight() Draws cursor and insight.
IMPORT_C void  Up (TUint aCount=1)
  Move cursor up.
IMPORT_C void  Down (TUint aCount=1)
  Move cursor down.
IMPORT_C void  Right (TUint aCount=1)
  Move cursor right.
IMPORT_C void  Left (TUint aCount=1)
  Move cursor left.
IMPORT_C void  Cr ()
  Insert a CR.
IMPORT_C void  Lf ()
  Insert a linefeed.
IMPORT_C void  ScrollChars (const TRect &anArea, const TPoint &aVector)
  Scroll characters.
IMPORT_C void  Redraw (const TRect &aRect)
  Redraw a rectangle.
IMPORT_C void  MoveTopLeft (TPoint aVector)
  Moves topleft.
TUint  HistorySize () const
  Size of the history.
IMPORT_C void  SetHistorySizeL (TUint aMaxChrExtra, TUint aMaxAttExtra)
  Set history buffer size.
TUint  Att () const
  Att() Attributes.
IMPORT_C void  SetAtt (TUint aCharacterAttributes)
  Set attributes.
IMPORT_C void  SetAtt (TUint aForegroundGray16, TUint aBackgroundGray16)
  Set attributes.
IMPORT_C void  SetFontL (const TFontSpec &aFontDesc)
  SetFontL() Sets the font for console.
IMPORT_C const TFontSpec &  Font () const
  Font() Gets the used font.
IMPORT_C void  SetSelection (const TRect &aRange)
  SetSelection() Sets the selection position.
IMPORT_C void  SelectCursor ()
  SelectCursor() Sets empty selection starting and ending at cursor position.
IMPORT_C TRect  Selection ()
  Selection() Get selection position.
IMPORT_C HBufC *  RetrieveL (const TRect &aRange)
  RetrieveL() returns selected text.
IMPORT_C void  SetPureCRLF (TUint aFlag)
  SetPureCRLF() sets pure flag.
IMPORT_C void  SetAllPrintable (TUint aFlag)
  SetAllPrintable() sets all printable flag.
IMPORT_C void  SetScrollLock (TUint aFlag)
  SetScrollLock() sets scroll lock flag.
IMPORT_C void  SetKeepCursorInSight (TUint aFlag)
  SetKeepCursorInSight() sets cursor in sight flag.
IMPORT_C void  SetScrollBarVisibilityL (CEikScrollBarFrame::TScrollBarVisibility aHBarVisibility, CEikScrollBarFrame::TScrollBarVisibility aVBarVisibility)
  SetScrollBarVisibilityL() sets scrollbar visibility.
IMPORT_C TBool  UpdateScrollBars ()
  UpdateScrollBars() updates scrollbars.

Member Enumeration Documentation

enum CEikConsoleScreen::TEikConsoleFlags
 
Enumerator:
EUseBackedUpWindow 
ENoInitialCursor 

Constructor & Destructor Documentation

IMPORT_C CEikConsoleScreen::CEikConsoleScreen (   ) 
 

CEikConsoleScreen() constructor.

IMPORT_C CEikConsoleScreen::~CEikConsoleScreen (   ) 
 

CEikConsoleScreen() destructor.

Member Function Documentation

TUint CEikConsoleScreen::Att (   )  const [inline]
 

Att() Attributes.

Returns:
attributes
IMPORT_C void CEikConsoleScreen::ClearChars (  const TRect &  aRect,
TUint  aCharacterAttributes
) 
 

ClearChars() Clears characters within rectangle matching attributes.

Parameters:
aRect  Rectangle in pixels
aCharacterAttributes  Matching character attributes
IMPORT_C void CEikConsoleScreen::ClearScreen (   ) 
 

ClearScreen() Clears the console screen.

IMPORT_C void CEikConsoleScreen::ClearToEndOfLine (   ) 
 

ClearToEndOfLine() Clears from cursor position to end of the line.

CEikConsoleControl* CEikConsoleScreen::ConsoleControl (   )  const [inline]
 

ConsoleControl() fetching console control.

Returns console control

IMPORT_C void CEikConsoleScreen::ConstructL (  const TDesC &  aTitle,
TPoint  aTopLeft,
const TSize &  aSize,
TInt  aFlags,
TEikConsWinUnits  aUnit = EEikConsWinInChars
) 
 

ConstructL() Constructs a console and sets title and position and size.

Parameters:
aTitle  Title of the console
aTopLeft  TopLeft corner of the console window
aSize  Size of the console in pixels
aFlags  Flags, for example EUseBackedUpWindow or ENoInitialCursor
aUnit  Unit of the console
IMPORT_C void CEikConsoleScreen::ConstructL (  const TDesC &  aTitle,
const TSize &  aSize,
TInt  aFlags,
TEikConsWinUnits  aUnit = EEikConsWinInChars
) 
 

ConstructL() Constructs a console and sets title and size.

Parameters:
aTitle  Title of the console
aSize  Size of the console in pixels
aFlags  Flags, for example EUseBackedUpWindow or ENoInitialCursor
aUnit  Unit of the console
IMPORT_C void CEikConsoleScreen::ConstructL (  const TDesC &  aTitle,
TInt  aFlags
) 
 

ConstructL() Constructs a console and sets title.

Parameters:
aTitle  Title of the console
aFlags  Flags, for example EUseBackedUpWindow or ENoInitialCursor
IMPORT_C void CEikConsoleScreen::Cr (   ) 
 

Insert a CR.

IMPORT_C TInt CEikConsoleScreen::Create (  const TDesC &  aTitle,
TSize  aSize
) 
 

Create() Creates a console and sets title and size.

Parameters:
aTitle  Title of the console
aSize  Size of the console in pixels
returns error code
IMPORT_C TPoint CEikConsoleScreen::CursorPos (   )  const
 

CursorPos() Cursor position getter returns cursor position.

IMPORT_C void CEikConsoleScreen::Down (  TUint  aCount = 1  ) 
 

Move cursor down.

Parameters:
aCount  Number of steps to move
IMPORT_C void CEikConsoleScreen::DrawCursor (   ) 
 

DrawCursor() Draws cursor.

IMPORT_C void CEikConsoleScreen::DrawCursorInSight (   ) 
 

DrawCursorInSight() Draws cursor and insight.

IMPORT_C void CEikConsoleScreen::DrawInSight (  TPoint  aPosition  ) 
 

DrawInSight Moves topleft corner.

Parameters:
aPosition  New position for insight
IMPORT_C void CEikConsoleScreen::FlushChars (   ) 
 

FlushChars() Updates the character buffers.

IMPORT_C const TFontSpec& CEikConsoleScreen::Font (   )  const
 

Font() Gets the used font.

Returns:
font specification
IMPORT_C TInt CEikConsoleScreen::HideCursor (   ) 
 

HideCursor() Hides cursor.

Returns:
nonzero if cursor was not visible
TUint CEikConsoleScreen::HistorySize (   )  const [inline]
 

Size of the history.

Returns:
lines stored for history buffer
IMPORT_C TKeyCode CEikConsoleScreen::KeyCode (   )  const
 

KeyCode() Not implemented.

IMPORT_C TUint CEikConsoleScreen::KeyModifiers (   )  const
 

KeyModifiers() Not implemented.

IMPORT_C void CEikConsoleScreen::Left (  TUint  aCount = 1  ) 
 

Move cursor left.

Parameters:
aCount  Number of steps to move
IMPORT_C void CEikConsoleScreen::Lf (   ) 
 

Insert a linefeed.

IMPORT_C void CEikConsoleScreen::MoveTopLeft (  TPoint  aVector  ) 
 

Moves topleft.

Parameters:
aVector  new position of topleft
IMPORT_C void CEikConsoleScreen::Read (  TRequestStatus &  aStatus  ) 
 

Read() Not implemented.

IMPORT_C void CEikConsoleScreen::ReadCancel (   ) 
 

ReadCancel() Not implemented.

IMPORT_C void CEikConsoleScreen::Redraw (  const TRect &  aRect  ) 
 

Redraw a rectangle.

Parameters:
aRect  Rectangle to redraw
IMPORT_C HBufC* CEikConsoleScreen::RetrieveL (  const TRect &  aRange  ) 
 

RetrieveL() returns selected text.

Parameters:
aRange  selection
Returns:
text in descriptor
IMPORT_C void CEikConsoleScreen::Right (  TUint  aCount = 1  ) 
 

Move cursor right.

Parameters:
aCount  Number of steps to move
IMPORT_C TSize CEikConsoleScreen::ScreenSize (   )  const
 

ScreenSize() Gets size of the screen.

returns Size of the screen in pixels

IMPORT_C void CEikConsoleScreen::ScrollChars (  const TRect &  anArea,
const TPoint &  aVector
) 
 

Scroll characters.

Parameters:
anArea  Area to scroll
aVector  How much to scroll
IMPORT_C void CEikConsoleScreen::SelectCursor (   ) 
 

SelectCursor() Sets empty selection starting and ending at cursor position.

IMPORT_C TRect CEikConsoleScreen::Selection (   ) 
 

Selection() Get selection position.

Returns:
selection position
IMPORT_C void CEikConsoleScreen::SetAllPrintable (  TUint  aFlag  ) 
 

SetAllPrintable() sets all printable flag.

Parameters:
aFlag  flags
IMPORT_C void CEikConsoleScreen::SetAtt (  TUint  aForegroundGray16,
TUint  aBackgroundGray16
) 
 

Set attributes.

Parameters:
aForegroundGray16  Grey16 attributes for foreground
aBackgroundGray16  Grey16 attribuets for background
IMPORT_C void CEikConsoleScreen::SetAtt (  TUint  aCharacterAttributes  ) 
 

Set attributes.

Parameters:
aCharacterAttributes  Attributes for characters
IMPORT_C void CEikConsoleScreen::SetConsWin (  CEikConsoleControl *  aConsWin  ) 
 

SetConsWin() Sets console window.

Parameters:
aConsWin  Console control
IMPORT_C void CEikConsoleScreen::SetCursorHeight (  TInt  aPercentage  ) 
 

SetCursorHeight changes cursor height.

Parameters:
aPercentage  Cursor height relative to character height
IMPORT_C void CEikConsoleScreen::SetCursorPosAbs (  const TPoint &  aPoint  ) 
 

SetCursorPosAbs Moving cursor to absolute position.

Parameters:
aPoint  Position in absolute coordinates
IMPORT_C void CEikConsoleScreen::SetCursorPosRel (  const TPoint &  aPoint  ) 
 

SetCursorPosRel Moving cursor to relative position.

Parameters:
aPoint  Position in relative coordinates
IMPORT_C void CEikConsoleScreen::SetFontL (  const TFontSpec &  aFontDesc  ) 
 

SetFontL() Sets the font for console.

Parameters:
aFontDesc  font specification
IMPORT_C void CEikConsoleScreen::SetHistorySizeL (  TUint  aMaxChrExtra,
TUint  aMaxAttExtra
) 
 

Set history buffer size.

Parameters:
aMaxChrExtra  lines allocated for history
aMaxAttExtra  attributed lines allocated for history
IMPORT_C void CEikConsoleScreen::SetKeepCursorInSight (  TUint  aFlag  ) 
 

SetKeepCursorInSight() sets cursor in sight flag.

Parameters:
aFlag  flags
IMPORT_C void CEikConsoleScreen::SetPureCRLF (  TUint  aFlag  ) 
 

SetPureCRLF() sets pure flag.

Parameters:
aFlag  flags
IMPORT_C void CEikConsoleScreen::SetScrollBarVisibilityL (  CEikScrollBarFrame::TScrollBarVisibility  aHBarVisibility,
CEikScrollBarFrame::TScrollBarVisibility  aVBarVisibility
) 
 

SetScrollBarVisibilityL() sets scrollbar visibility.

Parameters:
aHBarVisibility  horizontal scrollbar visibility
aVBarVisibility  vertical scrollbar visibility
IMPORT_C void CEikConsoleScreen::SetScrollLock (  TUint  aFlag  ) 
 

SetScrollLock() sets scroll lock flag.

Parameters:
aFlag  flags
IMPORT_C void CEikConsoleScreen::SetSelection (  const TRect &  aRange  ) 
 

SetSelection() Sets the selection position.

Parameters:
aRange  range of the selection
IMPORT_C void CEikConsoleScreen::SetTitle (  const TDesC &  aTitle  ) 
 

SetTitle() Set title of the console.

Parameters:
aTitle  Title of the console
IMPORT_C void CEikConsoleScreen::SetTitleL (  const TDesC &  aTitle  ) 
 

SetTitle() Set title of the console.

Parameters:
aTitle  Title of the console
HBufC* CEikConsoleScreen::Title (   )  const [inline]
 

Title() Gets title of the console.

returns Title of the console

IMPORT_C void CEikConsoleScreen::Up (  TUint  aCount = 1  ) 
 

Move cursor up.

Parameters:
aCount  Number of steps to move
IMPORT_C TBool CEikConsoleScreen::UpdateScrollBars (   ) 
 

UpdateScrollBars() updates scrollbars.

IMPORT_C void CEikConsoleScreen::Write (  const TDesC &  aDes  ) 
 

Write() Writes text to the console.

Parameters:
aDes  Text to be written to the console
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top