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 modifier base class definition.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_VTUICOMMANDMODIFYBASE_H

    20 #define C_VTUICOMMANDMODIFYBASE_H

    21 

    22 #include <e32base.h>

    23 

    24 #include "mvtuicommandsetting.h"

    25 

    26 /**

    27  *  CVtUiCommandModifyBase

    28  *

    29  *  Command modifier base class. Command modifiers can be used for modifying

    30  *  different command sets. E.g. in toolbar and number entry a command modifiers

    31  *  are being used for modifying softkeys.

    32  *

    33  *  @since S60 v3.2

    34  */

    35 NONSHARABLE_CLASS( CVtUiCommandModifyBase ) : public CBase

    36     {

    37 

    38 public: // static methods

    39 

    40     /**

    41      * Returns TLinearOrder<> for priority ordering.

    42      */

    43     static TLinearOrder< CVtUiCommandModifyBase > PriorityOrder();

    44 

    45 private: // static methods

    46 

    47     /**

    48      * Priority ordering function.

    49      */

    50     static TInt PriorityOrderFunc( const CVtUiCommandModifyBase& aM1,

    51         const CVtUiCommandModifyBase& aM2 );

    52 

    53 public: // pure virtual methods

    54 

    55     /**

    56      * Modifies command set.

    57      */

    58     virtual void ModifyCommandsL( MVtUiCommandSetting& aCommandSettings ) = 0;

    59 

    60     /**

    61      * Returns ETrue if this modifier supports given command set type.

    62      */

    63     virtual TBool Supports( MVtUiCommandSetting::Type aType ) const = 0;

    64 

    65 protected:

    66 

    67     /**

    68      * Constructor

    69      */

    70     CVtUiCommandModifyBase( TInt aPriority );

    71 

    72 private:

    73 

    74     // Modifier priority

    75     const TInt iPriority;

    76 

    77     };

    78 

    79 #endif // C_VTUICOMMANDMODIFYBASE_H