MMsgBioControl Class Reference

API published in: S60 1st Ed

Link against: msgeditorutils.lib

Capability Information

Required Capabilities

LocalServices Location NetworkControl NetworkServices ReadDeviceData ReadUserData SwEvent UserEnvironment WriteDeviceData WriteUserData

#include <mmsgbiocontrol.h>

Inherited by CMsgBioControl.

Detailed Description

The interface for Bio controls.

Public Member Functions
virtual void  SetAndGetSizeL (TSize &aSize)=0
  Calculates and sets size for a Bio control according to aSize.
virtual void  SetMenuCommandSetL (CEikMenuPane &aMenuPane)=0
  This is called by the container to allow the Bio control to add a menu item command.
virtual TBool  HandleBioCommandL (TInt aCommand)=0
  The command handler.
virtual TRect  CurrentLineRect () const =0
  Returns a rectangle slice of the bio controls viewing area.
virtual TBool  IsFocusChangePossible (TMsgFocusDirection aDirection) const =0
  Used by the body container for managing focus and scrolling.
virtual HBufC *  HeaderTextL (void) const =0
  Returns the header text.
virtual TUint32  OptionMenuPermissionsL () const =0
  The application can get the option menu permissions using this function.
virtual TInt  VirtualHeight ()=0
  Gives the height of the text in pixels.
virtual TInt  VirtualVisibleTop ()=0
  Gives the cursor position in pixels.
virtual TBool  IsCursorLocation (TMsgCursorLocation aLocation) const =0
  Tells whether the cursor is in the topmost or bottom position.

Member Function Documentation

virtual TRect MMsgBioControl::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.

Returns:
TRect
virtual TBool MMsgBioControl::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:
aCommand  ID of command to be handled.
Returns:
If the command is handled, it returns ETrue, and vice versa
virtual HBufC* MMsgBioControl::HeaderTextL (  void   )  const [pure virtual]
 

Returns the header text.

Returns:
The header text.
virtual TBool MMsgBioControl::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:
aLocation  Specifies either top or bottom.
Returns:
ETrue if the cursor is in the part specified by aLocation.

Implemented in CMsgBioControl.

virtual TBool MMsgBioControl::IsFocusChangePossible (  TMsgFocusDirection  aDirection  )  const [pure virtual]
 

Used by the body container for managing focus and scrolling.

Parameters:
aDirection  The direction to be checked.
Returns:
ETrue if focus change is possible, and vice versa.
virtual TUint32 MMsgBioControl::OptionMenuPermissionsL (   )  const [pure virtual]
 

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

Returns:
The option menu permission flags. If the flag is off it means that the option menu command is not recommended with this Bio Control.

Implemented in CMsgBioControl.

virtual void MMsgBioControl::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:
aSize  Size. See explanation.
virtual void MMsgBioControl::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:
aMenuPane  Reference to the applications menu which will be modified.
virtual TInt MMsgBioControl::VirtualHeight (   )  [pure virtual]
 

Gives the height of the text in pixels.

It is used by the scrolling framework.

Returns:
Height of the text in pixels.

Implemented in CMsgBioControl.

virtual TInt MMsgBioControl::VirtualVisibleTop (   )  [pure virtual]
 

Gives the cursor position in pixels.

It is used by the scrolling framework.

Returns:
Cursor position in pixels.

Implemented in CMsgBioControl.

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