MMsgBioControlObserver 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 <msgbiocontrolobserver.h>

Detailed Description

Interface for Bio Control Observer.

The MMsgBioControlObserver is used for observing the Bio Control from the editor application.


Public Types
enum   TMsgCommands {
  EMsgNone = 0, EMsgSave, EMsgReply, EMsgForwad,
  EMsgSend, EMsgAddressBook, EMsgClose
}
  The command types. More...

Public Member Functions
virtual TInt  FirstFreeCommand () const =0
  Returns the first free command id that a BIO control can use for its own purposes.
virtual TInt  RequestHandleCommandL (TMsgCommands aCommand)=0
  Requests the BIO message editor/viewer to handle a command.
virtual TBool  IsCommandSupported (TMsgCommands aCommand) const =0
  Returns ETrue or EFalse whether a requested aCommand is supported by the BIO message editor or not.

Member Enumeration Documentation

enum MMsgBioControlObserver::TMsgCommands
 

The command types.

For use in conjunction with the functions of this class.

Enumerator:
EMsgNone 
EMsgSave 
EMsgReply 
EMsgForwad 
EMsgSend 
EMsgAddressBook 
EMsgClose 

Member Function Documentation

virtual TInt MMsgBioControlObserver::FirstFreeCommand (   )  const [pure virtual]
 

Returns the first free command id that a BIO control can use for its own purposes.

All the commands having ids of more or equal to an id returned by this function are passed to the BIO control.

Returns:
First free command.
virtual TBool MMsgBioControlObserver::IsCommandSupported (  TMsgCommands  aCommand  )  const [pure virtual]
 

Returns ETrue or EFalse whether a requested aCommand is supported by the BIO message editor or not.

This command should be used before requesting command handling by RequestHandleCommand().

Parameters:
aCommand  The command
Returns:
ETrue if command is support and EFalse if not.
virtual TInt MMsgBioControlObserver::RequestHandleCommandL (  TMsgCommands  aCommand  )  [pure virtual]
 

Requests the BIO message editor/viewer to handle a command.

Typically the BIO message editor/viewer does not handle a requested command immediately but after the BIO control has returned from the HandleCommandL function.

Parameters:
aCommand  The command that can be handled.
Returns:
KerrNone or KerrNotSupported
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top