1 /*

     2 * Copyright (c) 2007 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:  Command UI API definition.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_VTUICOMMANDUI_H

    20 #define M_VTUICOMMANDUI_H

    21 

    22 #include <e32base.h>

    23 

    24 class CVtUiCommandModifyBase;

    25 

    26 /**

    27  *  MVtUiCommandUi

    28  *

    29  *  Command UI API. Defines methods for adding/removing command modifiers and

    30  *  method to refresh related command UI.

    31  *

    32  *  @since S60 v3.2

    33  */

    34 class MVtUiCommandUi

    35     {

    36 

    37 public:

    38 

    39     /**

    40      * Refresh command ui.

    41      */

    42     virtual void RefreshL() = 0;

    43 

    44     /**

    45      * Add new command modifier.

    46      *

    47      * @param aModifier Reference to modifier to be added to this command ui.

    48      * @return KErrNone if modifier could be added, KErrAlreadyExists if same

    49      * modifier is already added or KErrArgument if another modifier with

    50      * same priority is already added.

    51      */

    52     virtual TInt AddCommandModifier( CVtUiCommandModifyBase& aModifier ) = 0;

    53 

    54     /**

    55      * Remove command modifier.

    56      *

    57      * @param aModifier Reference to modifier to be removed from this command

    58      * ui.

    59      */

    60     virtual void RemoveCommandModifier( CVtUiCommandModifyBase& aModifier ) = 0;

    61 

    62     };

    63 

    64 #endif // M_VTUICOMMANDUI_H