phoneapp/phoneuiutils/inc/tcbacommandmapping.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2008 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:  Class holds mapping between CBA and custom commands.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef T_TCBACOMMANDMAPPING_H
       
    20 #define T_TCBACOMMANDMAPPING_H
       
    21 
       
    22 
       
    23 #include <e32base.h>
       
    24 
       
    25 /**
       
    26  *  Class holds mapping between CBA and custom commands.
       
    27  *
       
    28  *  @lib phoneuiutils.dll
       
    29  *  @since S60 v5.1
       
    30  */
       
    31 class TCbaCommandMapping
       
    32     {
       
    33 
       
    34 public:
       
    35     /**
       
    36      * C++ default constructor. Use only for NULL-object creation.
       
    37      */    
       
    38     TCbaCommandMapping();
       
    39         
       
    40     /**
       
    41      * C++ overloaded constructor.
       
    42      */
       
    43     TCbaCommandMapping( TInt aCbaCommandId, TInt aCustomCommandId );
       
    44     
       
    45     /**
       
    46      * Returns CBA command identifier.
       
    47      * @return  CBA command identifier.
       
    48      */
       
    49     TInt CbaCommandId() const;
       
    50     
       
    51     /**
       
    52      * Returns custom command identifier.
       
    53      * @return  Custom command identifier.
       
    54      */
       
    55     TInt CustomCommandId() const;
       
    56     
       
    57     /**
       
    58      * Comparison operator for mappings.
       
    59      * @return  ETrue if mapping is same, EFalse otherwise.
       
    60      */
       
    61     TBool operator==( const TCbaCommandMapping& aMapping ) const;
       
    62 
       
    63 private: // data
       
    64 
       
    65     /**
       
    66      * CBA command identifier.
       
    67      */
       
    68     TInt iCbaCommandId;
       
    69     
       
    70     /**
       
    71      * Custom command identifier.
       
    72      */
       
    73     TInt iCustomCommandId;
       
    74 
       
    75     };
       
    76 
       
    77 
       
    78 #endif // T_TCBACOMMANDMAPPING_H