menufw/hierarchynavigator/hnmetadatamodel/inc/hnmdevent.h
changeset 0 f72a12da539e
equal deleted inserted replaced
-1:000000000000 0:f72a12da539e
       
     1 /*
       
     2 * Copyright (c) 2007-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:   
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_HNMDEVENT_H
       
    20 #define C_HNMDEVENT_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 /**
       
    25  * Event.
       
    26  *
       
    27  * An object of this class represents an event (identified
       
    28  * by id). 
       
    29  * 
       
    30  * @lib hnmetadatamodel
       
    31  * @since S60 v5.0
       
    32  * @ingroup group_hnmetadatamodel
       
    33  */
       
    34 NONSHARABLE_CLASS(CHnMdEvent) : public CBase
       
    35     {
       
    36 public:
       
    37     
       
    38     /**
       
    39      * Standard factory method.
       
    40      *
       
    41      * since S60 v5.0
       
    42      * @param aId Identifier.
       
    43      * @return Fully constructed object.
       
    44      */
       
    45     static CHnMdEvent* NewL( const TInt aId );
       
    46 
       
    47     /**
       
    48      * Standard factory method.
       
    49      *
       
    50      * since S60 v5.0
       
    51      * @param aId Identifier.
       
    52      * @return Fully constructed object.
       
    53      */
       
    54 
       
    55     static CHnMdEvent* NewLC( const TInt aId );
       
    56 
       
    57     /**
       
    58      * Standard destructor.
       
    59      */
       
    60     virtual ~CHnMdEvent();
       
    61     
       
    62     /**
       
    63      * Returns Id.
       
    64      *
       
    65      * since S60 v5.0
       
    66      * @return iId Identifier of the event.
       
    67      */
       
    68     IMPORT_C TInt Id() const;
       
    69 
       
    70     /**
       
    71      * Sets Id.
       
    72      * 
       
    73      * @param aId Identifier.
       
    74      */
       
    75     void SetId( TInt aId );
       
    76 
       
    77 private:
       
    78 
       
    79     /**
       
    80      * Standard constructor.
       
    81      */
       
    82     CHnMdEvent();
       
    83     
       
    84     /**
       
    85      * EPOC default constructor for performing 2nd stage construction.
       
    86      * 
       
    87      * @param aId Identifier.
       
    88      */
       
    89     void ConstructL( const TInt aId );
       
    90     
       
    91 private: // data
       
    92 
       
    93     /**
       
    94      * Event's identifier.
       
    95      */
       
    96     TInt iId;
       
    97 
       
    98     };
       
    99 
       
   100 #endif // C_HNMMEVENT_H