1.1 --- a/epoc32/include/app/mmsgbiocontrolextension.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/app/mmsgbiocontrolextension.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,89 @@
     1.4 -mmsgbiocontrolextension.h
     1.5 +/*
     1.6 +* Copyright (c) 2006-2007 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:   Interface to extend bio control functionality
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef MSGBIOCONTROLEXTENSION_H
    1.25 +#define MSGBIOCONTROLEXTENSION_H
    1.26 +
    1.27 +/**
    1.28 + * Bio control extension interface ids.
    1.29 + *
    1.30 + * @see MMsgBioControlExtension::BioControlExtension
    1.31 + */
    1.32 +enum TMsgBioControlExtensions
    1.33 +    {
    1.34 +    // Add new enum tag for a new extension. To maintain BC always add new
    1.35 +    // tags only to the end of existing tags and do not touch existing tags,
    1.36 +    // even if extensions are deprecated. Link the enum tags to types using
    1.37 +    // Doxygen comments.
    1.38 +
    1.39 +    /**
    1.40 +     * Extension interface id for MMsgBioControlScrollExtension.
    1.41 +     */
    1.42 +    KMsgBioControlScrollExtension = 1
    1.43 +    };
    1.44 +
    1.45 +/**
    1.46 + * Interface for Bio control extension.
    1.47 + *
    1.48 + * @since 3.2
    1.49 + */
    1.50 +class MMsgBioControlExtension
    1.51 +    {
    1.52 +    public:
    1.53 +
    1.54 +    /**
    1.55 +     * Extension point for future BIO control extension interfaces.
    1.56 +     * @since 3.2
    1.57 +     * @param aExtensionId The identifier for the requested extension interface.
    1.58 +     *                     See TMsgBioControlExtensions.
    1.59 +     * @return Untyped pointer to the extension interface.
    1.60 +     *         The pointer must be cast to appropriate type.
    1.61 +     */
    1.62 +    virtual TAny* BioControlExtension( TInt aExtensionId ) = 0;
    1.63 +    };
    1.64 +
    1.65 +/**
    1.66 + * Interface for scrolling extension
    1.67 + *
    1.68 + * @since 3.2
    1.69 + */
    1.70 +class MMsgBioControlScrollExtension
    1.71 +    {
    1.72 +    public:
    1.73 +
    1.74 +    /**
    1.75 +     * Performs the internal scrolling of control if needed.
    1.76 +     * @since 3.2     
    1.77 +     * @param aPixelsToScroll Amount of pixels to scroll.
    1.78 +     * @param aDirection      Scrolling direction.
    1.79 +     * @return Amount of pixels that were scrolled. Zero value means the component
    1.80 +     * cannot be scrolled to that direction anymore and view should be moved.
    1.81 +     */
    1.82 +    virtual TInt ExtScrollL( TInt aPixelsToScroll, TMsgScrollDirection aDirection ) = 0;
    1.83 +
    1.84 +    /**
    1.85 +     * Prepares control for viewing.
    1.86 +     * @since 3.2     
    1.87 +     * @param aEvent	The event type
    1.88 +     * @param aParam Event related parameters
    1.89 +     */
    1.90 +    virtual void ExtNotifyViewEvent( TMsgViewEvent aEvent, TInt aParam ) = 0;
    1.91 +    };
    1.92 +
    1.93 +#endif // MSGBIOCONTROLEXTENSION_H
    1.94 \ No newline at end of file