MMsgBioControlObserver Class Reference

#include <app/msgbiocontrolObserver.h>

Link against: rsfwmountconfbc.lib

class MMsgBioControlObserver
Public Member Enumerations
enumTMsgCommands { EMsgNone, EMsgSave, EMsgReply, EMsgForwad, ..., EMsgClose }
Public Member Functions
pure virtual TInt FirstFreeCommand()
pure virtual TBool IsCommandSupported(TMsgCommands)
pure virtual TInt RequestHandleCommandL(TMsgCommands)

Detailed Description

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

Member Enumeration Documentation

Enum TMsgCommands

The command types. For use in conjunction with the functions of this class.

Member Function Documentation

FirstFreeCommand ( )

TInt 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.

IsCommandSupported ( TMsgCommands )

TBool IsCommandSupported(TMsgCommandsaCommand)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().

ParameterDescription
aCommandThe command

Returns: ETrue if command is support and EFalse if not.

RequestHandleCommandL ( TMsgCommands )

TInt RequestHandleCommandL(TMsgCommandsaCommand)[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.

ParameterDescription
aCommandThe command that can be handled.

Returns: KerrNone or KerrNotSupported