1 /*

     2 * Copyright (c) 2005 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 "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Interface for content processors

    15 *

    16 */

    17 

    18 

    19 #ifndef __MCACONTENTPROCESSOR_H__

    20 #define __MCACONTENTPROCESSOR_H__

    21 

    22 //	FORWARD CLASS DECLERATIONS

    23 class MCAMessage;

    24 

    25 // CLASS DECLARATION

    26 

    27 /**

    28  *  Interface for content processors

    29  *

    30  *  @lib CAEngine.dll

    31  *  @since 3.0

    32  */

    33 class MCAContentProcessor

    34     {

    35     public: // Interface

    36 

    37         /**

    38          * Request processing of content.

    39          * @aMessage Message which to process.

    40          * @aProcessState. This is updated during processing.

    41          */

    42         virtual void RequestProcessingL( MCAMessage& aMessage ) = 0;

    43 

    44         /**

    45          * Start processing of content.

    46          * @aMessage Message which to process.

    47          * Leaves with KErrInuUse, if another item is processed at the moment.

    48          */

    49         virtual void StartProcessingL( MCAMessage& aMessage ) = 0;

    50 

    51         /**

    52          * Request cancelling of processing.

    53          * @aMessage To identify which message asks canceling

    54          */

    55         virtual void CancelProcessing( MCAMessage& aMessage ) = 0;

    56 

    57         /**

    58          * Request processing remove. If processing is already started. Cancels processing.

    59          * @aMessage To identify which message asks canceling

    60          */

    61         virtual void RemoveProcessingL( MCAMessage& aMessage ) = 0;

    62 

    63     protected: // For protection.

    64 

    65         /**

    66          * Destructor

    67          */

    68         virtual ~MCAContentProcessor() {}

    69     };

    70 

    71 #endif      // __MCACONTENTPROCESSOR_H__

    72 

    73 // End of File