1 msgbiocontrolobserver.h

     1 /*

     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  

    15 *     Bio control observer.

    16 *

    17 */

    18 

    19 

    20 

    21 #ifndef __MSGBIOCONTROLOBSERVER_H_

    22 #define __MSGBIOCONTROLOBSERVER_H_

    23 

    24 // INCLUDES 

    25 // CONSTANTS

    26 // MACROS

    27 // DATA TYPES

    28 // FUNCTION PROTOTYPES

    29 // FORWARD DECLARATIONS

    30 // FORWARD DECLARATIONS

    31 

    32 // CLASS DECLARATION

    33 

    34 /**

    35  * Interface for Bio Control Observer. The MMsgBioControlObserver is used

    36  * for observing the Bio Control from the editor application.

    37  */

    38 class MMsgBioControlObserver

    39     {

    40     public:

    41 

    42         /**

    43          * The command types. For use in conjunction with the

    44          * functions of this class.

    45          */

    46         enum TMsgCommands

    47             {

    48             EMsgNone = 0,

    49             EMsgSave,

    50             EMsgReply,

    51             EMsgForwad,

    52             EMsgSend,

    53             EMsgAddressBook,          

    54             EMsgClose

    55             };

    56 	

    57     public:

    58 

    59         /**

    60          * Returns the first free command id that a BIO control can use for

    61          * its own purposes. All the commands having ids of more or equal to

    62          * an id returned by this function are passed to the BIO control.

    63          * @return First free command.

    64          */

    65         virtual TInt FirstFreeCommand() const = 0;

    66 

    67         /**

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

    69          * Typically the BIO message editor/viewer does not handle a requested

    70          * command immediately but after the BIO control has returned from the

    71          * HandleCommandL function.

    72          * @param aCommand The command that can be handled.

    73          * @return KerrNone or KerrNotSupported

    74          */

    75         virtual TInt RequestHandleCommandL(TMsgCommands aCommand) = 0;

    76 

    77         /**

    78          * Returns ETrue or EFalse whether a requested aCommand is supported

    79          * by the BIO message editor or not. This command should be used

    80          * before requesting command handling by RequestHandleCommand().

    81          * @param aCommand The command

    82          * @return ETrue if command is support and EFalse if not.

    83          */

    84         virtual TBool IsCommandSupported(TMsgCommands aCommand) const = 0;

    85     };

    86 

    87 

    88 #endif // __MSGBIOCONTROLOBSERVER_H_

    89 

    90 //end of file