S60 3rd Edition API Reference: CEikConsoleControl Class Reference

CEikConsoleControl Class Reference

API published in: S60 1st Ed

Link against: eikdlg.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikconso.h>

Inherits CAknControl, and MEikScrollBarObserver.


Public Member Functions

IMPORT_C CEikConsoleControl ()
 Constructor.
IMPORT_C ~CEikConsoleControl ()
 Destructor.
IMPORT_C void ConstructL (TInt aFlags)
IMPORT_C void ConstructL (TPoint aTopLeft, const TSize &aSize, TInt aFlags, TEikConsWinUnits aUnit)
IMPORT_C void SetRedrawer (CEikConsoleScreen *aConsole)
 SetRedrawer.
IMPORT_C void SetFontL (const TFontSpec &aFontSpec, const CFbsFont *aFont)
 SetFontL() sets the console font.
const TFontSpec & Font () const
 Font() gets font specification.
const TSize & CharSize () const
 CharSize() gets character size.
IMPORT_C TSize VisibleSize () const
 VisibibleSize() gets visible size.
IMPORT_C void SetCursorHeight (TUint aPercentage)
 SetCursorHeight() Sets cursor height.
IMPORT_C void DrawCursor (TPoint aPosition)
 DrawCursor Draws cursor at position.
IMPORT_C void HideCursor ()
 HideCursor hides cursor.
IMPORT_C void DrawChars (const TDesC &aString, const TPoint &aPosition, TUint aCharacterAttributes)
 DrawChars() draws characters.
IMPORT_C void ClearChars (const TRect &anArea, TUint aCharacterAttributes)
 ClearChars() clears characters.
IMPORT_C void InvertChars (const TRect &anArea)
 InsertChars() inserts character area.
IMPORT_C void ScrollChars (const TRect &anArea, const TPoint &aVector)
 ScrollChars scrolls character area.
IMPORT_C TInt SetScrollBarVisibilityL (CEikScrollBarFrame::TScrollBarVisibility aHBarVisibility, CEikScrollBarFrame::TScrollBarVisibility aVBarVisibility)
 sets scrollbar visibility
IMPORT_C TBool UpdateScrollbarsL (const TSize &aDataSize, const TSize &aVisibleSize, TPoint aPos)
 Updates scrollbar.
IMPORT_C void HandleScrollEventL (CEikScrollBar *aScrollBar, TEikScrollEvent aEventType)
 Handles scroll event.
IMPORT_C void UpdateArea ()
 Updates an area.
virtual IMPORT_C void GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
 GetColorUseListL provides color use list for the control.
virtual IMPORT_C void HandleResourceChange (TInt aType)
 HandleResourceChange handles several kinds of resource change events.
IMPORT_C void HandlePointerEventL (const TPointerEvent &aPointerEvent)
 HandlePointerEventL handles touch pointer events.

Protected Member Functions

IMPORT_C void Draw (const TRect &aRect) const
 Draws the control.
IMPORT_C void SizeChanged ()
 Size has changed.
IMPORT_C void FocusChanged (TDrawNow aDrawNow)
 Focus has changed.
virtual IMPORT_C TInt CountComponentControls () const
 Component controls count.
virtual IMPORT_C CCoeControl * ComponentControl (TInt aIndex) const
 Component controls.
IMPORT_C void WriteInternalStateL (RWriteStream &aWriteStream) const
 Writes internal state.

Constructor & Destructor Documentation

IMPORT_C CEikConsoleControl::CEikConsoleControl (   ) 
 

Constructor.

IMPORT_C CEikConsoleControl::~CEikConsoleControl (   ) 
 

Destructor.

Member Function Documentation

const TSize& CEikConsoleControl::CharSize (   )  const [inline]
 

CharSize() gets character size.

IMPORT_C void CEikConsoleControl::ClearChars ( const TRect &  anArea,
TUint  aCharacterAttributes
) 
 

ClearChars() clears characters.

Parameters:
anArea area to be cleared
aCharacterAttributes attributes of cleared characters
virtual IMPORT_C CCoeControl* CEikConsoleControl::ComponentControl ( TInt  aIndex  )  const [protected, virtual]
 

Component controls.

IMPORT_C void CEikConsoleControl::ConstructL ( TPoint  aTopLeft,
const TSize &  aSize,
TInt  aFlags,
TEikConsWinUnits  aUnit
) 
 
IMPORT_C void CEikConsoleControl::ConstructL ( TInt  aFlags  ) 
 
virtual IMPORT_C TInt CEikConsoleControl::CountComponentControls (   )  const [protected, virtual]
 

Component controls count.

IMPORT_C void CEikConsoleControl::Draw ( const TRect &  aRect  )  const [protected]
 

Draws the control.

IMPORT_C void CEikConsoleControl::DrawChars ( const TDesC &  aString,
const TPoint &  aPosition,
TUint  aCharacterAttributes
) 
 

DrawChars() draws characters.

Parameters:
aString string to be drawn
aPosition position of the string
aCharacterAttributes attributes of the drawn string
IMPORT_C void CEikConsoleControl::DrawCursor ( TPoint  aPosition  ) 
 

DrawCursor Draws cursor at position.

Parameters:
aPosition position
IMPORT_C void CEikConsoleControl::FocusChanged ( TDrawNow  aDrawNow  )  [protected]
 

Focus has changed.

const TFontSpec& CEikConsoleControl::Font (   )  const [inline]
 

Font() gets font specification.

virtual IMPORT_C void CEikConsoleControl::GetColorUseListL ( CArrayFix< TCoeColorUse > &  aColorUseList  )  const [virtual]
 

GetColorUseListL provides color use list for the control.

IMPORT_C void CEikConsoleControl::HandlePointerEventL ( const TPointerEvent &  aPointerEvent  ) 
 

HandlePointerEventL handles touch pointer events.

virtual IMPORT_C void CEikConsoleControl::HandleResourceChange ( TInt  aType  )  [virtual]
 

HandleResourceChange handles several kinds of resource change events.

IMPORT_C void CEikConsoleControl::HandleScrollEventL ( CEikScrollBar *  aScrollBar,
TEikScrollEvent  aEventType
)  [virtual]
 

Handles scroll event.

Parameters:
aScrollBar scrollbar to be used for the event
aEventType type of the event that happened

Implements MEikScrollBarObserver.

IMPORT_C void CEikConsoleControl::HideCursor (   ) 
 

HideCursor hides cursor.

IMPORT_C void CEikConsoleControl::InvertChars ( const TRect &  anArea  ) 
 

InsertChars() inserts character area.

Parameters:
anArea area to be inserted
IMPORT_C void CEikConsoleControl::ScrollChars ( const TRect &  anArea,
const TPoint &  aVector
) 
 

ScrollChars scrolls character area.

Parameters:
anArea area to be scrolled
aVector direction to be scrolled
IMPORT_C void CEikConsoleControl::SetCursorHeight ( TUint  aPercentage  ) 
 

SetCursorHeight() Sets cursor height.

Parameters:
aPercentage value 0..100%
IMPORT_C void CEikConsoleControl::SetFontL ( const TFontSpec &  aFontSpec,
const CFbsFont *  aFont
) 
 

SetFontL() sets the console font.

Parameters:
aFontSpec font specification
aFont font instance
IMPORT_C void CEikConsoleControl::SetRedrawer ( CEikConsoleScreen *  aConsole  ) 
 

SetRedrawer.

Parameters:
aConsole console screen
IMPORT_C TInt CEikConsoleControl::SetScrollBarVisibilityL ( CEikScrollBarFrame::TScrollBarVisibility  aHBarVisibility,
CEikScrollBarFrame::TScrollBarVisibility  aVBarVisibility
) 
 

sets scrollbar visibility

Parameters:
aHBarVisibility horizontal scrollbar visibility
aVBarVisibility vertical scrollbar visibility
IMPORT_C void CEikConsoleControl::SizeChanged (   )  [protected]
 

Size has changed.

IMPORT_C void CEikConsoleControl::UpdateArea (   ) 
 

Updates an area.

IMPORT_C TBool CEikConsoleControl::UpdateScrollbarsL ( const TSize &  aDataSize,
const TSize &  aVisibleSize,
TPoint  aPos
) 
 

Updates scrollbar.

Parameters:
aDataSize size of the data
aVisibleSize how much of the data is visible on the console
aPos position of the visible area relative to whole data
Returns:
ETrue if as a result, the visible window has changed
IMPORT_C TSize CEikConsoleControl::VisibleSize (   )  const
 

VisibibleSize() gets visible size.

IMPORT_C void CEikConsoleControl::WriteInternalStateL ( RWriteStream &  aWriteStream  )  const [protected]
 

Writes internal state.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top