Symbian^3 Application Developer Library >

MMsgBioControl Class Reference

class MMsgBioControl

The interface for Bio controls

Public Member Functions
TRect CurrentLineRect ()
TBool HandleBioCommandL ( TInt )
HBufC * HeaderTextL (void)
TBool IsCursorLocation ( TMsgCursorLocation )
TBool IsFocusChangePossible ( TMsgFocusDirection )
TUint32 OptionMenuPermissionsL ()
void SetAndGetSizeL ( TSize &)
void SetMenuCommandSetL ( CEikMenuPane &)
TInt VirtualHeight ()
TInt VirtualVisibleTop ()

Member Functions Documentation

CurrentLineRect()

TRect CurrentLineRect ( ) const [pure virtual]

Returns a rectangle slice of the bio controls viewing area. It is used by the CMsgEditorView class for scrolling the screen. The position is given relative to the bio controls top left corner.

HandleBioCommandL(TInt)

TBool HandleBioCommandL ( TInt aCommand ) [pure virtual]

The command handler. The Bio Control should only handle its own commands that it has set using the function SetMenuCommandSetL() .

Parameters

TInt aCommand ID of command to be handled.

HeaderTextL(void)

HBufC * HeaderTextL ( void ) const [pure virtual]

Returns the header text.

Parameters

void

IsCursorLocation(TMsgCursorLocation)

TBool IsCursorLocation ( TMsgCursorLocation aLocation ) const [pure virtual]

Tells whether the cursor is in the topmost or bottom position. It is used by the scrolling framework.

Parameters

TMsgCursorLocation aLocation Specifies either top or bottom.

IsFocusChangePossible(TMsgFocusDirection)

TBool IsFocusChangePossible ( TMsgFocusDirection aDirection ) const [pure virtual]

Used by the body container for managing focus and scrolling.

Parameters

TMsgFocusDirection aDirection The direction to be checked.

OptionMenuPermissionsL()

TUint32 OptionMenuPermissionsL ( ) const [pure virtual]

The application can get the option menu permissions using this function.

SetAndGetSizeL(TSize &)

void SetAndGetSizeL ( TSize & aSize ) [pure virtual]

Calculates and sets size for a Bio control according to aSize. This function might become deprecated. The SetSizeL() function will be the replacement. The height of the Bio control may be less or more than requested by aSize, but the width must be exactly the same. If width of the Bio control is not the same as given by aSize, the width must be reset back to requested one. The aSize is set to the new size.

Parameters

TSize & aSize Size. See explanation.

SetMenuCommandSetL(CEikMenuPane &)

void SetMenuCommandSetL ( CEikMenuPane & aMenuPane ) [pure virtual]

This is called by the container to allow the Bio control to add a menu item command. The command ID's should start from the value returned by the MMsgBioControlObserver::FirstFreeCommand() .

Parameters

CEikMenuPane & aMenuPane Reference to the applications menu which will be modified.

VirtualHeight()

TInt VirtualHeight ( ) [pure virtual]

Gives the height of the text in pixels. It is used by the scrolling framework.

VirtualVisibleTop()

TInt VirtualVisibleTop ( ) [pure virtual]

Gives the cursor position in pixels. It is used by the scrolling framework.

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.