1.1 --- a/epoc32/include/app/msgbiocontrolobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/app/msgbiocontrolobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,90 @@
     1.4 -msgbiocontrolobserver.h
     1.5 +/*
     1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  
    1.19 +*     Bio control observer.
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +#ifndef __MSGBIOCONTROLOBSERVER_H_
    1.26 +#define __MSGBIOCONTROLOBSERVER_H_
    1.27 +
    1.28 +// INCLUDES 
    1.29 +// CONSTANTS
    1.30 +// MACROS
    1.31 +// DATA TYPES
    1.32 +// FUNCTION PROTOTYPES
    1.33 +// FORWARD DECLARATIONS
    1.34 +// FORWARD DECLARATIONS
    1.35 +
    1.36 +// CLASS DECLARATION
    1.37 +
    1.38 +/**
    1.39 + * Interface for Bio Control Observer. The MMsgBioControlObserver is used
    1.40 + * for observing the Bio Control from the editor application.
    1.41 + */
    1.42 +class MMsgBioControlObserver
    1.43 +    {
    1.44 +    public:
    1.45 +
    1.46 +        /**
    1.47 +         * The command types. For use in conjunction with the
    1.48 +         * functions of this class.
    1.49 +         */
    1.50 +        enum TMsgCommands
    1.51 +            {
    1.52 +            EMsgNone = 0,
    1.53 +            EMsgSave,
    1.54 +            EMsgReply,
    1.55 +            EMsgForwad,
    1.56 +            EMsgSend,
    1.57 +            EMsgAddressBook,          
    1.58 +            EMsgClose
    1.59 +            };
    1.60 +	
    1.61 +    public:
    1.62 +
    1.63 +        /**
    1.64 +         * Returns the first free command id that a BIO control can use for
    1.65 +         * its own purposes. All the commands having ids of more or equal to
    1.66 +         * an id returned by this function are passed to the BIO control.
    1.67 +         * @return First free command.
    1.68 +         */
    1.69 +        virtual TInt FirstFreeCommand() const = 0;
    1.70 +
    1.71 +        /**
    1.72 +         * Requests the BIO message editor/viewer to handle a command.
    1.73 +         * Typically the BIO message editor/viewer does not handle a requested
    1.74 +         * command immediately but after the BIO control has returned from the
    1.75 +         * HandleCommandL function.
    1.76 +         * @param aCommand The command that can be handled.
    1.77 +         * @return KerrNone or KerrNotSupported
    1.78 +         */
    1.79 +        virtual TInt RequestHandleCommandL(TMsgCommands aCommand) = 0;
    1.80 +
    1.81 +        /**
    1.82 +         * Returns ETrue or EFalse whether a requested aCommand is supported
    1.83 +         * by the BIO message editor or not. This command should be used
    1.84 +         * before requesting command handling by RequestHandleCommand().
    1.85 +         * @param aCommand The command
    1.86 +         * @return ETrue if command is support and EFalse if not.
    1.87 +         */
    1.88 +        virtual TBool IsCommandSupported(TMsgCommands aCommand) const = 0;
    1.89 +    };
    1.90 +
    1.91 +
    1.92 +#endif // __MSGBIOCONTROLOBSERVER_H_
    1.93 +
    1.94 +//end of file