mmappfw_plat/mpx_common_api/inc/mpxmessage.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     1 /*
       
     2 * Copyright (c) 2004 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:  Message class
       
    15 *
       
    16 */
       
    17 
       
    18  
       
    19 
       
    20 #ifndef TMPXMESSAGE_H
       
    21 #define TMPXMESSAGE_H
       
    22 
       
    23 #include<e32base.h>
       
    24 
       
    25 /**
       
    26 * MPX message class.
       
    27 *
       
    28 * @lib mpxcommon.lib
       
    29 */
       
    30 class TMPXMessage
       
    31     {
       
    32 public:
       
    33     /**
       
    34     *  C++ constructor.
       
    35     *
       
    36     *  @since S60 3.2.3
       
    37     *  @param aEvent event
       
    38     *  @param aType event type
       
    39     *  @param aData optional data 
       
    40     */
       
    41     IMPORT_C TMPXMessage(TInt aEvent,TInt aType = 0,TInt aData = 0);
       
    42 
       
    43     /**
       
    44     *  C++ copy constructor.
       
    45     *
       
    46     *  @since S60 3.2.3
       
    47     *  @param aMsg source message
       
    48     */
       
    49     IMPORT_C TMPXMessage(const TMPXMessage& aMsg);
       
    50 
       
    51     /**
       
    52     *  Overloaded assignment operator.
       
    53     *
       
    54     *  @since S60 3.2.3
       
    55     *  @param aMsg source message
       
    56     */
       
    57     IMPORT_C TMPXMessage& operator=(const TMPXMessage& aMsg);
       
    58     
       
    59     /**
       
    60     *  C++ constructor.
       
    61     *
       
    62     *  @since S60 3.2.3
       
    63     */
       
    64     IMPORT_C TMPXMessage();
       
    65 
       
    66     /**
       
    67     *  return message event.
       
    68     *
       
    69     *  @since S60 3.2.3
       
    70     */
       
    71     IMPORT_C TInt Event() const;
       
    72     
       
    73     /**
       
    74     *  return message type.
       
    75     *
       
    76     *  @since S60 3.2.3
       
    77     */
       
    78     IMPORT_C TInt Type() const;
       
    79 
       
    80     /**
       
    81     *  return message data.
       
    82     *
       
    83     *  @since S60 3.2.3
       
    84     */
       
    85     IMPORT_C TInt Data() const;
       
    86 protected: 
       
    87     TInt iEvent;
       
    88     TInt iType;
       
    89     TInt iData;
       
    90     };
       
    91 
       
    92 #endif // TMPXMESSAGE_H