1 /*

     2 * Copyright (c) 2009 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:

    15 *

    16 */

    17 

    18 #ifndef __MENUENGOPERATION_H__

    19 #define __MENUENGOPERATION_H__

    20 

    21 #include <e32base.h>

    22 

    23 class CMenuEng;

    24 

    25 /**

    26 * Menu Engine Operation Interface - write-access engine functionality.

    27 * Operations are executed by the engine, in the order they were added.

    28 */

    29 NONSHARABLE_CLASS( MMenuEngOperation )

    30     {

    31 

    32 public:     // from MMenuEngOperation

    33 

    34     /**

    35     * Perform operations on the menu. Write-access is possible.

    36     * After this method returns, the engine will commit (save) the

    37     * changes asynchronously, and call CompletedMenuEngOperation()

    38     * with the result.

    39     * No asynchronous functionality is allowed, the engine scheduler is

    40     * not reentrant! MMenuEngOperation-s should be short and synchronous.

    41     * If long-lasting or asynchronous functionality is required, perform the

    42     * long lasting and asynchronous part before scheduling the operation to

    43     * the engine.

    44     */

    45     virtual void RunMenuEngOperationL() = 0;

    46 

    47     /**

    48     * Operation complete (changes saved).

    49     * @param aErr Error code.

    50     */

    51     virtual void CompletedMenuEngOperation( TInt aErr ) = 0;

    52 

    53     };

    54 

    55 #endif // __MENUENGOPERATION_H__