camera_plat/active_palette_2_api/inc/activepalette2eventdata.h
branchRCL_3
changeset 24 bac7acad7cb3
parent 0 1ddebce53859
equal deleted inserted replaced
23:61bc0f252b2b 24:bac7acad7cb3
       
     1 /*
       
     2 * Copyright (c) 2007-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:  Contains an event's data
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 /**
       
    20  * @file ActivePalette2EventData.h
       
    21  * Contains an event's data
       
    22  */
       
    23 
       
    24 
       
    25 #ifndef _ACTIVE_PALETTE_2_EVENT_DATA_H
       
    26 #define _ACTIVE_PALETTE_2_EVENT_DATA_H
       
    27 
       
    28 #include <e32std.h>
       
    29 
       
    30 /**
       
    31  * Container for the data generated when a user selects an item
       
    32  */
       
    33 class TActivePalette2EventData
       
    34     {
       
    35     public:	
       
    36     
       
    37         /**
       
    38          * Constructor
       
    39          * @param aResult The result
       
    40          * @param aCurItem The current item
       
    41          * @param aPrevItem The previous item
       
    42          * @param aServingItem The serving item
       
    43          * @param aServingPlugin A reference to the serving plugin's UID
       
    44          */
       
    45     	TActivePalette2EventData(TInt aResult, 
       
    46     							TInt aCurItem, 
       
    47     							TInt aPrevItem, 
       
    48     							TInt aServingItem, 
       
    49     							const TUid& aServingPlugin);
       
    50     							
       
    51     	/**
       
    52     	 * Returns the result
       
    53     	 * @return The result
       
    54     	 */
       
    55     	IMPORT_C TInt Result(void) const;
       
    56 
       
    57     	/**
       
    58     	 * Returns the current item
       
    59     	 * @return The current item
       
    60     	 */
       
    61     	IMPORT_C TInt CurItem(void) const;
       
    62 
       
    63     	/**
       
    64     	 * Returns the previous item
       
    65     	 * @return The previous item
       
    66     	 */
       
    67     	IMPORT_C TInt PrevItem(void) const;
       
    68 
       
    69     	/**
       
    70     	 * Returns the serving item
       
    71     	 * @return The serving item
       
    72     	 */
       
    73     	IMPORT_C TInt ServingItem(void) const; 
       
    74 
       
    75     	/**
       
    76     	 * Returns the serving plugin's UID
       
    77     	 * @return The serving plugin's UID
       
    78     	 */
       
    79     	IMPORT_C TUid ServingPlugin(void) const;
       
    80 
       
    81     private:
       
    82         /// The result code
       
    83     	TInt	iResult;
       
    84     	
       
    85     	/// The current item ID
       
    86     	TInt	iCurItem;
       
    87     	
       
    88     	/// The previous item ID
       
    89     	TInt	iPrevItem;
       
    90     	
       
    91     	/// The serving item ID
       
    92     	TInt	iServingItem;
       
    93     	
       
    94     	/// The serving plugin's UID
       
    95     	TUid   	iServingPlugin;
       
    96     };
       
    97 
       
    98 
       
    99 #endif // _ACTIVE_PALETTE_2_EVENT_DATA_H